Fix cloud command not listed in k6 command's help text #3901
Conversation
This file contains 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
When implementing the new cloud command structure, we marked the k6 cloud command as deprecated by setting the cobra.Cmd Deprecated option. By doing so, Cobra took over itself to hide the command all in all from the help text's output, and users couldn't see the cloud command as part of the "Available Commands". This commit removes the Cobra.Cmd Deprecated option usage, and ports the message to the Long version of the help text. This commit also rephrases the message to be more accurate. Considering the cloud command itself is not deprecated, but rather its existing behavior, we have mentioned the original behavior consisting in taking a test resource as input is deprecated, specifically.
This commit adds a test asserting the root command help text lists the expected commands as available.
oleiade
requested review from
mstoykov and
olegbespalov
and removed request for
a team
olegbespalov
approved these changes
Aug 19, 2024
joanlopez
approved these changes
Aug 21, 2024
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.
When implementing the new cloud command structure, we marked the
k6 cloud command as deprecated by setting the
cobra.Cmd,Deprecated,option.
By doing so, Cobra took over itself to hide the command all in all from
the help text's output, and users couldn't see the cloud command as
part of the "Available Commands".
This PR removes the Cobra.Cmd Deprecated option usage, and ports
the message to the Long version of the help text.
This PR also rephrases the message to be more accurate. Considering
the cloud command itself is not deprecated, but rather its existing
behavior, we have mentioned the original behavior consisting in taking
a test resource as input is deprecated, specifically.## What?
Why?
We discovered that while shipping the new cloud command structure, we had missed the cloud command disappearing from the k6 help text.
Checklist
make lint) and all checks pass.make tests) and all tests pass.