ci: build the VitePress manual on manual-only diffs (#516) - #528
Merged
Conversation
A pull request touching only `manual/**` skipped every job that could catch a break: `frontend`, `backend` and `image` are path-gated away from it, and the e2e suite excludes `manual/**` via `paths-ignore`. A broken sidebar entry or frontmatter block therefore merged green and only surfaced when the release image was built, whose `manual` stage compiles the same VitePress site. Add a `manual` job to `ci.yml` running `npm ci && npm run docs:build` in `manual/`, gated on a new `manual` output from the `detect-changes` action. The build takes seconds, so it is cheap to gate on and cheap to run. The `image` gate deliberately still does not match `manual/**` — a prose edit is not worth a 30-minute packaging run when the same site builds in ~5s here. Refs #516 Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Nothing in CI ran
npm run docs:buildformanual/. A pull request touching onlymanual/**skippedfrontend,backendandimage(all path-gated away from it) and was excluded from the e2e suite bypaths-ignore, so a broken VitePress build merged green and would only surface when the release image was built — the all-in-one image'smanualstage compiles the same site.This adds a dedicated
manualjob toci.yml, gated on a newmanualoutput from thedetect-changescomposite action. The VitePress build takes seconds, so it is cheap to run and cheap to gate on.Closes #516
Changes
.github/actions/detect-changes/action.yml— newmanualoutput, matched by^manual/, emitted alongsidebackend/frontend/image..github/workflows/ci.yml— newmanualjob: checkout, Node 24 with the npm cache keyed onmanual/package-lock.json,npm ci,npm run docs:build. Gated asinputs.full || needs.changes.outputs.manual == 'true'so the release gate always runs it (per the "Adding a job toci.yml" rule indocs/ci.md).imagegate deliberately still does not matchmanual/**: a prose edit is not worth a 30-minute packaging run when the same site builds in ~5s in the new job. That reasoning is recorded as a comment next toimage_reso it is not "fixed" later.docs/ci.md—manualrow in the what-runs-when table, updatedci.ymlsummary, and a fourth rule explaining why the job exists.Verification
ci.ymland the composite action parse; job list ischanges, secrets, frontend, manual, backend, imageand thechangesjob exports the newmanualoutput.manual/guide/*.mdandmanual/package-lock.jsonsetmanual=truewithbackend/frontend/imageall false;docs/ci.mdsets nothing;frontend/**andProxytrace.*are unchanged from before.npm ci && npm run docs:buildinmanual/—build complete in 7.15s, which is exactly what the job runs..github/, which makesdetect-changesfail open and force every area totrue, so the new job also runs on this PR itself.🤖 Generated with Claude Code
Generated by Claude Code