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

Harbor CLI Doc generation #323

Open
Standing-Man opened this issue Feb 6, 2025 · 2 comments
Open

Harbor CLI Doc generation #323

Standing-Man opened this issue Feb 6, 2025 · 2 comments

Comments

@Standing-Man
Copy link
Contributor

When a new command is added, IMO, only its documentation needs to be updated, and there's no need to reimplement the existing commands. Meanwhile, At the same time, the GitHub Action triggered by the PR also needs to be fixed.

.nh
.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals"

.SH NAME
harbor-artifact-delete - delete an artifact


.SH SYNOPSIS
\fBharbor artifact delete [flags]\fP

The generated man doc header can ignore the date to prevent the need for regenerating a new man doc with every PR just to pass the GitHub Action checks.

@bupd
Copy link
Contributor

bupd commented Feb 6, 2025

the GitHub Action triggered by the PR also needs to be fixed.

The github action currently checks only if there is a new File is added. meaning there is a command that is undocumented.

Meanwhile, we need to update the doc generation script to ensure that it creates documentation only for new/updated commands.

This is an issue with the doc generation script.

@bupd
Copy link
Contributor

bupd commented Feb 6, 2025

Please take a look at this Action to get more info on how PR check works.

https://github.com/goharbor/harbor-cli/actions/runs/12822855242/job/35756436281

Thanks

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

No branches or pull requests

2 participants