chore(cli): improve flag help descriptions to show allowed values instead of type names #5067
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
…type names Signed-off-by: h3nryc0ding <hr.richterhenry@gmail.com>
Signed-off-by: h3nryc0ding <hr.richterhenry@gmail.com>
h3nryc0ding
force-pushed
the
fix/flags-allowed-values
branch
from
4acb77b
to
64739b4
Compare
h3nryc0ding
commented
Nov 10, 2024
Signed-off-by: h3nryc0ding <hr.richterhenry@gmail.com>
h3nryc0ding
force-pushed
the
fix/flags-allowed-values
branch
from
a655858
to
4404634
Compare
h3nryc0ding
commented
Nov 13, 2024
| "where kind must be one of: (%s)", | ||
| strings.Join(supportedHelmChartSourceKinds, ", "), | ||
| ) | ||
| return "source that contains the chart in the format '<kind>/<name>.<namespace>'" |
There was a problem hiding this comment.
At present (not with this change), this looks like
--source helmChartSource source that contains the chart in the format '<kind>/<name>.<namespace>', where kind must be one of: (HelmRepository, GitRepository, Bucket)
I think the following may be better
--source <kind>/<name>.<namespace> source that contains the chart, source kind must be one of: (HelmRepository, GitRepository, Bucket)
I'm afraid that something like HelmRepository|GitRepository|Bucket/<name>.<namespace> could become more confusing as it's a mix of all the allowed values and placeholders. It may be better to just provide the template and list the supported kind values in description.
We can even leave this out of this change as the values are not fixed. But I still think the new format is relatively better than an undefined helmChartSource value.
| "where kind must be one of: (%s), if kind is not specified it defaults to GitRepository", | ||
| strings.Join(supportedKustomizationSourceKinds, ", "), | ||
| ) | ||
| return "source that contains the Kubernetes manifests in the format '[<kind>/]<name>.<namespace>', if kind is not specified it defaults to GitRepository" |
There was a problem hiding this comment.
Same reasoning as for chart source. Something like
--source [<kind>/]<name>.<namespace> source that contains the Kubernetes manifests, kind must be one of: (OCIRepository, GitRepository, Bucket), if kind is not specified it defaults to GitRepository
seems like an improvement to me.
| "where kind must be one of: (%s)", | ||
| strings.Join(supportedHelmChartSourceKinds, ", "), | ||
| ) | ||
| return "source that contains the chart in the format '<kind>/<name>'" |
There was a problem hiding this comment.
Same as for chart source mentioned above, just without namespace.
h3nryc0ding
changed the title
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.
Closes #5066