ci: enforce README and crate docs stay in sync#93
Conversation
There was a problem hiding this comment.
Pull request overview
Adds a CI job that runs cargo rdme --check so the generated README.md cannot drift from the crate-level documentation in src/lib.rs (delimited by the existing <!-- cargo-rdme start/end --> markers verified in the repo).
Changes:
- New
rdmejob in the Rust workflow that checks out the repo (withpersist-credentials: false), installscargo-rdmevia the pinnedmozilla/actions/rustaction, and runscargo rdme --check.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Clean addition. The rdme job follows existing CI patterns (pinned actions, persist-credentials: false, consistent mozilla/actions/rust version at v1.1.5). Running on all trigger events is the right call — README drift should be caught everywhere, not just on PRs.
|
neqo uses |
|
Will look into it. Thanks @larseggert. Any idea why the other workflows aren't running here? Note that this is an external contributor ( |
|
Two things: GitHub is currently flaky (again...) and also the semver check was busted. Can you rebase this PR and see if all checks trigger? (I don't have the rights it seems.) |
Add a rdme job that runs `cargo rdme --check` so the README, which is generated from the crate-level docs in src/lib.rs (delimited by the existing <!-- cargo-rdme start/end --> markers), fails CI when it drifts from the source. Without this, public API changes that touch the usage example in the doc comment land with a stale README that won't compile if a user copies it.
Brings all mozilla/actions references in line with the rest of the workflow (rustfmt, clippy, machete, mutants-pr, actionlint are already at v1.1.5). The v1.1.4 semver workflow was busted; upgrading should unblock PR checks. https://claude.ai/code/session_015XGyTTzgTPGxYVCfkfguVK
mxinden-bot
force-pushed
the
claude/ci-rdme-check
branch
from
fa95acd to
9aad48f
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #93 +/- ##
=======================================
Coverage 97.06% 97.06%
=======================================
Files 2 2
Lines 784 784
Branches 784 784
=======================================
Hits 761 761
Misses 21 21
Partials 2 2
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
mxinden-bot
force-pushed
the
claude/ci-rdme-check
branch
from
9aad48f to
357a5ff
Compare
Add a rdme job that runs
cargo rdme --checkso the README, which is generated from the crate-level docs in src/lib.rs (delimited by the existing markers), fails CI when it drifts from the source. Without this, public API changes that touch the usage example in the doc comment land with a stale README that won't compile if a user copies it.