Skip to content

ci: run ci.yml on docs-only pull requests - #46

Merged
sentomk merged 1 commit into
mainfrom
ci/docs-pr-unlock
Aug 1, 2026
Merged

ci: run ci.yml on docs-only pull requests#46
sentomk merged 1 commit into
mainfrom
ci/docs-pr-unlock

Conversation

@sentomk

@sentomk sentomk commented Aug 1, 2026

Copy link
Copy Markdown
Owner

Summary

Fix the structural deadlock that blocked docs-only PRs: branch protection requires the build-and-test/coverage checks from ci.yml, but the workflow's pull_request trigger ignored docs paths, so those required checks never reported and PRs like #45 needed an admin override to merge.

Changes

  • Drop paths-ignore from the pull_request trigger in .github/workflows/ci.yml, so required checks always report on every PR.
  • Keep paths-ignore on the push trigger — docs-only pushes to main still skip the full suite.
  • Add an inline comment recording why the PR trigger must stay unfiltered, with a reference to PR docs: sync contributing rules and roadmap with CI and plans #45.

Testing

  • Workflow YAML parses cleanly (PyYAML).
  • The change only affects when the workflow starts; no job logic is modified.
  • Self-verifying: this PR touches .github/, so the full matrix including build-and-test and coverage must report green before merge. A follow-up docs-only PR can serve as the real-world confirmation.

Problem
- Branch protection requires the build-and-test and coverage checks
  from ci.yml, but its pull_request trigger ignored docs-only paths.
- Docs-only PRs therefore never reported the required checks and
  were permanently blocked, e.g. PR #45 needed an admin override.

Implementation
- Drop paths-ignore from the pull_request trigger so the required
  checks always report; keep it on the push trigger to avoid
  burning CI on docs-only pushes to main.
- Add a comment recording why the filter must stay off for PRs.

Tests
- YAML parses cleanly; the trigger change only affects when the
  workflow starts, not any job logic.
- This PR itself touches .github/, so the full matrix runs and the
  required checks must report before merge.
@codecov

codecov Bot commented Aug 1, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@sentomk
sentomk merged commit 1ccf51e into main Aug 1, 2026
22 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant