mirror of
https://github.com/arduino/library-registry.git
synced 2025-05-28 19:01:25 +03:00
2dbd3a41bd
GitHub Actions actions are used by the workflows to set up development tools in the runner workspace. In order to facilitate updates to new versions of these tools, we set the version to be set up via environment variables at the top of the workflow. Since this variable definition is separate from the step using the action, it might not be immediately apparent to the maintainer which version syntaxes are supported. For this reason, comments were added with the URL to the relevant section of the consuming action's documentation. Previously, these URLs were made to point to the version of the documentation that matched the version of the action in use by the workflow. Since we only use a major version ref, the expectation was that this would only need to be updated rarely. However, it turned out that the major version bump cycle is significantly shorter than expected. In addition, it is easy to forget the update because action version update PRs are provided by Dependabot, which obviously won't update the URLs in the comments. So it will be best to use a URL that points to the documentation at the tip of the default branch of the action repository. The likelihood of the documentation provided by this URL not matching the behavior of the release version of the action in use is likely less than it is for an outdated URL.
87 lines
2.0 KiB
YAML
87 lines
2.0 KiB
YAML
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/check-python-task.md
|
|
name: Check Python
|
|
|
|
env:
|
|
# See: https://github.com/actions/setup-python/tree/main#available-versions-of-python
|
|
PYTHON_VERSION: "3.9"
|
|
|
|
# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows
|
|
on:
|
|
push:
|
|
paths:
|
|
- ".github/workflows/check-python-task.ya?ml"
|
|
- "**/.flake8"
|
|
- "**/poetry.lock"
|
|
- "**/pyproject.toml"
|
|
- "**/setup.cfg"
|
|
- "Taskfile.ya?ml"
|
|
- "**/tox.ini"
|
|
- "**.py"
|
|
pull_request:
|
|
paths:
|
|
- ".github/workflows/check-python-task.ya?ml"
|
|
- "**/.flake8"
|
|
- "**/poetry.lock"
|
|
- "**/pyproject.toml"
|
|
- "**/setup.cfg"
|
|
- "Taskfile.ya?ml"
|
|
- "**/tox.ini"
|
|
- "**.py"
|
|
workflow_dispatch:
|
|
repository_dispatch:
|
|
|
|
jobs:
|
|
lint:
|
|
runs-on: ubuntu-latest
|
|
|
|
steps:
|
|
- name: Checkout repository
|
|
uses: actions/checkout@v3
|
|
|
|
- name: Install Python
|
|
uses: actions/setup-python@v4
|
|
with:
|
|
python-version: ${{ env.PYTHON_VERSION }}
|
|
|
|
- name: Install Poetry
|
|
run: pip install poetry
|
|
|
|
- name: Install Task
|
|
uses: arduino/setup-task@v1
|
|
with:
|
|
repo-token: ${{ secrets.GITHUB_TOKEN }}
|
|
version: 3.x
|
|
|
|
- name: Run flake8
|
|
uses: liskin/gh-problem-matcher-wrap@v1
|
|
with:
|
|
linters: flake8
|
|
run: task python:lint
|
|
|
|
formatting:
|
|
runs-on: ubuntu-latest
|
|
|
|
steps:
|
|
- name: Checkout repository
|
|
uses: actions/checkout@v3
|
|
|
|
- name: Install Python
|
|
uses: actions/setup-python@v4
|
|
with:
|
|
python-version: ${{ env.PYTHON_VERSION }}
|
|
|
|
- name: Install Poetry
|
|
run: pip install poetry
|
|
|
|
- name: Install Task
|
|
uses: arduino/setup-task@v1
|
|
with:
|
|
repo-token: ${{ secrets.GITHUB_TOKEN }}
|
|
version: 3.x
|
|
|
|
- name: Format Python code
|
|
run: task python:format
|
|
|
|
- name: Check formatting
|
|
run: git diff --color --exit-code
|