Skip to content

docs(cli): document the deploy preview and the property-level diff - #510

Open
sorccu wants to merge 4 commits into
mainfrom
simo/red-943-deploy-diff
Open

sorccu wants to merge 4 commits into
mainfrom
simo/red-943-deploy-diff

Conversation

@sorccu

@sorccu sorccu commented Sep 18, 2026

Copy link
Copy Markdown
Member

Summary

Documents the deploy preview and the property-level diff that checkly deploy gains with the linked CLI changes.

  • cli/checkly-deploy.mdx: the plan before every deploy, the plan token, the confirmation prompt as the CLI prints it, the overview table and the rendered diff under each updated resource with the other lines it can carry, the masked inline rendering of secrets, and the flags --dry-run, --plan-token, --prune-relations. The previously undocumented --verbose and --cancel-in-progress-deployment are added, and the --[no-]schedule-on-deploy description no longer states the opposite of what the flag does.
  • Three guides showed deploy output from before the plan existed; their samples now match the command, in the plan format (overview table, coloured diffs, totals) the second CLI PR introduces.

Related

Tickets: RED-943, RED-981

🤖 Generated with Claude Code

…ED-943]

`checkly deploy` now plans every deploy before writing anything and, with
`--preview` or `--output`, prints under each updated resource a diff of the
construct as it is in the account against the construct in the code. The
reference page describes the plan, the plan token, the confirmation prompt
as the CLI prints it, the lines a rendered resource can carry (text diffs,
secrets by name, bundle causes, the CLI-upgrade note, the listing fallback),
and the new flags: `--dry-run`, `--plan-token`, `--prune-relations`. The
previously undocumented `--verbose` and `--cancel-in-progress-deployment`
are added, and the `--[no-]schedule-on-deploy` description no longer says
the opposite of what the flag does.

Three guides showed deploy output from before the plan existed; their
samples now match what the command prints.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@mintlify

mintlify Bot commented Sep 18, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
checkly-422f444a 🟢 Ready View Preview Sep 20, 2026, 5:02 PM

The deploy preview now shows an encrypted property inline with its value
masked, the side that changed reading `'******** (changed)'`, and names
the holding property only when the change cannot be shown inline. The
`--dry-run` envelope carries `$masked` markers in place of sensitive
values, and `secret: true` on a change whose secret moved or whose
sensitive element has no counterpart.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
`checkly deploy --preview` and `--output` now print an overview table of
every touched resource, a coloured construct diff per updated resource,
and a totals line, instead of the Create/Update/Delete listing with a
unified diff under each updated row. Every sample and every sentence that
named the old headings follows the new output.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
…-981]

After a deploy, --output totals what was done ("1 updated") and a blank
line separates the plan from the success message.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant