docs: Add CI to check that man pages are committed - #984
Conversation
|
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. |
bal-e
left a comment
There was a problem hiding this comment.
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.
e1b61c8 to
dc110f0
Compare
|
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 |
dc110f0 to
9816abd
Compare
|
Done |
|
Thank you once again @thgoebel :) |
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/):actthrough theact-wrapper(as described inTESTING.md)?If you are adding/deleting man pages:
man_pagesconfig indoc/manual/source/conf.py?Cargo.toml?If you are modifying man pages: