Fix standalone activity stability labels and polish help docs - #1196
Open
fretz12 wants to merge 2 commits into
Open
Fix standalone activity stability labels and polish help docs#1196fretz12 wants to merge 2 commits into
fretz12 wants to merge 2 commits into
Conversation
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
One updated help area still contains misleading --query guidance for standalone Activity targeting, which contradicts actual supported flag combinations.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
This PR updates Temporal CLI command metadata and generated help output to reflect current stability/experimental status of Standalone Activity operations, and improves Activity/Batch help wording to better document bulk operations via --query.
Changes:
- Removed “(Experimental)” from stable Standalone Activity commands (e.g., cancel, list, start, terminate).
- Marked
activity pause,unpause,reset, andupdate-optionsas experimental and added explicit experimental notes in their help text. - Polished Batch help text and several flag descriptions (e.g.,
--yes,--rps) to better describe batch behavior and Standalone Activity batch use cases.
File summaries
| File | Description |
|---|---|
| internal/temporalcli/commands.yaml | Adjusts command summaries/descriptions and Batch documentation to reflect stability and standalone activity batch operations. |
| internal/temporalcli/commands.gen.go | Regenerates CLI help strings to match updated command metadata and improved flag/help text wording. |
Review details
- Files reviewed: 2/2 changed files
- Comments generated: 1
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
183
to
+187
| f.StringVarP(&v.WorkflowId, "workflow-id", "w", "", "Workflow ID. Set to target a workflow Activity. Omit to target a standalone Activity. For a Workflow Activity you must set either --workflow-id or --query.") | ||
| f.StringVarP(&v.Query, "query", "q", "", "Content for an SQL-like `QUERY` List Filter. You must set either --workflow-id or --query. Note: Using --query for batch activity operations is an experimental feature and may change in the future.") | ||
| f.StringVarP(&v.RunId, "run-id", "r", "", "Run ID. Only use with --workflow-id or --activity-id. Cannot use with --query.") | ||
| f.StringVar(&v.Reason, "reason", "", "Reason for batch operation. Only use with --query. Defaults to user name.") | ||
| f.BoolVarP(&v.Yes, "yes", "y", false, "Don't prompt to confirm signaling. Only allowed when --query is present.") | ||
| f.Float32Var(&v.Rps, "rps", 0, "Limit batch's requests per second. Only allowed if query is present.") | ||
| f.BoolVarP(&v.Yes, "yes", "y", false, "Don't prompt to confirm the batch operation. Only allowed when --query is present.") |
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 changed?