Skip to content

Style check: fail a pull request on the mechanical style rules - #253

Merged
bdbarnett merged 2 commits into
mainfrom
ci/style-check
Nov 4, 2026
Merged

bdbarnett merged 2 commits into
mainfrom
ci/style-check

Conversation

@bdbarnett

Copy link
Copy Markdown
Contributor

Adds a Style workflow that calls the organization's shared style check on every pull request. It fails on a Python file without the three SPDX lines, a Sphinx role or field in a docstring, a README or docs page that links to the organization's shared-tooling repository, and a README badge row or status banner. On a pull request it reads only the changed files; run it by hand to check everything.

Two Python files failed. modules/displayif/tools/test_usdl2.py had only a licence line, and modules/picotts/py/picotts.py lacked the bare # between its copyright and licence lines (its Adafruit holder line stays). Both are fixed in their own commit; I compared each file's AST (docstrings and comments stripped) against main and both match, so no behaviour changes. lib-overrides/mip/ is MicroPython's own installer, so it's listed in a new .style-exclude file rather than edited.

The workflow calls the shared check at publishing-v20, which doesn't exist yet, so it will fail to start until that tag is cut. Merge this after the tag.

@bdbarnett
bdbarnett merged commit 3e9ceb2 into main Nov 4, 2026
7 checks passed
@bdbarnett
bdbarnett deleted the ci/style-check branch November 4, 2026 02:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

1 participant