Skip to content

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

Open
jenlevy wants to merge 1 commit into
python-wheel-build:fix/skip-e2e-and-unit-tests-for-docs-only-changesfrom
jenlevy:fix/skip-e2e-and-unit-tests-for-docs-only-changes
Open

fix: skip tests and CodeQL for doc-only changes#1280
jenlevy wants to merge 1 commit into
python-wheel-build:fix/skip-e2e-and-unit-tests-for-docs-only-changesfrom
jenlevy:fix/skip-e2e-and-unit-tests-for-docs-only-changes

Conversation

@jenlevy

@jenlevy jenlevy commented Jul 28, 2026

Copy link
Copy Markdown

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

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
@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

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: b458eebb-adda-447e-acce-007e59b2235f

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

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?

branches:
- main
paths-ignore:
- 'docs/**'

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.

Can we have a more broader set here something like below:

paths-ignore:
    - 'docs/**'
    - '*.md'
    - '*.rst'
    - 'LICENSE'

@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

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.

3 participants