kbld
kbld copied to clipboard
Change descriptions for --imgpkg-lock-output and --lock-output
For users unfamiliar with kbld/imgpkg, it may be difficult to distinguish between the following flag options:
--imgpkg-lock-output string File path to emit images lockfile with resolved image references
--lock-output string File path to emit configuration with resolved image references
There should be more added to the descriptions about when to use each. Something detailing that --lock-output
does not produce an images.yml
for imgpkg might help users looking for more information through kbld --help
.
i wonder if we should just hide --lock-output option?
I was thinking if we have users that are still using the kbld lock files or not. Maybe hiding them in the help would be enough of a signal to start using imgpkg lock files since kbld can also consume them after
@cppforlife @joaopapereira If we're considering hiding the --lock-output
flag, then could we begin the deprecation process of it?
@danielhelfand would hiding the --lock-output
flag satisfy your use case?
If we're considering hiding the --lock-output flag, then could we begin the deprecation process of it?
i think it's ok to hide it to encourage users to use --imgpkg-lock-output.
Accepting issue since we have come to a conclusion to hide the --lock-output
flag from the help text. Prioritizing it to hopefully be in the next release, ready to be pointed/worked on.