Skip to content

Clarify skip-drainage deletion requirements - #1168

Closed
Shivs11 wants to merge 1 commit into
mainfrom
shivam/clarify-skip-drainage-docs
Closed

Clarify skip-drainage deletion requirements#1168
Shivs11 wants to merge 1 commit into
mainfrom
shivam/clarify-skip-drainage-docs

Conversation

@Shivs11

@Shivs11 Shivs11 commented Aug 19, 2026

Copy link
Copy Markdown
Member

Summary

  • clarify that --skip-drainage bypasses only the drainage-status check when deleting a Worker Deployment Version
  • state explicitly that the active-poller requirement is always enforced
  • document the risk to open pinned Workflow Executions when deleting a draining Version
  • regenerate the tracked CLI command definitions

Why

The existing command and flag descriptions use an ambiguous double negative: “Ignore the deletion requirement of not draining.” This can be read as allowing deletion while active pollers remain, even though the server always enforces the active-poller check independently of drainage status.

This change makes the two safeguards and the scope of --skip-drainage explicit in both CLI help and the generated command-reference documentation.

User impact

Users will be less likely to mistake --skip-drainage for a force-delete option. The generated documentation page will inherit the corrected wording through the CLI documentation sync.

Validation

  • go test ./cmd/gen-docs ./internal/commandsgen
  • go test ./internal/temporalcli -run '^TestHelp_' -count=1
  • generated and inspected dist/docs/worker.mdx
  • inspected temporal worker deployment delete-version --help
  • git diff --check

@Shivs11
Shivs11 marked this pull request as ready for review August 19, 2026 15:54
@Shivs11
Shivs11 requested a review from a team as a code owner August 19, 2026 15:54
@Shivs11 Shivs11 closed this Aug 19, 2026
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