Skip to content

[skip changelog] Sync "Check Python" CI workflow with template #1393

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 12, 2021
Merged

[skip changelog] Sync "Check Python" CI workflow with template #1393

merged 3 commits into from
Aug 12, 2021

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented Aug 12, 2021

Please check if the PR fulfills these requirements

  • The PR has no duplicates (please search among the Pull Requests
    before creating one)
  • The PR follows
    our contributing guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • UPGRADING.md has been updated with a migration guide (for breaking changes)
  • What kind of change does this PR introduce?

Infrastructure update

  • What is the current behavior?

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.

  • What is the new behavior?

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?

Does this PR introduce a breaking change

The python:check task has been renamed to python: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.

is titled accordingly

Yes

  • Other information:

In case you're interested in the subject of migrating .flake8 configuration file to pyproject.toml, the link in the previous "TODO" comment:

# TODO: move this to pyproject.toml when supported: https://gitlab.com/pycqa/flake8/merge_requests/245

no longer works, but is available here:
https://github.com/PyCQA/flake8/issues/234
I won't hold my breath waiting for it.

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`
@per1234 per1234 added type: enhancement Proposed improvement topic: infrastructure Related to project infrastructure labels Aug 12, 2021
@per1234 per1234 changed the title Check python [skip changelog] Sync "Check Python" CI workflow with template Aug 12, 2021
@per1234 per1234 merged commit 7989a4e into arduino:master Aug 12, 2021
@per1234 per1234 deleted the check-python branch August 12, 2021 21:28
@@ -219,18 +235,6 @@ tasks:
- task: python:check
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@per1234 apparently this was left behind, If it's ok for you, I can open a new PR and fix this

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

umbynos added a commit that referenced this pull request Oct 19, 2021
@per1234 per1234 self-assigned this Nov 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: infrastructure Related to project infrastructure type: enhancement Proposed improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants