fix: skip tests and CodeQL for doc-only changes - #1280
Conversation
Add paths-ignore for docs/** to test.yaml and codeql.yaml so that doc-only PRs no longer trigger the full CI matrix (unit tests, e2e tests, CodeQL analysis). check.yaml is left unchanged since it runs the Sphinx docs build that validates proposal files. Co-Authored-By: Claude <claude@anthropic.com> Closes: python-wheel-build#1230
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
Tick the box to add this pull request to the merge queue (same as
|
| branches: | ||
| - main | ||
| paths-ignore: | ||
| - 'docs/**' |
There was a problem hiding this comment.
Can we have a more broader set here something like below:
paths-ignore:
- 'docs/**'
- '*.md'
- '*.rst'
- 'LICENSE'
|
One thing I need to verify but need admin access to do so: I need to look at Required checks interaction. From claude When paths-ignore causes a workflow to be skipped entirely, GitHub reports the jobs as "skipped" rather than "success." If branch protection rules require those jobs (e.g., unit, e2e, coverage) to pass before merging, doc-only PRs will be unmergeable because the required checks never run. @LalatenduMohanty can you help with this please? |
yes, we need to fix this. |
|
No required status checks are configured on main. empty lists mean no jobs are gating merges, so paths-ignore skipping workflows won't block doc-only PRs. |
|
perfect, thank you @LalatenduMohanty |
Add paths-ignore for docs/** to test.yaml and codeql.yaml so that doc-only PRs no longer trigger the full CI matrix (unit tests, e2e tests, CodeQL analysis). check.yaml is left unchanged since it runs the Sphinx docs build that validates proposal files.
Closes: #1230
Pull Request Description
What
Why