Skip to content

.github/workflows/check.yml: Check pull requests that change only documentation. - #20666

Merged
acassis merged 1 commit into
apache:masterfrom
casaroli:check-docs-prs
Oct 14, 2026
Merged

acassis merged 1 commit into
apache:masterfrom
casaroli:check-docs-prs

Conversation

@casaroli

Copy link
Copy Markdown
Contributor

Summary

.github/workflows/check.yml has paths-ignore: Documentation/**, so a pull request that changes only documentation never runs tools/checkpatch.sh: no commit message check and no codespell.

A spelling error merged this way breaks later pull requests.
checkpatch.sh -g checks every file that a commit in the range touches, and the range of the check job can include commits of master.
For example #20649 (documentation only) touched Documentation/os/scheduling/cancellation_points.rst, which has two codespell errors, and the check job of #20634 and #20648 now fails on that file.

This change removes the paths-ignore, so the Check workflow runs for every pull request.

Notes:

  • Images are not affected: git diff shows them as "Binary files ... differ", so checkpatch.sh does not give them to check_file (no cvt2utf, no codespell).
  • The Python files in Documentation/ (conf.py, redirects.py, _extensions/*.py) pass black, flake8 and isort.
  • codespell Documentation reports 48 errors in 16 files today (most in Documentation/ReleaseNotes/). A pull request that touches one of these files must fix the errors first.

Impact

CI only. Documentation-only pull requests run the check job (about 1 minute).

Testing

./tools/checkpatch.sh -c -u -g 0ae359f913e~1..0ae359f913e (a commit that adds a .jpg in Documentation/) passes.
./tools/checkpatch.sh -c -u -f Documentation/conf.py Documentation/redirects.py Documentation/_extensions/*.py passes.
tools/checkpatch.sh -c -u -m -g passes on this commit.

…umentation.

The Check workflow ignored pull requests that change only files in
Documentation/, so their commits and files were never checked: no
commit message check and no codespell.  A spelling error merged this
way then fails the check of a later pull request whose commit range
includes the documentation commit, because checkpatch.sh checks every
file that a commit in the range touches.

Run the Check workflow for every pull request.

Assisted-by: Claude Code:claude-opus-5-5
Signed-off-by: Marco Casaroli <marco.casaroli@gmail.com>
@github-actions github-actions Bot added Area: CI Size: XS The size of the change in this PR is very small labels Oct 14, 2026
@github-actions

Copy link
Copy Markdown

MemBrowse Memory Report

No memory changes detected for:

@acassis
acassis merged commit b3418f0 into apache:master Oct 14, 2026
32 of 53 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Area: CI Size: XS The size of the change in this PR is very small

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants