Remove default value for flag and expand description #126
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
Make sure we have a decent description for the --operator-image flag as that is used down the line by the syncer to run the display command and gather the results from the version syncer. Also remove the default value for the flag. It makes no sense to have a default value if we mark a flag as required, as that value will always be overwritten by the flag. Signed-off-by: Itxaka <[email protected]>
Codecov Report
@@ Coverage Diff @@
## main #126 +/- ##
=======================================
Coverage 29.16% 29.16%
=======================================
Files 5 5
Lines 360 360
=======================================
Hits 105 105
Misses 251 251
Partials 4 4 Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
fgiudici
approved these changes
Aug 10, 2022
| @@ -62,7 +62,7 @@ func NewOperatorCommand() *cobra.Command { | |||
| cmd.PersistentFlags().StringArrayVar(&config.SyncNamespaces, "sync-namespaces", []string{}, "namespace to watch for machine registrations") | |||
| _ = viper.BindPFlag("sync-namespaces", cmd.PersistentFlags().Lookup("sync-namespaces")) | |||
|
|
|||
| cmd.PersistentFlags().StringVar(&config.OperatorImage, "operator-image", "rancher/elemental-operator:"+version.Version, "this image") | |||
| cmd.PersistentFlags().StringVar(&config.OperatorImage, "operator-image", "", "Operator image. Used to gather the results from the syncer by running the 'display' command") | |||
There was a problem hiding this comment.
🤔 this looks to me more suited for an in-code comment (for devs) than something outputted by the help of the binary 😆
There was a problem hiding this comment.
yeah, unfortunately if we want to allow overriding this, we need a decent help for the flag :/
The idea would be to drop this somehow but I have no idea how we can not use the display command anymore to capture the logs 😢
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.
Make sure we have a decent description for the --operator-image flag as
that is used down the line by the syncer to run the display command and
gather the results from the version syncer.
Also remove the default value for the flag. It makes no sense to have a
default value if we mark a flag as required, as that value will always
be overwritten by the flag.
Fixes #119
Signed-off-by: Itxaka [email protected]