chore(cli): improve flag help descriptions to show allowed values instead of type names #5067
Conversation
…type names Signed-off-by: h3nryc0ding <[email protected]>
Signed-off-by: h3nryc0ding <[email protected]>
h3nryc0ding
force-pushed
the
fix/flags-allowed-values
branch
from
4acb77b
to
64739b4
Compare
Signed-off-by: h3nryc0ding <[email protected]>
h3nryc0ding
force-pushed
the
fix/flags-allowed-values
branch
from
a655858
to
4404634
Compare
| "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
Closes #5066