docs: document deploy --preserve-resources and destructive-delete guard#426
Merged
Merged
Conversation
Document the new `checkly deploy --preserve-resources` flag (detach removed resources instead of deleting them, preserving run history) and the pre-delete confirmation guard, mirroring the AI-426 backend and CLI changes. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
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
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.
What & why
AI-426. Documents the new
checkly deploybehavior shipping in the CLI:--preserve-resources— when a resource is removed from code,checkly deploynow supports detaching it (keeping the resource and its run history in the account, UI-managed) instead of deleting it. Mirrors the existingcheckly destroy --preserve-resources.deploythat would delete resources now runs a dry-run first, lists what would be permanently deleted (losing run history), and prompts for confirmation. Skipped by--force/--preserve-resources; returns aconfirmation_requiredJSON envelope (exit 2) in agent/CI mode.Detached (kept in account, now managed in the Checkly Webapp):section, plus an older-backend fallback note.Changes
cli/checkly-deploy.mdx: new--preserve-resourcesrow +ResponseField, and a new "Deleting vs. detaching removed resources" section. No "Available since" version note (feature unreleased).Example output and prompt strings were verified against the CLI source (
deploy.ts,authCommand.ts,command-preview.ts).Related
preserveResources)--preserve-resourcesflag + destructive-delete preflight guard🤖 Generated with Claude Code