fix(ci): scope paths-ignore to PRs and add no-op bypass jobs - #1473
fix(ci): scope paths-ignore to PRs and add no-op bypass jobs#1473Aryanbhargava18 wants to merge 5 commits into
Conversation
Fixes krkn-chaos#1447 This adds `paths-ignore` rules to the primary workflows (Functional & Unit Tests, Tests v2, and Docker Image CI) so they are skipped when a push or pull request only modifies Markdown (`**/*.md`) files. This will reduce CI queue times and resource usage, while ensuring that the lightweight documentation and linting workflows can still run independently. Signed-off-by: Aryanbhargava18 <aryanbhargava644@gmail.com>
Fixes issues raised in review: 1. Scopes `paths-ignore` strictly to `pull_request` triggers so release tags and `main` branch pushes always run (fixing tag-only build skips). 2. Adds `docs-bypass.yml` with companion no-op jobs to satisfy required status checks on docs-only PRs, preventing them from being indefinitely blocked. Signed-off-by: Aryanbhargava18 <aryanbhargava644@gmail.com>
|
👀 Human Input Needed → Pair Review Briefing |
d8f331e to
53e9521
Compare
This implements a clean bypass mechanism for docs-only PRs: 1. Skips heavy workflows (tests.yml, tests_v2.yml, docker-image.yml) when only markdown files are changed by adding paths-ignore: '**/*.md' to the pull_request trigger. 2. Introduces lightweight bypass workflows that exactly mimic the names and matrices of the original required CI jobs so branch protection rules are satisfied without consuming runner minutes. Signed-off-by: Aryanbhargava18 <aryanbhargava644@gmail.com>
53e9521 to
2ef31f3
Compare
|
I'm not sure if we need the "bypass" jobs here, agree with the AI bot comment. Think the 'paths-ignore' should be sufficient |
|
Hey @paigerube14, I actually thought the same thing initially! But since this repo has required status checks (like The AI bot was just pointing out that my dummy workflows didn't perfectly match the exact job names required by the branch protection. I updated them to match exactly so docs PRs can cleanly bypass the 30m tests but still satisfy GitHub's merge requirements. Let me know what you think! |
|
@paigerube14 just circling back to see if you had any thoughts on the above. I also went ahead and resolved the bot comment so the UI merge block is lifted. (FOSSA is failing, but since I only touched GH Actions, that looks like a pre-existing dependency issue on main). Let me know if anything else is there. |
|
Hi @Aryanbhargava18, this PR has been waiting for updates for 26 days. Please respond or push changes within 7 days, otherwise this PR will be closed. Feel free to reopen when you're ready to continue. |
Description
Fixes #1474
This PR fixes an issue where docs-only PRs trigger heavy end-to-end testing workflows, or alternatively, get blocked because required checks never run.
It implements a clean bypass mechanism:
tests.yml,tests_v2.yml,docker-image.yml) when only markdown files are changed by addingpaths-ignore: '**/*.md'to thepull_requesttrigger.Type of change
Checklist: