Generate CLI docs. #192
Merged
Generate CLI docs. #192
Conversation
This file contains hidden or 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
2f49f3c to
842da45
Compare
Merged
|
From experience, you may want a CI check that fails if these docs haven't been updated.
|
eddiezane
previously approved these changes
Nov 17, 2022
| @@ -35,8 +33,6 @@ func main() { | |||
| } | |||
|
|
|||
| rootCmd := root.New(cfg) | |||
| rootCmd.AddCommand(version.New(cfg)) | |||
There was a problem hiding this comment.
Any reason for this other than to keep main clean?
There was a problem hiding this comment.
Yeah - the doc generator needs the subcommands to be added to pick them up. This moves the AddCommand's to the rootCmd creation to guarantee both main's have the same command tree.
Signed-off-by: Billy Lynch <billy@chainguard.dev>
Signed-off-by: Billy Lynch <billy@chainguard.dev>
eddiezane
approved these changes
Nov 21, 2022
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.
Summary
Generate CLI docs for all cobra commands.
Release Note
NONE
Documentation
📖 📖 📖