Skip to content
This repository was archived by the owner on Apr 14, 2026. It is now read-only.

Commit 2922a67

Browse files
committed
[Chore] update project metadata + CI
1 parent 4639791 commit 2922a67

6 files changed

Lines changed: 399 additions & 310 deletions

File tree

.github/workflows/docs.yaml

Lines changed: 31 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,15 @@
11
name: Build and publish docs
22

33
permissions:
4-
contents: write
4+
contents: read
5+
pages: write
6+
id-token: write
7+
8+
concurrency:
9+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
10+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
11+
group: pages
12+
cancel-in-progress: false
513

614
on:
715
workflow_run:
@@ -10,26 +18,38 @@ on:
1018
- completed
1119
branches:
1220
- main
21+
workflow_dispatch:
22+
1323

1424
jobs:
1525
build-and-publish-docs:
1626
if: ${{ github.event.workflow_run.conclusion == 'success' }}
1727
runs-on: ubuntu-latest
28+
environment:
29+
name: github-pages
30+
url: ${{ steps.deployment.outputs.page_url }}
1831
steps:
1932
- uses: actions/checkout@v4
20-
21-
- name: Setup uv
22-
uses: astral-sh/setup-uv@v6
33+
- name: Install uv
34+
uses: astral-sh/setup-uv@v5
2335
with:
2436
enable-cache: true
25-
pyproject-file: pyproject.toml
26-
37+
- name: Set up Python
38+
uses: actions/setup-python@v5
39+
with:
40+
python-version-file: pyproject.toml
41+
- name: Install the project
42+
run: uv sync --only-group docs
2743
- name: Build docs
2844
run: |
2945
APP_MODULE_NAME=$(ls src -U | head -1) # Get the first module name in the src directory
30-
uv run --frozen --extra docs pdoc src/"$APP_MODULE_NAME" -o docs_build -t docs/pdoc-theme --docformat google
31-
touch docs_build/.nojekyll
32-
33-
- uses: JamesIves/github-pages-deploy-action@v4
46+
uv run pdoc src/"$APP_MODULE_NAME" -o docs_build -t docs/pdoc-theme --docformat google
47+
- name: Setup Pages
48+
uses: actions/configure-pages@v5
49+
- name: Upload artifact
50+
uses: actions/upload-pages-artifact@v4
3451
with:
35-
folder: docs_build
52+
path: ./docs_build
53+
- name: Deploy to GitHub Pages
54+
id: deployment
55+
uses: actions/deploy-pages@v4

.github/workflows/publish-pypi.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ jobs:
1515

1616
steps:
1717
- uses: actions/checkout@v4
18-
18+
1919
- name: Setup uv
2020
uses: astral-sh/setup-uv@v6
2121
with:

.github/workflows/test.yaml

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@ jobs:
1616
uses: astral-sh/setup-uv@v6
1717
with:
1818
enable-cache: true
19-
pyproject-file: pyproject.toml
2019

2120
- name: Run tests
2221
id: run-tests
@@ -44,8 +43,7 @@ jobs:
4443
uses: astral-sh/setup-uv@v6
4544
with:
4645
enable-cache: true
47-
pyproject-file: pyproject.toml
48-
46+
4947
- name: Ruff format
5048
run: uv run ruff format --check
5149

@@ -61,6 +59,5 @@ jobs:
6159
uses: astral-sh/setup-uv@v6
6260
with:
6361
enable-cache: true
64-
pyproject-file: pyproject.toml
6562

6663
- run: uv run mypy .

.pre-commit-config.yaml

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,33 @@
11
fail_fast: false
22

33
repos:
4-
- repo: https://github.com/python-poetry/poetry
5-
rev: 2.1.1
6-
hooks:
7-
- id: poetry-check
8-
94
- repo: https://github.com/astral-sh/ruff-pre-commit
10-
rev: v0.9.6
5+
rev: v0.12.10
116
hooks:
127
- id: ruff
138
- id: ruff-format
149

1510
- repo: https://github.com/pre-commit/mirrors-mypy
16-
rev: v1.15.0
11+
rev: v1.17.1
1712
hooks:
1813
- id: mypy
1914
args: [--ignore-missing-imports]
2015
- repo: https://github.com/macisamuele/language-formatters-pre-commit-hooks
21-
rev: v2.14.0
16+
rev: v2.15.0
2217
hooks:
2318
- id: pretty-format-yaml
2419
args:
2520
- --autofix
2621
- --indent=2
2722
- id: pretty-format-toml
28-
exclude: ^poetry.lock$
23+
exclude: ^uv.lock$
2924
args:
3025
- --autofix
3126
- --indent=2
3227
- --no-sort
3328

3429
- repo: https://github.com/pre-commit/pre-commit-hooks
35-
rev: v5.0.0
30+
rev: v6.0.0
3631
hooks:
3732
- id: check-case-conflict
3833
- id: end-of-file-fixer
@@ -42,6 +37,7 @@ repos:
4237
- --autofix
4338
- --indent=4
4439
- --no-sort-keys
40+
exclude_types: [jupyter]
4541
- id: check-merge-conflict
4642
- id: check-yaml
4743
- id: check-json

pyproject.toml

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
[project]
22
name = "styxdocker"
3-
version = "0.5.0"
3+
version = "0.5.1"
44
description = "Docker integration for Styx compiled wrappers."
55
authors = [
6-
{ name = "Florian Rupprecht", email = "33600480+nx10@users.noreply.github.com" },
6+
{name = "Florian Rupprecht", email = "33600480+nx10@users.noreply.github.com"}
77
]
88
requires-python = ">=3.10"
99
readme = "README.md"
@@ -12,17 +12,14 @@ dependencies = ["styxdefs>=0.5.0,<0.6"]
1212

1313
[dependency-groups]
1414
dev = [
15-
"pytest>=8.2.1,<9",
16-
"mypy>=1.11.2,<2",
17-
"pre-commit>=4.0.1,<5",
18-
"pytest-cov>=6.0.0,<7",
19-
"ruff>=0.9.6,<0.10",
15+
"pytest>=8.4.2",
16+
"mypy>=1.17.1",
17+
"pre-commit>=4.3.0",
18+
"pytest-cov>=6.2.1",
19+
"ruff>=0.12.12",
20+
"deptry>=0.23.0"
2021
]
21-
docs = ["pdoc>=15.0.0,<16"]
22-
23-
[build-system]
24-
requires = ["hatchling"]
25-
build-backend = "hatchling.build"
22+
docs = ["pdoc>=15.0.0"]
2623

2724
[tool.pytest.ini_options]
2825
pythonpath = ["src"]
@@ -48,3 +45,7 @@ convention = "google"
4845

4946
[tool.ruff.lint.per-file-ignores]
5047
"tests/**/*.py" = []
48+
49+
[build-system]
50+
requires = ["uv_build>=0.8.13,<0.9.0"]
51+
build-backend = "uv_build"

0 commit comments

Comments
 (0)