Skip to content
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.

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

Automatic documentation of the cobra CLI #649

Open
fmartingr opened this issue Jul 19, 2023 · 0 comments
Open

Automatic documentation of the cobra CLI #649

fmartingr opened this issue Jul 19, 2023 · 0 comments
Assignees

Comments

@fmartingr
Copy link
Member

To avoid manually editing the documentation each time we modify the CLI, we can use the same approach hostctl uses to generate the CLI documentation.

Completion criteria

  • Addition of a gen-cli-docs command in the Makefile that updates the docs/CLI.md with proper documentation of the CLI.
    • This command should accept a destination path (that defaults to docs/CLI.md) to use in the CI.
  • A CI workflow that will run the command and compare it to the submitted docs/CLI.md to check if it is up to date, failing otherwise.
@fmartingr fmartingr added this to the 1.6.0 milestone Jul 21, 2023
@fmartingr fmartingr self-assigned this Jul 21, 2023
@fmartingr fmartingr removed this from the 1.6.0 milestone Sep 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: To do
Development

No branches or pull requests

1 participant