Skip to content

fix: skip tests and CodeQL for doc-only changes - #1280

Merged
mergify[bot] merged 1 commit into
python-wheel-build:mainfrom
jenlevy:fix/skip-e2e-and-unit-tests-for-docs-only-changes
Aug 4, 2026
Merged

fix: skip tests and CodeQL for doc-only changes#1280
mergify[bot] merged 1 commit into
python-wheel-build:mainfrom
jenlevy:fix/skip-e2e-and-unit-tests-for-docs-only-changes

Conversation

@jenlevy

@jenlevy jenlevy commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

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

@jenlevy
jenlevy requested a review from a team as a code owner July 28, 2026 18:08
@coderabbitai

coderabbitai Bot commented Jul 28, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 3cacd3d6-b364-479c-85d1-4fc928c23592

📥 Commits

Reviewing files that changed from the base of the PR and between 5a04afc and 57c8f8b.

📒 Files selected for processing (2)
  • .github/workflows/codeql.yaml
  • .github/workflows/test.yaml
🚧 Files skipped from review as they are similar to previous changes (2)
  • .github/workflows/test.yaml
  • .github/workflows/codeql.yaml

📝 Walkthrough

Walkthrough

The CodeQL workflow ignores documentation, Markdown, reStructuredText, and LICENSE changes for push and pull_request events targeting main. The test workflow ignores the same file categories for pull requests.

Estimated code review effort: 1 (Trivial) | ~5 minutes

🚥 Pre-merge checks | ✅ 3 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Out of Scope Changes check ⚠️ Warning The workflows also ignore Markdown, reStructuredText, and LICENSE-only changes, which issue #1230 does not request. Limit paths-ignore to docs/**, or update issue #1230 to explicitly approve Markdown, reStructuredText, and LICENSE-only exclusions.
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly states that tests and CodeQL are skipped for documentation-only changes.
Description check ✅ Passed The description explains the workflow changes, the reason for them, and why check.yaml remains unchanged.
Linked Issues check ✅ Passed The changes add documentation path ignores to test.yaml and codeql.yaml and leave check.yaml unchanged as required by issue #1230.

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@mergify mergify Bot added the ci label Jul 28, 2026
@mergify

mergify Bot commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

Tick the box to add this pull request to the merge queue (same as @mergifyio queue).

  • Queue this pull request

@rd4398 rd4398 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added a comment to make scope of paths-ignore broader. Also @jenlevy this PR should be targeted towards main right?

Comment thread .github/workflows/codeql.yaml
@rd4398

rd4398 commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

One thing I need to verify but need admin access to do so: I need to look at Required checks interaction. From claude

gh api repos/python-wheel-build/fromager/branches/main/protection/required_status_checks

This returns the list of required check names. If any of unit, e2e, Coverage report, or Analyze appear there, doc-only PRs will be blocked.

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?

@LalatenduMohanty

LalatenduMohanty commented Jul 29, 2026

Copy link
Copy Markdown
Member

Also @jenlevy this PR should be targeted towards main right?

yes, we need to fix this.

@LalatenduMohanty

Copy link
Copy Markdown
Member

No required status checks are configured on main.

$ gh api repos/python-wheel-build/fromager/branches/main/protection/required_status_checks --jq '{strict: .strict, checks: .checks, contexts: .contexts}'
{
  "checks": [],
  "contexts": [],
  "strict": true
}

empty lists mean no jobs are gating merges, so paths-ignore skipping workflows won't block doc-only PRs.

@rd4398

rd4398 commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

perfect, thank you @LalatenduMohanty

@jenlevy
jenlevy changed the base branch from fix/skip-e2e-and-unit-tests-for-docs-only-changes to main August 3, 2026 15:18
@jenlevy
jenlevy force-pushed the fix/skip-e2e-and-unit-tests-for-docs-only-changes branch from 7ac0941 to 5a04afc Compare August 3, 2026 15:20
@jenlevy jenlevy linked an issue Aug 3, 2026 that may be closed by this pull request

@rd4398 rd4398 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good! Thank you!

@rd4398

rd4398 commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

@mergify rebase

@mergify

mergify Bot commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

rebase

🛑 The pull request rule doesn't match anymore

Details

This action has been cancelled.

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
@rd4398
rd4398 force-pushed the fix/skip-e2e-and-unit-tests-for-docs-only-changes branch from 5a04afc to 57c8f8b Compare August 4, 2026 12:47
@mergify
mergify Bot merged commit 8511bb3 into python-wheel-build:main Aug 4, 2026
39 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Skip e2e and unit tests for docs-only changes

3 participants