[skip changelog] Sync "Check Python" CI workflow with template #1393
Conversation
We have assembled a collection of reusable project assets: https://github.com/arduino/tooling-project-assets These assets will be used in the repositories of all Arduino tooling projects. Some minor improvements and standardizations have been made in the upstream "template" assets, and those are introduced to this repository here. Notable: - Check for black formatting style compliance - Update tool dependencies - Standardize linting task name and deprecate old task name - Add cyclomatic complexity check - Add pep8-naming plugin to flake8
…lack update After updating the black formatter tool, the new version wanted a small change in the Python formatting.
The sync with the template documentation assets has resulted in new standardized names for some of the tasks. The `python:check` task has been renamed to `python:lint`
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.
Please check if the PR fulfills these requirements
before creating one)
our contributing guidelines
UPGRADING.md
has been updated with a migration guide (for breaking changes)Infrastructure update
We have assembled a collection of reusable GitHub Actions workflows:
https://github.com/arduino/tooling-project-assets
These workflows will be used in the repositories of all Arduino tooling projects.
Some minor improvements and standardizations have been made in the upstream "template" workflow, but have not yet been pulled into this repository.
Workflow is synced with the state of the art from upstream.
Notable:
Check for black formatting style compliance
Update tool dependencies
Add cyclomatic complexity check
Add pep8-naming plugin to flake8
Does this PR introduce a breaking change, and is
titled accordingly?
The
python:check
task has been renamed topython:lint
. This will be disruptive to any develope accustomed to using the old task name. It could be avoided by deprecating the old task rather than removing it. However, there is no change to the application API.Yes
In case you're interested in the subject of migrating
.flake8
configuration file topyproject.toml
, the link in the previous "TODO" comment:no longer works, but is available here:
https://github.com/PyCQA/flake8/issues/234
I won't hold my breath waiting for it.