Skip to content

Commit 876ec6a

Browse files
DX: use poe as task runner (#35)
* MAINT: implement autofixes from pre-commit * MAINT: upgrade lock files
1 parent 97f5595 commit 876ec6a

File tree

13 files changed

+38
-26
lines changed

13 files changed

+38
-26
lines changed

.github/workflows/cd.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ on:
99
jobs:
1010
milestone:
1111
if: startsWith(github.ref, 'refs/tags')
12-
uses: ComPWA/actions/.github/workflows/close-milestone.yml@v2
12+
uses: ComPWA/actions/.github/workflows/close-milestone.yml@v3
1313
package-name:
14-
uses: ComPWA/actions/.github/workflows/get-pypi-name.yml@v2
14+
uses: ComPWA/actions/.github/workflows/get-pypi-name.yml@v3
1515
pypi:
1616
environment:
1717
name: PyPI
@@ -24,9 +24,9 @@ jobs:
2424
id-token: write
2525
runs-on: ubuntu-24.04
2626
steps:
27-
- uses: ComPWA/actions/build-pypi-distribution@v2
27+
- uses: ComPWA/actions/build-pypi-distribution@v3
2828
- uses: pypa/gh-action-pypi-publish@release/v1
2929
push:
3030
if: startsWith(github.ref, 'refs/tags') && !github.event.release.prerelease
3131
secrets: inherit
32-
uses: ComPWA/actions/.github/workflows/push-to-version-branches.yml@v2
32+
uses: ComPWA/actions/.github/workflows/push-to-version-branches.yml@v3

.github/workflows/ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,4 @@ jobs:
2828
if: inputs.specific-pip-packages == ''
2929
secrets:
3030
token: ${{ secrets.PAT }}
31-
uses: ComPWA/actions/.github/workflows/pre-commit.yml@v2.1
31+
uses: ComPWA/actions/.github/workflows/pre-commit.yml@v3.0

.github/workflows/clean-caches.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ jobs:
1616
name: Remove caches
1717
runs-on: ubuntu-24.04
1818
steps:
19-
- uses: ComPWA/actions/clean-caches@v2
19+
- uses: ComPWA/actions/clean-caches@v3
2020
with:
2121
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
2222
ref: ${{ inputs.ref }}

.github/workflows/lock.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,6 @@ on:
1616

1717
jobs:
1818
lock:
19-
uses: ComPWA/actions/.github/workflows/lock.yml@v2
19+
uses: ComPWA/actions/.github/workflows/lock.yml@v3
2020
secrets:
2121
token: ${{ secrets.PAT }}

.github/workflows/pr-linting.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,4 @@ on:
1111

1212
jobs:
1313
lint-pr:
14-
uses: ComPWA/actions/.github/workflows/pr-linting.yml@v2
14+
uses: ComPWA/actions/.github/workflows/pr-linting.yml@v3

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,6 @@ prof/
4141

4242
# Virtual environments
4343
*venv/
44-
.tox/
4544
pyvenv*/
4645
uv.lock
4746

.pre-commit-config.yaml

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
ci:
2-
autoupdate_commit_msg: "MAINT: update lock files"
2+
autofix_commit_msg: "MAINT: implement pre-commit autofixes"
3+
autoupdate_commit_msg: "MAINT: upgrade lock files"
34
autoupdate_schedule: quarterly
45
skip:
56
- mypy
@@ -12,21 +13,21 @@ repos:
1213
- id: check-useless-excludes
1314

1415
- repo: https://github.com/ComPWA/policy
15-
rev: 0.6.1
16+
rev: 0.7.0
1617
hooks:
1718
- id: check-dev-files
1819
args:
1920
- --repo-name=sphinx-api-relink
2021

2122
- repo: https://github.com/astral-sh/ruff-pre-commit
22-
rev: v0.9.3
23+
rev: v0.12.8
2324
hooks:
2425
- id: ruff
2526
args: [--fix]
2627
- id: ruff-format
2728

2829
- repo: https://github.com/pre-commit/pre-commit-hooks
29-
rev: v5.0.0
30+
rev: v6.0.0
3031
hooks:
3132
- id: check-ast
3233
- id: check-case-conflict
@@ -64,12 +65,12 @@ repos:
6465
- --in-place
6566

6667
- repo: https://github.com/streetsidesoftware/cspell-cli
67-
rev: v8.17.1
68+
rev: v9.2.0
6869
hooks:
6970
- id: cspell
7071

7172
- repo: https://github.com/editorconfig-checker/editorconfig-checker.python
72-
rev: 3.2.0
73+
rev: 3.2.1
7374
hooks:
7475
- id: editorconfig-checker
7576
name: editorconfig
@@ -89,6 +90,6 @@ repos:
8990
- python
9091

9192
- repo: https://github.com/ComPWA/pyright-pre-commit
92-
rev: v1.1.392
93+
rev: v1.1.403
9394
hooks:
9495
- id: pyright

.taplo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ reorder_keys = true
1313

1414
[[rule]]
1515
include = ["**/pyproject.toml"]
16-
keys = ["tool.tox"]
16+
keys = ["tool.poe.tasks"]
1717

1818
[rule.formatting]
1919
reorder_arrays = false

.vscode/settings.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,6 @@
4242
"gitlens.telemetry.enabled": false,
4343
"multiDiffEditor.experimental.enabled": true,
4444
"mypy-type-checker.args": ["--config-file=${workspaceFolder}/pyproject.toml"],
45-
"mypy-type-checker.importStrategy": "fromEnvironment",
4645
"notebook.codeActionsOnSave": {
4746
"notebook.source.organizeImports": "explicit"
4847
},

CONTRIBUTING.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,14 +31,14 @@ and [`pre-commit install`](https://pre-commit.com/#3-install-the-git-hook-script
3131
pre-commit install --install-hooks
3232
```
3333

34-
In addition, it may be handy to install `tox`:
34+
[Poe the Poet](https://poethepoet.natn.io) is used as a task runner. You can see which local CI checks it defines by running
3535

3636
```shell
37-
uv tool install tox --with tox-uv
37+
poe
3838
```
3939

40-
If the repository provides a Tox configuration under [`pyproject.toml`](./pyproject.toml), you can see which jobs it defines with:
40+
For instance, all style checks can be run with
4141

4242
```shell
43-
tox list
43+
poe style
4444
```

0 commit comments

Comments
 (0)