Skip to content

Add infrastructure for checking Poetry configuration files #296

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 2 commits into from
Jun 14, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
109 changes: 109 additions & 0 deletions .github/workflows/check-poetry-task.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
name: Check Poetry

on:
create:
push:
paths:
- ".github/workflows/check-poetry-task.ya?ml"
- "**/poetry.lock"
- "**/pyproject.toml"
- "Taskfile.ya?ml"
pull_request:
paths:
- ".github/workflows/check-poetry-task.ya?ml"
- "**/poetry.lock"
- "**/pyproject.toml"
- "Taskfile.ya?ml"
schedule:
# Run periodically to catch breakage caused by external changes.
- cron: "0 11 * * THU"
workflow_dispatch:
repository_dispatch:

jobs:
run-determination:
runs-on: ubuntu-latest
permissions: {}
outputs:
result: ${{ steps.determination.outputs.result }}
steps:
- name: Determine if the rest of the workflow should run
id: determination
run: |
RELEASE_BRANCH_REGEX="^refs/heads/v[0-9]+$"
# The `create` event trigger doesn't support `branches` filters, so it's necessary to use Bash instead.
if [[
"${{ github.event_name }}" != "create" ||
"${{ github.ref }}" =~ $RELEASE_BRANCH_REGEX
]]; then
# Run the other jobs.
RESULT="true"
else
# There is no need to run the other jobs.
RESULT="false"
fi
echo "result=$RESULT" >> $GITHUB_OUTPUT
validate:
needs: run-determination
if: needs.run-determination.outputs.result == 'true'
runs-on: ubuntu-latest
permissions:
contents: read

steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Install Python
uses: actions/setup-python@v5
with:
python-version-file: pyproject.toml

- name: Install Task
uses: arduino/setup-task@v2
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
version: 3.x

- name: Validate pyproject.toml
run: |
task \
--silent \
poetry:validate
check-sync:
needs: run-determination
if: needs.run-determination.outputs.result == 'true'
runs-on: ubuntu-latest
permissions:
contents: read

steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Install Python
uses: actions/setup-python@v5
with:
python-version-file: pyproject.toml

- name: Install Task
uses: arduino/setup-task@v2
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
version: 3.x

- name: Sync lockfile
run: |
task \
--silent \
poetry:sync
- name: Check if lockfile was out of sync
run: |
git diff \
--color \
--exit-code \
poetry.lock
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -6,6 +6,7 @@
[![Check License status](https://github.com/arduino/compile-sketches/actions/workflows/check-license.yml/badge.svg)](https://github.com/arduino/compile-sketches/actions/workflows/check-license.yml)
[![Check Markdown status](https://github.com/arduino/compile-sketches/actions/workflows/check-markdown-task.yml/badge.svg)](https://github.com/arduino/compile-sketches/actions/workflows/check-markdown-task.yml)
[![Check npm status](https://github.com/arduino/compile-sketches/actions/workflows/check-npm-task.yml/badge.svg)](https://github.com/arduino/compile-sketches/actions/workflows/check-npm-task.yml)
[![Check Poetry status](https://github.com/arduino/compile-sketches/actions/workflows/check-poetry-task.yml/badge.svg)](https://github.com/arduino/compile-sketches/actions/workflows/check-poetry-task.yml)
[![Check Prettier Formatting status](https://github.com/arduino/compile-sketches/actions/workflows/check-prettier-formatting-task.yml/badge.svg)](https://github.com/arduino/compile-sketches/actions/workflows/check-prettier-formatting-task.yml)
[![Check Python status](https://github.com/arduino/compile-sketches/actions/workflows/check-python-task.yml/badge.svg)](https://github.com/arduino/compile-sketches/actions/workflows/check-python-task.yml)
[![Check Taskfiles status](https://github.com/arduino/compile-sketches/actions/workflows/check-taskfiles.yml/badge.svg)](https://github.com/arduino/compile-sketches/actions/workflows/check-taskfiles.yml)
19 changes: 19 additions & 0 deletions Taskfile.yml
Original file line number Diff line number Diff line change
@@ -33,7 +33,7 @@
MAX_DEPTH: 5
- task: python:format

# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-action-metadata-task/Taskfile.yml

Check warning on line 36 in Taskfile.yml

GitHub Actions / Generate problem matcher output

36:121 [line-length] line too long (137 > 120 characters)
action:validate:
desc: Validate GitHub Actions metadata against JSON schema
vars:
@@ -55,7 +55,7 @@
-s "{{.ACTION_METADATA_SCHEMA_PATH}}" \
-d "action.yml"
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-workflows-task/Taskfile.yml

Check warning on line 58 in Taskfile.yml

GitHub Actions / Generate problem matcher output

58:121 [line-length] line too long (131 > 120 characters)
ci:validate:
desc: Validate GitHub Actions workflows against their JSON schema
vars:
@@ -88,7 +88,7 @@
# This is an "umbrella" task used to call any documentation generation processes the project has.
# It can be left empty if there are none.

# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-files-task/Taskfile.yml

Check warning on line 91 in Taskfile.yml

GitHub Actions / Generate problem matcher output

91:121 [line-length] line too long (127 > 120 characters)
general:check-filenames:
desc: Check for non-portable filenames
cmds:
@@ -121,7 +121,7 @@
echo
echo "Prohibited characters found in filenames"
echo "See:"
echo "https://learn.microsoft.com/en-us/windows/win32/fileio/naming-a-file#naming-conventions:~:text=except%20for%20the%20following"

Check warning on line 124 in Taskfile.yml

GitHub Actions / Generate problem matcher output

124:121 [line-length] line too long (142 > 120 characters)
false
}
- |
@@ -154,11 +154,11 @@
echo
echo "Reserved filenames found"
echo "See:"
echo "https://learn.microsoft.com/en-us/windows/win32/fileio/naming-a-file#naming-conventions:~:text=use%20the%20following-,reserved%20names,-for%20the%20name"

Check warning on line 157 in Taskfile.yml

GitHub Actions / Generate problem matcher output

157:121 [line-length] line too long (169 > 120 characters)
false
}
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-general-formatting-task/Taskfile.yml

Check warning on line 161 in Taskfile.yml

GitHub Actions / Generate problem matcher output

161:121 [line-length] line too long (140 > 120 characters)
general:check-formatting:
desc: Check basic formatting style of all files
cmds:
@@ -170,7 +170,7 @@
fi
- ec

# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/spell-check-task/Taskfile.yml

Check warning on line 173 in Taskfile.yml

GitHub Actions / Generate problem matcher output

173:121 [line-length] line too long (127 > 120 characters)
general:check-spelling:
desc: Check for commonly misspelled words
deps:
@@ -180,7 +180,7 @@
cmds:
- poetry run codespell

# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-files-task/Taskfile.yml

Check warning on line 183 in Taskfile.yml

GitHub Actions / Generate problem matcher output

183:121 [line-length] line too long (127 > 120 characters)
general:check-symlinks:
desc: Check for bad symlinks
cmds:
@@ -207,7 +207,7 @@
false
}
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/spell-check-task/Taskfile.yml

Check warning on line 210 in Taskfile.yml

GitHub Actions / Generate problem matcher output

210:121 [line-length] line too long (127 > 120 characters)
general:correct-spelling:
desc: Correct commonly misspelled words where possible
deps:
@@ -423,6 +423,25 @@
--no-root \
{{if .POETRY_GROUPS}} --only {{.POETRY_GROUPS}} {{end}}
poetry:sync:
desc: Sync poetry.lock
deps:
- task: poetry:install
cmds:
- |
poetry lock \
--no-cache \
--no-update
poetry:validate:
desc: Validate pyproject.toml
deps:
- task: poetry:install
cmds:
- |
poetry check \
--lock
python:coverage-report:
desc: Show code coverage report
deps:
3,366 changes: 1,683 additions & 1,683 deletions poetry.lock

Large diffs are not rendered by default.


Unchanged files with check annotations Beta

# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-markdown/.markdownlint.yml

Check warning on line 1 in .markdownlint.yml

GitHub Actions / Generate problem matcher output

1:121 [line-length] line too long (128 > 120 characters)
# See: https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md
# The code style defined in this file is the official standardized style to be used in all Arduino projects and should
# not be modified.