ci: skip pipeline for documentation-only changes#35
Merged
Conversation
Restrict the validate workflow so it does not build for docs work: - on.push uses branches-ignore: "docs/**" — pushes to docs branches never trigger the workflow. - the job `if` skips PRs opened from a docs/* branch (github.head_ref) and pushes whose tip commit is docs:/docs(scope):. The previous check only matched bare docs:/chore: and missed the scoped conventional-commit form (e.g. docs(readme):), so docs PRs still built.
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.
What
Stops the validate pipeline from building for documentation-only work — it is not worth a full devcontainer build + Neovim/treesitter suite for docs.
Changes to
.github/workflows/validate.ymlon.pushnow usesbranches-ignore: ["docs/**"]— pushes todocs/*branches no longer trigger the workflow at all.Job
ifnow skips:docs/*branch (github.head_ref), anddocs:/docs(scope):.The previous condition only matched bare
docs:/chore:and always ran on any pull request, so scoped docs commits (e.g.docs(readme):) and docs PRs still built.chore:/chore(scope):remain skipped as before.Expression semantics
On
pull_requesteventshead_commitis null, so only thehead_refcheck applies; onpusheventshead_refis empty, so only the message checks apply. Pushes todocs/**are filtered before the job byon.push.Validated: YAML parses (
python -c yaml.safe_load) andyamllint -d relaxedis clean.