Repository navigation
ci: skip the build matrix for documentation-only changes - #209
Merged
Merged
Conversation
A one-line edit to the website or a README currently waits on thirteen jobs: Zig built and tested on three operating systems, the Node addon on three, and the Python binding on four. That is several minutes to approve a typo, which is how people stop fixing typos. paths-ignore skips a run only when every changed file matches, so a PR touching src/ and README.md together still runs in full. Nothing in this workflow reads a markdown file or anything under docs/ -- the only mentions are comments pointing at CORRECTNESS.md -- so no build input is being ignored. The comment says so, and says the list has to shrink if that stops being true. Also noted in the comment: this is safe because main has no required status checks. Under branch protection a skipped required check leaves a PR waiting forever rather than passing, and the fix is a separate always-succeeding job of the same name. The Pages deploy is GitHub's own workflow, not this one, so documentation still publishes exactly as before. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This was referenced Oct 1, 2026
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
1 participant
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.
A one-line edit to the website currently waits on thirteen jobs: Zig built and tested on three operating systems, the Node addon on three, the Python binding on four. Several minutes to approve a typo is how people stop fixing typos.
Applied to both
pushandpull_requestvia a YAML anchor so the two lists cannot drift apart.Why this is safe
Mixed PRs still run in full.
paths-ignoreskips a run only when every changed file matches. A PR touchingsrc/engine.zigandREADME.mdtogether runs everything.Nothing in this workflow reads the ignored paths. I checked: the only mentions of
.mdinci.ymlare three comments pointing atCORRECTNESS.md. No step reads a markdown file or anything underdocs/. The comment in the workflow says this, and says the list has to shrink if it stops being true.No required status checks on
main. This is the part worth knowing, because it is the usual way this change goes wrong: under branch protection, a skipped required check does not pass, it stays pending, and the PR waits forever.mainhas no protection today (gh api .../branches/main/protectionreturns 404), so skipping is genuinely skipping. If protection is ever turned on, the fix is a separate always-succeeding job with the same name, and that is written in the workflow comment so whoever enables it finds out there rather than from a stuck PR.Docs still deploy. The Pages build is GitHub's own workflow, not this one.
Effect
This PR itself will run the full matrix, since it changes a workflow file rather than docs. #208 and every future docs change will not.
🤖 Generated with Claude Code