casaroli opened a new pull request, #20666:
URL: https://github.com/apache/nuttx/pull/20666

   ## 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.
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to