Repository navigation
Style check: fail a pull request on the mechanical style rules - #383
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a
Styleworkflow 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.Twenty-three files failed. Three are ours and are fixed in their own commit:
scripts/check_attribution.pyhad no header, andtests/test_ci_scope.pyandtools/ci_scope.pylacked the bare#between copyright and licence. I compared each file's AST (docstrings and comments stripped) againstmainand all three match, so no behaviour changes. The other 20 are third-party code undertests/vendor/(Adafruit's synthio helpers, with their:param:fields and their own headers) andtests/support/ulab/, so they're listed in a new.style-excludefile instead of 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.