-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add infrastructure for checking Poetry configuration files
Tasks and a GitHub Actions workflow are added to maintain and check for problems in the Poetry Python dependency management's configuration files. The tasks provide the following operations: - Check for invalid data structure of pyproject.toml - Check for out of sync poetry.lock file These tasks are ran by the GitHub Actions workflow on any push or pull request that modifies relevant files, and periodically to check for breakage caused by external changes.
- Loading branch information
Showing
2 changed files
with
134 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,116 @@ | ||
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/[0-9]+.[0-9]+.x" | ||
# 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@v4 | ||
with: | ||
python-version-file: pyproject.toml | ||
|
||
- name: Install Poetry | ||
run: | | ||
pipx install \ | ||
--python "$(which python)" \ | ||
poetry | ||
- name: Install Task | ||
uses: arduino/setup-task@v1 | ||
with: | ||
repo-token: ${{ secrets.GITHUB_TOKEN }} | ||
version: 3.x | ||
|
||
- name: Validate pyproject.toml | ||
run: task 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@v4 | ||
with: | ||
python-version-file: pyproject.toml | ||
|
||
- name: Install Poetry | ||
run: | | ||
pipx install \ | ||
--python "$(which python)" \ | ||
poetry | ||
- name: Install Task | ||
uses: arduino/setup-task@v1 | ||
with: | ||
repo-token: ${{ secrets.GITHUB_TOKEN }} | ||
version: 3.x | ||
|
||
- name: Sync lockfile | ||
run: task poetry:sync | ||
|
||
- name: Check if lockfile was out of sync | ||
run: | | ||
git \ | ||
diff \ | ||
--color \ | ||
--exit-code \ | ||
package-lock.json |
This file contains 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