Skip to content

fix hidden flag property #893

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

Merged
stephanos merged 3 commits into from
Jan 7, 2026
Merged

fix hidden flag property #893

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7f4f775
fix `hidden` flag property
stephanos Dec 19, 2025
5c9513f
add doc
stephanos Jan 7, 2026
dae9e90
Merge branch 'main' into fix-hidden
stephanos Jan 7, 2026
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
3 changes: 3 additions & 0 deletions internal/commandsgen/code.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -458,5 +458,8 @@ func (o *Option) writeFlagBuilding(selfVar, flagVar string, w *codeWriter) error
if o.Deprecated != "" {
w.writeLinef("_ = %v.MarkDeprecated(%q, %q)", flagVar, o.Name, o.Deprecated)
}
if o.Hidden {
w.writeLinef("_ = %v.MarkHidden(%q)", flagVar, o.Name)
}
return nil
}
1 change: 1 addition & 0 deletions internal/commandsgen/parse.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ type (
Aliases []string `yaml:"aliases,omitempty"`
EnumValues []string `yaml:"enum-values,omitempty"`
Experimental bool `yaml:"experimental,omitempty"`
Hidden bool `yaml:"hidden,omitempty"`
HiddenLegacyValues []string `yaml:"hidden-legacy-values,omitempty"`
}

Expand Down
3 changes: 1 addition & 2 deletions internal/temporalcli/commands.yaml
View file
Open in desktop
Copy link
Member

@cretz cretz Jan 7, 2026

Choose a reason for hiding this comment

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

The large set of comments at the top of this file was supposed to describe all fields this file could take, but I guess it is getting stale. Regardless, I think we should add hidden there. Not blocking though.

Copy link
Contributor Author

@stephanos stephanos Jan 7, 2026

Choose a reason for hiding this comment

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

Good call; fixed!

Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,7 @@
# default: The default value. No default means zero value of the type. (string)
# enum-values: A list of possible values for the string-enum type. (string[])
# aliases: A list of aliases for the option. (string[])
# hidden: Hides the option from help output. (bool)
# option-sets: A list of option sets. (string[])

# * name, summary, and descrption are required fields. All other fields are optional.
Expand Down Expand Up @@ -3374,7 +3375,6 @@ commands:
- name: queue-rps-limit-reason
type: string
description: Reason for queue rate limit update.
hidden: true
Copy link
Contributor Author

@stephanos stephanos Dec 19, 2025

Choose a reason for hiding this comment

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

Checked with the team and this is not actually desirable.

- name: fairness-key-rps-limit-default
type: string
display-type: float|default
Expand All @@ -3384,7 +3384,6 @@ commands:
- name: fairness-key-rps-limit-reason
type: string
description: Reason for fairness key rate limit update.
hidden: true

- name: temporal workflow
summary: Start, list, and operate on Workflows
Expand Down