Skip to content

docs: Add CI to check that man pages are committed - #984

Merged
bal-e merged 1 commit into
NLnetLabs:mainfrom
thgoebel:check-man-page
Sep 3, 2026
Merged

docs: Add CI to check that man pages are committed#984
bal-e merged 1 commit into
NLnetLabs:mainfrom
thgoebel:check-man-page

Conversation

@thgoebel

Copy link
Copy Markdown
Contributor

This PR simplifies the pull request template by automating the "man page modified" check. (The "man page added/removed" case I didn't cover, because I don't want to mess with shell magic right now.)

This PR depends on #979 because it uses "make man", and thus relies on "uv run" being in the Makefile. Hence the Makefile is also in the list of changed paths, to catch Makefile edits that might break this Action.


  • If you are changing Rust code or integration tests (Cargo.*, crates/, etc/, integration-tests/, src/):

    • Did you run the integration tests with act through the act-wrapper (as described in TESTING.md)?
  • If you are adding/deleting man pages:

    • Did you update the man_pages config in doc/manual/source/conf.py?
    • Did you update the packaged man pages in the Cargo.toml?
    • Did you commit the freshly built man pages?
  • If you are modifying man pages:

    • Did you commit the updated built man pages?

@thgoebel

Copy link
Copy Markdown
Contributor Author

You can see an example here: https://github.com/thgoebel/cascade/actions/runs/33070959056/job/98512775383

I also pushed a dummy commit that I will drop before we merge this. Once a maintainer approves the new workflow, we will see if its runs correctly in a pull_request context.

@ximon18 ximon18 added documentation Improvements or additions to documentation cli Relating to the `cascade` CLI tool, which talks to the daemon. labels Aug 27, 2026

@bal-e bal-e left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This looks great! It's nice to trim down the number of simple, repetitive actions involved in contribution.

I have a few comments regarding the CI workflow, let me know what you think.

Also, I guess you'll have to rebase the PR on main now that #979 is merged.

Comment thread .github/workflows/check-man-pages.yml Outdated
Comment thread .github/workflows/check-man-pages.yml
Comment thread .github/workflows/check-man-pages.yml Outdated
@bal-e

bal-e commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

Everything looks good @thgoebel. I looked at the CI check and noticed that some man pages beyond your test commit were outdated; I've updated them on main. Can you remove the test commit? GitHub will then run CI against the updated main, and we should see everything pass. I'll then approve and merge :)

@thgoebel

thgoebel commented Sep 3, 2026

Copy link
Copy Markdown
Contributor Author

Done

@bal-e
bal-e merged commit 0dc5653 into NLnetLabs:main Sep 3, 2026
1 check passed
@bal-e

bal-e commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

Thank you once again @thgoebel :)

@thgoebel
thgoebel deleted the check-man-page branch September 3, 2026 11:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cli Relating to the `cascade` CLI tool, which talks to the daemon. documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants