Repository navigation
Conversation
`checkly deploy` plans a deploy only under `--plan`, which is off by default and becomes the default in the next major version of the CLI. The pages described the planned deploy as what every deploy does. They now say what a deploy does by default, present `--plan` as a preview feature, mark `--plan-token` and `--prune-relations` as requiring it, and drop `--skip-plan`. Examples that show a plan run with `--plan`; examples of a default run show what a default run prints. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
The note on deploys without a plan said the code bundle is uploaded before the confirmation when the deploy may delete resources. It is uploaded after the confirmation in every case now. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
…-1016] Describes what `checkly deploy --plan` prints when the code is already deployed: one sentence in place of the overview, no confirmation in any environment, and a deploy that records the deployment and schedules the checks without writing a resource. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
…016] The write-back now reports what it wrote as a diff per resource, in the layout of the plan, and groups what it could not write by resource. The page shows an example and uses the new wording of the two notes it quotes. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
…[RED-1016] The plan's construct diff keeps a property the code spells out on both sides whatever its value, so a move to or from a default reads as a change of that line, and refers to other constructs by the names the code gives them. Both depend on the CLI finding the construct's call in the code. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
The plan opens each updated resource's diff with two lines saying what its sides are: what is live in Checkly, replaced or removed by the deploy, and what is in the code, added or changed by it; after the deploy, "was live" and "now live". Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
sorccu
force-pushed
the
simo/red-997-write-back-resource-types-docs
branch
from
October 5, 2026 06:03
f942ce0 to
8cf4365
Compare
sorccu
force-pushed
the
simo/red-1016-deploy-plan-opt-in
branch
from
October 5, 2026 06:03
95cc0b2 to
239b650
Compare
This was referenced Oct 5, 2026
Member
Author
|
Rolled up into #554 with the rest of the deploy-plan documentation stack, rebased onto main. Closing this one in favour of it. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The deploy plan is an opt-in behind
checkly deploy --plan(RED-1016), and the docs say so.The pages in this stack described the planned deploy as what every
checkly deploydoes. The CLI now plans only under--plan, which is off by default and becomes the default in the next major version of the CLI.cli/checkly-deploy.mdx: a new--[no-]planoption;--skip-planremoved;--plan-tokenand--prune-relationsmarked as requiring--plan; "How a deploy previews its changes" opens with what a deploy does by default and presents--planas a preview feature; every example that shows a plan runs with--plan, and the examples of a default run show what a default run prints.guides/claude-code-monitoring.mdx: the preview example shows the output of a default run, and points to--planfor the diff.Related
A plan with nothing to apply
Adds what
checkly deploy --plandoes when the code is already deployed: it printsNo changes.in place of the overview, asks for no confirmation in any environment, and completes after recording the deployment and scheduling the checks.What the deploy prints after updating the code
Adds an example of the new report (a diff per resource in the plan's layout, then what could not be written, grouped by resource) and updates the two notes the page quotes.
Also
🤖 Generated with Claude Code