Skip to content

Manage versioning of Poetry tool dependency #294

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
Show file tree
Hide file tree
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
12 changes: 0 additions & 12 deletions .github/workflows/check-python-task.yml
Original file line number Diff line number Diff line change
Expand Up @@ -71,12 +71,6 @@ jobs:
with:
python-version-file: pyproject.toml

- name: Install Poetry
run: |
pipx install \
--python "$(which python)" \
poetry

- name: Install Task
uses: arduino/setup-task@v2
with:
Expand Down Expand Up @@ -105,12 +99,6 @@ jobs:
with:
python-version-file: pyproject.toml

- name: Install Poetry
run: |
pipx install \
--python "$(which python)" \
poetry

- name: Install Task
uses: arduino/setup-task@v2
with:
Expand Down
6 changes: 0 additions & 6 deletions .github/workflows/check-yaml-task.yml
Original file line number Diff line number Diff line change
Expand Up @@ -99,12 +99,6 @@ jobs:
with:
python-version-file: pyproject.toml

- name: Install Poetry
run: |
pipx install \
--python "$(which python)" \
poetry

- name: Install Task
uses: arduino/setup-task@v2
with:
Expand Down
6 changes: 0 additions & 6 deletions .github/workflows/spell-check-task.yml
Original file line number Diff line number Diff line change
Expand Up @@ -53,12 +53,6 @@ jobs:
with:
python-version-file: pyproject.toml

- name: Install Poetry
run: |
pipx install \
--python "$(which python)" \
poetry

- name: Install Task
uses: arduino/setup-task@v2
with:
Expand Down
6 changes: 0 additions & 6 deletions .github/workflows/test-python-poetry-task.yml
Original file line number Diff line number Diff line change
Expand Up @@ -75,12 +75,6 @@ jobs:
with:
python-version-file: pyproject.toml

- name: Install Poetry
run: |
pipx install \
--python "$(which python)" \
poetry

- name: Install Task
uses: arduino/setup-task@v2
with:
Expand Down
32 changes: 32 additions & 0 deletions Taskfile.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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

View workflow job for this annotation

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:
Expand All @@ -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

View workflow job for this annotation

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:
Expand Down Expand Up @@ -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

View workflow job for this annotation

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:
Expand Down Expand Up @@ -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

View workflow job for this annotation

GitHub Actions / Generate problem matcher output

124:121 [line-length] line too long (142 > 120 characters)
false
}
- |
Expand Down Expand Up @@ -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

View workflow job for this annotation

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

View workflow job for this annotation

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:
Expand All @@ -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

View workflow job for this annotation

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:
Expand All @@ -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

View workflow job for this annotation

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:
Expand All @@ -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

View workflow job for this annotation

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:
Expand Down Expand Up @@ -381,10 +381,42 @@
-r "{{.STYLELINTRC_SCHEMA_PATH}}" \
-d "{{.PROJECT_FOLDER}}/{{.INSTANCE_PATH}}"

poetry:install:
desc: Install Poetry
run: once
vars:
PYTHON_PATH:
sh: task utility:normalize-path RAW_PATH="$(which python)"
cmds:
- |
if ! which pipx &>/dev/null; then
echo "pipx not found or not in PATH."
echo "Please install: https://pipx.pypa.io/stable/installation/#installing-pipx"
exit 1
fi
- |
if ! which yq &>/dev/null; then
echo "yq not found or not in PATH."
echo "Please install: https://github.com/mikefarah/yq/#install"
exit 1
fi
- |
pipx install \
--python "{{.PYTHON_PATH}}" \
"poetry==$( \
yq \
--input-format toml \
--output-format yaml \
'.tool.poetry.group.pipx.dependencies.poetry' \
< pyproject.toml
)"

# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/poetry-task/Taskfile.yml
poetry:install-deps:
desc: Install dependencies managed by Poetry
run: when_changed
deps:
- task: poetry:install
cmds:
- |
poetry install \
Expand Down
8 changes: 7 additions & 1 deletion action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,13 @@ runs:
# Install Poetry.
pipx install \
--python "$(which python)" \
poetry==1.4.0
"poetry==$( \
yq \
--input-format toml \
--output-format yaml \
'.tool.poetry.group.pipx.dependencies.poetry' \
< pyproject.toml
)"

# Install Python dependencies.
poetry install \
Expand Down
8 changes: 8 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,14 @@ optional = true
[tool.poetry.group.external.dependencies]
pyserial = "3.5"

# The dependencies in this group are installed using pipx; NOT Poetry. The use of a `poetry` section is a hack required
# in order to be able to manage updates of these dependencies via Dependabot, as used for all other dependencies.
[tool.poetry.group.pipx]
optional = true

[tool.poetry.group.pipx.dependencies]
poetry = "1.4.0"

[build-system]
requires = ["poetry-core"]
build-backend = "poetry.core.masonry.api"
Loading