Skip to content

docs: document deploy --preserve-resources and destructive-delete guard#426

Merged
martzoukos merged 1 commit into
mainfrom
martzoukos/ai-426-deploy-preserve-resources-docs
Jul 8, 2026
Merged

docs: document deploy --preserve-resources and destructive-delete guard#426
martzoukos merged 1 commit into
mainfrom
martzoukos/ai-426-deploy-preserve-resources-docs

Conversation

@martzoukos

Copy link
Copy Markdown
Contributor

What & why

AI-426. Documents the new checkly deploy behavior shipping in the CLI:

  • --preserve-resources — when a resource is removed from code, checkly deploy now supports detaching it (keeping the resource and its run history in the account, UI-managed) instead of deleting it. Mirrors the existing checkly destroy --preserve-resources.
  • Destructive-delete confirmation guard — a non-forced deploy that 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 a confirmation_required JSON envelope (exit 2) in agent/CI mode.
  • Notes that detached resources appear under a Detached (kept in account, now managed in the Checkly Webapp): section, plus an older-backend fallback note.

Changes

  • cli/checkly-deploy.mdx: new --preserve-resources row + 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

  • Backend: checkly/monorepo#2854 (detach instead of delete on deploy preserveResources)
  • CLI: the --preserve-resources flag + destructive-delete preflight guard

🤖 Generated with Claude Code

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>
@mintlify

mintlify Bot commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated (UTC)
checkly-422f444a 🟢 Ready View Preview Jul 8, 2026, 9:20 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@martzoukos martzoukos merged commit fced04b into main Jul 8, 2026
6 checks passed
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