Skip to content

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

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.

25 Python files failed because they had a licence line but no copyright line, or no header at all. Each now starts with the copyright, a bare # and the licence line, in their own commit, and nothing else changes. I compared each file's AST (docstrings and comments stripped) against main and all 25 match, so no behaviour changes.

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 49e98a3 into main Nov 4, 2026
@bdbarnett
bdbarnett deleted the ci/style-check branch November 4, 2026 02:35
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