Skip to content

man: rewrite to use cli-docs-tool manpage generator - #5966

Merged
thaJeztah merged 1 commit into
docker:masterfrom
thaJeztah:man_rewrite
Mar 27, 2025
Merged

man: rewrite to use cli-docs-tool manpage generator#5966
thaJeztah merged 1 commit into
docker:masterfrom
thaJeztah:man_rewrite

Conversation

@thaJeztah

Copy link
Copy Markdown
Member

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)

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-commenter

codecov-commenter commented Mar 25, 2025

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 59.09%. Comparing base (b8034c0) to head (80bca8e).

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:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@thaJeztah
thaJeztah marked this pull request as ready for review March 25, 2025 16:19
@thaJeztah

Copy link
Copy Markdown
MemberAuthor

@crazy-max PTAL 🤗

@thaJeztahthaJeztah added this to the 28.0.5 milestone Mar 26, 2025

@crazy-maxcrazy-max left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@thaJeztah

Copy link
Copy Markdown
MemberAuthor

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

@thaJeztah
thaJeztah merged commit 30c20d5 into docker:masterMar 27, 2025
@thaJeztahthaJeztah modified the milestones: 28.0.5, 28.1.0Apr 10, 2025
@thaJeztahthaJeztah self-assigned this May 16, 2025
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@thaJeztah@codecov-commenter@crazy-max@vvoland