Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify Versioning CLI Commands #606

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Clarify Versioning CLI Commands #606

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion temporalcli/commands.gen.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1344,7 +1344,7 @@ func NewTemporalTaskQueueDescribeCommand(cctx *CommandContext, parent *TemporalT
s.Command.Flags().StringVarP(&s.TaskQueue, "task-queue", "t", "", "Task queue name. Required.")
_ = cobra.MarkFlagRequired(s.Command.Flags(), "task-queue")
s.Command.Flags().StringArrayVar(&s.TaskQueueType, "task-queue-type", nil, "Task queue types considered. If not specified, all types are reported. The current valid queue types are workflow, activity, or nexus.")
s.Command.Flags().StringArrayVar(&s.SelectBuildId, "select-build-id", nil, "Task queue filter based on Build ID.")
s.Command.Flags().StringArrayVar(&s.SelectBuildId, "select-build-id", nil, "Task queue filter based on Build ID. If not specified, the default Build ID will be used.")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This file is auto-generated, you have to update the commands.md source and regen. See CONTRIBUTING.md.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's the default Build ID? Is that something the user specifies in an assignment rule or another command? If so, maybe add a breadcrumb. (sometimes it's good to use code names rather describe things indirectly in english)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The default Build ID is described in the command description. There is also a catch-all comment about default values on --select-* so there is no need to add one for each. See commandsmd/commands.md

s.Command.Flags().BoolVar(&s.SelectUnversioned, "select-unversioned", false, "Include the unversioned queue.")
s.Command.Flags().BoolVar(&s.SelectAllActive, "select-all-active", false, "Include all active versions. A version is active if it had new tasks or polls recently.")
s.Command.Flags().BoolVar(&s.ReportReachability, "report-reachability", false, "Display task reachability information.")
Expand Down
2 changes: 1 addition & 1 deletion temporalcli/commands.taskqueue_versioning_rules.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ func (c *TemporalTaskQueueVersioningAddRedirectRuleCommand) run(cctx *CommandCon
func (c *TemporalTaskQueueVersioningCommitBuildIdCommand) run(cctx *CommandContext, args []string) error {
token, err := c.Parent.getConflictToken(cctx, &getConflictTokenOptions{
safeMode: !c.Yes,
safeModeMessage: "commiting a redirect rule",
safeModeMessage: "committing a Build ID",
taskQueue: c.Parent.TaskQueue,
showAssignment: true,
})
Expand Down
Loading