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

feat(cli): generate CLI reference documentation. #1056

Merged
merged 2 commits into from
Jan 29, 2025
Merged

Conversation

jvanz
Copy link
Member

@jvanz jvanz commented Jan 27, 2025

Description

Adds the "docs" subcommand to allow the CLI reference documentation generation in markdown format.

Related to #810

@jvanz jvanz self-assigned this Jan 27, 2025
@jvanz jvanz requested a review from a team as a code owner January 27, 2025 20:34
Copy link

codecov bot commented Jan 27, 2025

Codecov Report

Attention: Patch coverage is 0% with 8 lines in your changes missing coverage. Please review.

Project coverage is 63.11%. Comparing base (74be947) to head (e1cb432).
Report is 4 commits behind head on main.

Files with missing lines Patch % Lines
src/main.rs 0.00% 8 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1056      +/-   ##
==========================================
- Coverage   63.58%   63.11%   -0.48%     
==========================================
  Files          17       17              
  Lines        1071     1079       +8     
==========================================
  Hits          681      681              
- Misses        390      398       +8     
Flag Coverage Δ
integration-tests 55.84% <0.00%> (-0.42%) ⬇️
unit-tests 37.29% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@flavio flavio left a comment

Choose a reason for hiding this comment

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

This looks good and I would even try to merge it before we tag 1.21.0 since it's a really small change.

I just left one minor code change request

src/main.rs Outdated Show resolved Hide resolved
Copy link
Member

@viccuad viccuad left a comment

Choose a reason for hiding this comment

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

LGTM modulo Flavio's suggestion.

I would even try to merge it before we tag 1.21.0 since it's a really small change.

I agree.

Adds the "docs" subcommand to allow the CLI reference documentation
generation in markdown format.

Signed-off-by: José Guilherme Vanz <jguilhermevanz@suse.com>
@jvanz jvanz requested a review from flavio January 28, 2025 13:06
@jvanz jvanz modified the milestones: 1.21, 1.22 Jan 28, 2025
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
@jvanz
Copy link
Member Author

jvanz commented Jan 29, 2025

As we are almost releasing the v1.21. I'm moving this to blocked to be merged after the v1.21 release

@jvanz jvanz linked an issue Jan 29, 2025 that may be closed by this pull request
@jvanz jvanz modified the milestones: 1.22, 1.21 Jan 29, 2025
@jvanz jvanz merged commit 5594c7d into kubewarden:main Jan 29, 2025
10 of 12 checks passed
@jvanz
Copy link
Member Author

jvanz commented Jan 29, 2025

@kubewarden/kubewarden-developers decided to merge this in v1.21.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Feature: automatically create docs for policy-server commands and flags
4 participants