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

Commit 291fe58

Browse files
committed
[Chore] update project metadata + CI
1 parent 84cc6bc commit 291fe58

7 files changed

Lines changed: 403 additions & 322 deletions

File tree

.github/workflows/docs.yaml

Lines changed: 30 additions & 10 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
33+
- name: Install uv
2234
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: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,11 @@ jobs:
1515

1616
steps:
1717
- uses: actions/checkout@v4
18-
18+
1919
- name: Setup uv
20-
uses: astral-sh/setup-uv@v5
20+
uses: astral-sh/setup-uv@v6
2121
with:
2222
enable-cache: true
23-
pyproject-file: pyproject.toml
2423

2524
- name: Install dependencies and build
2625
run: |

.github/workflows/test.yaml

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,9 @@ jobs:
1313
- uses: actions/checkout@v4
1414

1515
- name: Setup uv
16-
uses: astral-sh/setup-uv@v5
16+
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
@@ -41,10 +40,9 @@ jobs:
4140
- uses: actions/checkout@v4
4241

4342
- name: Setup uv
44-
uses: astral-sh/setup-uv@v5
43+
uses: astral-sh/setup-uv@v6
4544
with:
4645
enable-cache: true
47-
pyproject-file: pyproject.toml
4846

4947
- name: Ruff format
5048
run: uv run ruff format --check
@@ -58,9 +56,8 @@ jobs:
5856
- uses: actions/checkout@v4
5957

6058
- name: Setup uv
61-
uses: astral-sh/setup-uv@v5
59+
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

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# Project name
22

3-
[![Build](https://github.com/childmindresearch/styxgraph/actions/workflows/test.yaml/badge.svg?branch=main)](https://github.com/childmindresearch/styxgraph/actions/workflows/test.yaml?query=branch%3Amain)
4-
[![codecov](https://codecov.io/gh/childmindresearch/styxgraph/branch/main/graph/badge.svg?token=22HWWFWPW5)](https://codecov.io/gh/childmindresearch/styxgraph)
3+
[![Build](https://github.com/styx-api/styxgraph/actions/workflows/test.yaml/badge.svg?branch=main)](https://github.com/styx-api/styxgraph/actions/workflows/test.yaml?query=branch%3Amain)
4+
[![codecov](https://codecov.io/gh/styx-api/styxgraph/branch/main/graph/badge.svg?token=22HWWFWPW5)](https://codecov.io/gh/styx-api/styxgraph)
55
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
66
![stability-stable](https://img.shields.io/badge/stability-stable-green.svg)
7-
[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/childmindresearch/styxgraph/blob/main/LICENSE)
8-
[![pages](https://img.shields.io/badge/api-docs-blue)](https://childmindresearch.github.io/styxgraph)
7+
[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/styx-api/styxgraph/blob/main/LICENSE)
8+
[![pages](https://img.shields.io/badge/api-docs-blue)](https://styx-api.github.io/styxgraph)
99

1010
## Usage
1111

pyproject.toml

Lines changed: 11 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[project]
22
name = "styxgraph"
3-
version = "0.5.1"
3+
version = "0.5.2"
44
description = "Execution graph middleware for Styx"
55
authors = [
66
{name = "Florian Rupprecht", email = "33600480+nx10@users.noreply.github.com"}
@@ -12,17 +12,14 @@ dependencies = ["styxdefs>=0.5.0,<0.6"]
1212

1313
[dependency-groups]
1414
dev = [
15-
"pytest>=8.3.2,<9",
16-
"mypy>=1.11.1,<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"]
@@ -42,16 +39,13 @@ select = ["ANN", "D", "E", "F", "I"]
4239
ignore = []
4340
fixable = ["ALL"]
4441
unfixable = []
45-
dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
4642

4743
[tool.ruff.lint.pydocstyle]
4844
convention = "google"
4945

5046
[tool.ruff.lint.per-file-ignores]
5147
"tests/**/*.py" = []
5248

53-
[tool.ruff.format]
54-
quote-style = "double"
55-
indent-style = "space"
56-
skip-magic-trailing-comma = false
57-
line-ending = "auto"
49+
[build-system]
50+
requires = ["uv_build>=0.8.13,<0.9.0"]
51+
build-backend = "uv_build"

0 commit comments

Comments
 (0)