man: rewrite to use cli-docs-tool manpage generator #5966
Merged
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
It's a wrapper around Cobra's generator, but handles some special cases. While rewriting, also rewrite the generator code to align with the mddocs/yamldocs counterpart in docs/generate/ Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #5966 +/- ##
=======================================
Coverage 59.09% 59.09%
=======================================
Files 354 354
Lines 29733 29733
=======================================
Hits 17572 17572
Misses 11191 11191
Partials 970 970 🚀 New features to boost your workflow:
|
Member
Author
|
@crazy-max PTAL 🤗 |
crazy-max
approved these changes
Mar 27, 2025
Member
crazy-max
left a comment
crazy-max
left a comment
There was a problem hiding this comment.
LGTM and CI looks happy as well https://github.com/docker/cli/actions/runs/14064612748/job/39383807388?pr=5966#step:3:1960
Member
Author
|
Thx!! I was working on rewriting this to use go generate as well, but things got a bit messy due to the "vendor.mod"; was still looking for options there that wouldn't codify that into the go generate comment, but definitely wanted to keep that separate |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
It's a wrapper around Cobra's generator, but handles some special cases. While rewriting, also rewrite the generator code to align with the mddocs/yamldocs counterpart in docs/generate/
- Human readable description for the release notes
- A picture of a cute animal (not mandatory but encouraged)