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

Jump to bottom

Update tanzu config set/unset help message #544

Merged
merged 1 commit into from
Oct 20, 2023
Merged

Update tanzu config set/unset help message #544

merged 1 commit into from
Oct 20, 2023

Conversation

chandrareddyp
Copy link
Contributor

@chandrareddyp chandrareddyp commented Oct 14, 2023 •
edited

What this PR does / why we need it

As part of this pull request, the tanzu config set and tanzu config unset commands' --help messages have been updated to be consistent with the help messages of all other Tanzu Core commands.

Which issue(s) this PR fixes

Fixes #

Describe testing done for PR

  • E2E tests are added
    Before Fix
❯ tanzu config set --help
Set config values at the given path. path values: [unstable-versions, cli.edition, features.global.<feature>, features.<plugin>.<feature>, env.<variable>]

Usage:
tanzu config set <path> <value> [flags]

Flags:
  -h, --help   help for set
❯ tanzu config unset --help
Unset config values at the given path. path values: [features.global.<feature>, features.<plugin>.<feature>, env.global.<variable>, env.<plugin>.<variable>]

Usage:
tanzu config unset <path> [flags]

Flags:
  -h, --help   help for unset
❯

After the fix

❯ t config set --help  
Set config values at the given PATH. Supported PATH values: [features.global.<feature>, features.<plugin>.<feature>, env.<variable>]

Usage:
tanzu config set PATH <value> [flags]

Flags:
  -h, --help   help for set
❯ t config unset --help
Unset config values at the given PATH. Supported PATH values: [features.global.<feature>, features.<plugin>.<feature>, env.<variable>]

Usage:
tanzu config unset PATH [flags]

Flags:
  -h, --help   help for unset
❯

Release note

`tanzu config set` and `tanzu config unset` commands `--help` messages are updated.

Additional information

Special notes for your reviewer

@chandrareddyp chandrareddyp requested a review from a team as a code owner October 14, 2023 02:48
@chandrareddyp chandrareddyp force-pushed the topic/chandra/consistent_help_message branch from 6c80a6b to 6796c89 Compare October 14, 2023 02:50
marckhouzam
marckhouzam reviewed Oct 14, 2023
View reviewed changes
pkg/command/plugin.go Outdated Show resolved Hide resolved
@marckhouzam
Copy link
Contributor

You may want to consider changing the usage string for config set and config unset to use the uppercase format

@chandrareddyp chandrareddyp force-pushed the topic/chandra/consistent_help_message branch 2 times, most recently from 9bf9462 to 00882a4 Compare October 19, 2023 16:26
marckhouzam
marckhouzam reviewed Oct 19, 2023
View reviewed changes
pkg/command/config.go Outdated
Short: "Set config values at the given path",
Long: "Set config values at the given path. path values: [unstable-versions, cli.edition, features.global.<feature>, features.<plugin>.<feature>, env.<variable>]",
Long: "Set config values at the given path. Supported PATH values: [features.global.<feature>, features.<plugin>.<feature>, env.<variable>]",
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you do the same two changes for the unsetConfigCmd please

@chandrareddyp chandrareddyp changed the title Consistent help message [In-Progress]Consistent help message Oct 19, 2023
@chandrareddyp chandrareddyp force-pushed the topic/chandra/consistent_help_message branch 2 times, most recently from b448807 to d6fbfde Compare October 20, 2023 14:26
@chandrareddyp chandrareddyp force-pushed the topic/chandra/consistent_help_message branch from d6fbfde to fd2ac4b Compare October 20, 2023 14:28
@chandrareddyp chandrareddyp changed the title [In-Progress]Consistent help message Update config help message Oct 20, 2023
@chandrareddyp chandrareddyp changed the title Update config help message Update tanzu config set/unset help message Oct 20, 2023
marckhouzam
marckhouzam approved these changes Oct 20, 2023
View reviewed changes
Copy link
Contributor

@marckhouzam marckhouzam left a comment

Choose a reason for hiding this comment

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

LGTM
Thanks

@chandrareddyp chandrareddyp merged commit c212257 into main Oct 20, 2023
8 checks passed
@marckhouzam marckhouzam added this to the 1.1.0 milestone Oct 20, 2023
mpanchajanya pushed a commit that referenced this pull request Oct 24, 2023
@chandrareddyp @mpanchajanya
update 'tanzu config' command help message (#544)
0ca5490 
(cherry picked from commit c212257)
mpanchajanya pushed a commit that referenced this pull request Oct 24, 2023
@chandrareddyp @mpanchajanya
update 'tanzu config' command help message (#544)
1bd07e9 
(cherry picked from commit c212257)
mpanchajanya pushed a commit that referenced this pull request Oct 24, 2023
@chandrareddyp @mpanchajanya
update 'tanzu config' command help message (#544)
2ef6c7f 
(cherry picked from commit c212257)
@chandrareddyp chandrareddyp added the docs-impact issues with documentation impact label Oct 31, 2023
@chandrareddyp chandrareddyp deleted the topic/chandra/consistent_help_message branch November 14, 2023 17:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@marckhouzam marckhouzam marckhouzam approved these changes

Assignees
No one assigned
Labels
cla-not-required docs-impact issues with documentation impact
Projects
None yet
Milestone
v1.1.0
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@chandrareddyp @marckhouzam @vmwclabot