Skip to content

Commit 873d188

Browse files
lesnik512claude
andcommitted
ci: deploy docs via GitHub Actions Pages (drop gh-pages branch)
Replace mkdocs gh-deploy --force (gh-pages branch) with build artifact + actions/deploy-pages, matching the org site. Add the docs-build recipe used by CI. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 76b1de4 commit 873d188

2 files changed

Lines changed: 24 additions & 13 deletions

File tree

.github/workflows/docs.yml

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,20 +9,32 @@ on:
99
- ".github/workflows/docs.yml"
1010
workflow_dispatch:
1111

12-
concurrency:
13-
group: docs-deploy
14-
cancel-in-progress: true
15-
1612
permissions:
17-
contents: write
13+
contents: read
14+
pages: write
15+
id-token: write
16+
17+
concurrency:
18+
group: pages
19+
cancel-in-progress: false
1820

1921
jobs:
20-
deploy:
22+
build:
2123
runs-on: ubuntu-latest
2224
steps:
2325
- uses: actions/checkout@v6
24-
with:
25-
fetch-depth: 0
2626
- uses: extractions/setup-just@v4
2727
- uses: astral-sh/setup-uv@v8.2.0
28-
- run: just docs-deploy
28+
- run: just docs-build
29+
- uses: actions/upload-pages-artifact@v5
30+
with:
31+
path: site
32+
deploy:
33+
needs: build
34+
runs-on: ubuntu-latest
35+
environment:
36+
name: github-pages
37+
url: ${{ steps.deployment.outputs.page_url }}
38+
steps:
39+
- id: deployment
40+
uses: actions/deploy-pages@v5

Justfile

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,6 @@ publish:
3030
uv build
3131
uv publish --token $PYPI_TOKEN
3232

33-
# Force-pushes built site to gh-pages; CI runs this on push to main.
34-
# Manual invocation from a stale checkout will roll the live site back.
35-
docs-deploy:
36-
uvx --with-requirements docs/requirements.txt mkdocs gh-deploy --force
33+
# Build the docs site, failing on broken links / nav warnings; CI runs this on every PR.
34+
docs-build:
35+
uvx --with-requirements docs/requirements.txt mkdocs build --strict

0 commit comments

Comments
 (0)