Clarify skip-drainage deletion requirements - #1168
Closed
Shivs11 wants to merge 1 commit into
Closed
Conversation
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.
Summary
--skip-drainagebypasses only the drainage-status check when deleting a Worker Deployment VersionWhy
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-drainageexplicit in both CLI help and the generated command-reference documentation.User impact
Users will be less likely to mistake
--skip-drainagefor 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/commandsgengo test ./internal/temporalcli -run '^TestHelp_' -count=1dist/docs/worker.mdxtemporal worker deployment delete-version --helpgit diff --check