Skip to content

fix(doc): update missing man pages and doc entry#893

Merged
bupd merged 1 commit into
goharbor:mainfrom
vg006:fix/lint
May 8, 2026
Merged

fix(doc): update missing man pages and doc entry#893
bupd merged 1 commit into
goharbor:mainfrom
vg006:fix/lint

Conversation

@vg006

@vg006 vg006 commented May 7, 2026

Copy link
Copy Markdown
Contributor

Description

This PR contain changes to the documentations of harbor repo update command, which fixes the failure of the lint job in the CI pipeline.

Type of Change

Please select the relevant type.

  • Bug fix
  • New feature
  • Refactor
  • Documentation update
  • Chore / maintenance

Overview

The issue originated from this PR #714, where the author added and updated the docs before when the csv is added as an additional global output format in this commit.

Hence, the documentations of the harbor repo update command are missing, so the Generate Document step updates them, which is then conflicting with the next Check for changes step, causing the failure.

Steps to reproduce

  1. Sync the local main branch with the upstream.
  2. Rebase the branch that you are working on the main. (Optional, can be done on main itself, but just mentioning what exactly I did)
  3. From the project root, If dagger installed,
    • Run dagger call run-doc --source=. export --path=doc
  4. Else
    • Run cd ./doc
    • Run go run doc.go
    • Run go run man-docs/man_doc.go
  5. Now run, git diff --name-staus HEAD..main, then you will see the following as the output.
❯ git diff --name-status HEAD..main
M       doc/cli-docs/harbor-repo-update.md
M       doc/man-docs/man1/harbor-repo-update.1

Changes

  • harbor-repo-update.md CLI docs

    - -o, --output-format string   Output format. One of: json|yaml
    + -o, --output-format string   Output format. One of: json|yaml|csv
  • harbor-repo-update.1 man1 docs

    - Output format. One of: json|yaml
    + Output format. One of: json|yaml|csv

cc: @bupd

Signed-off-by: vg006 <devvg006@gmail.com>
@codecov

codecov Bot commented May 7, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 8.80%. Comparing base (60ad0bd) to head (763f99e).
⚠️ Report is 156 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##             main    #893      +/-   ##
=========================================
- Coverage   10.99%   8.80%   -2.19%     
=========================================
  Files         173     280     +107     
  Lines        8671   13965    +5294     
=========================================
+ Hits          953    1230     +277     
- Misses       7612   12618    +5006     
- Partials      106     117      +11     

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@vg006 vg006 mentioned this pull request May 8, 2026
5 tasks

@bupd bupd 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.

/lgtm

@bupd bupd merged commit 2a5ae18 into goharbor:main May 8, 2026
7 of 8 checks passed
rakshityadav1868 pushed a commit to rakshityadav1868/harbor-cli that referenced this pull request May 11, 2026
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

Successfully merging this pull request may close these issues.

CI: lint job in the workflow failing

2 participants