-
Notifications
You must be signed in to change notification settings - Fork 29
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.
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
[FEATURE] Generalize flag names for shp build
commands
#214
Comments
@SaschaSchwarze0 @HeavyWombat @qu1queee @adambkaplan per the community meeting, pls provide some input on this(ideas). |
I had an idea recently, that we might try out in the context of a time boxed spike or similar: Use Go AST in a separate tool in the CLI package to generate the command-line flags procedural based on the Shipwright Build "CRD" structs for Build and BuildRun. The flag name would reflect the "path" inside the struct. This could allow us -- in case this works -- to make sure we are always in sync with what we have configurable in the spec with what users can configure in the CLI. |
From Refinement, proposing to bring this issue back to a community meeting by end of February. |
From Refinement, we will go with CLI with alpha for v0.13.0, this allow us more time to finish this item. Therefore moving out of v0.13.0 CLI needs to have this item ready once we stop serving the v1alpha1 a-inversion |
Is there an existing feature request for this?
Is your feature request related to a problem or use-case? Please describe.
The
shp build
sub-commands have flags that are closely tied to the underlyingv1alpha1
API. These should be generalized or reconsidered so they are supported by thev1beta1
API, or potential future API versions.Describe the solution that you would like.
Flag names should be "feature-oriented" so they are independent of the underlying API. For example, flags that explicitly reference
apiVersion
should be deprecated and removed.Recommended changes (based on feedback below):
Describe alternatives you have considered.
Keep the existing flags - this will not prove tenable long term.
Anything else?
Use comments on this issue to suggest flag deprecations or renames. These will be added to the "solution" section once adopted.
Proposed during shipwright-io/community#183 discussion.
The text was updated successfully, but these errors were encountered: