Skip to content

fix: Support auto-generated CLI reference doc in the notation repo #1336

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
majiayu000 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: Support auto-generated CLI reference doc in the notation repo #1336

majiayu000 wants to merge 1 commit into from

Conversation

@majiayu000
Copy link

@majiayu000 majiayu000 commented Dec 30, 2025

Summary

This PR fixes #859

Changes

  • Added GitHub workflow to automatically generate CLI reference documentation when changes are made to cmd/notation
  • Created cmd/notation/doc.go with gendoc build tag for documentation generation using cobra/doc
  • Refactored cmd/notation/main.go to use !gendoc build tag and export NewRootCommand() function for reuse
  • Created cmd/notation/root.go containing the NewRootCommand() function that initializes the root cobra command
  • Added Makefile target cli-docs for manual CLI documentation generation
  • Updated .gitignore to exclude generated docs/cli/ directory
  • Updated dependencies to include github.com/spf13/cobra/doc for markdown generation

The workflow automatically creates a pull request when CLI commands change, similar to the minder project workflow referenced in the issue.

Testing

  • All unit tests pass
  • Build succeeds
  • Manual CLI docs generation works with make cli-docs
  • Generated markdown files are properly formatted

Generated with Claude Code

@majiayu000
fix: support auto-generated CLI reference documentation
8648d73 
- Add GitHub workflow to auto-generate CLI docs when cmd/notation changes
- Create doc.go with build tag for documentation generation
- Refactor main.go to export NewRootCommand function
- Add Makefile target 'cli-docs' for manual doc generation
- Add docs/cli/ to .gitignore

Implements auto-generation of CLI reference documentation similar to the
minder project workflow. Documentation is generated using cobra/doc and
creates markdown files for all CLI commands.

Fixes notaryproject#859

Signed-off-by: majiayu000 <1835304752@qq.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@gokarnm gokarnm Awaiting requested review from gokarnm gokarnm is a code owner

@NiazFK NiazFK Awaiting requested review from NiazFK NiazFK is a code owner

@priteshbandi priteshbandi Awaiting requested review from priteshbandi priteshbandi is a code owner

@rgnote rgnote Awaiting requested review from rgnote rgnote is a code owner

@shizhMSFT shizhMSFT Awaiting requested review from shizhMSFT shizhMSFT is a code owner

@toddysm toddysm Awaiting requested review from toddysm toddysm is a code owner

@vaninrao10 vaninrao10 Awaiting requested review from vaninrao10 vaninrao10 is a code owner

@yizha1 yizha1 Awaiting requested review from yizha1 yizha1 is a code owner

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Support auto-generated CLI reference doc in the notation repo

1 participant

@majiayu000