Skip to content

Commit 44db9e6

Browse files
committed
chore: docs publishing permissions
1 parent 161bcc9 commit 44db9e6

File tree

1 file changed

+22
-1
lines changed

1 file changed

+22
-1
lines changed

.github/workflows/docs-build.yaml

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,30 @@ jobs:
4646
- name: Build Sphinx documentation
4747
run: uv run sphinx-build docs/source/ docs/build/
4848

49+
- name: Upload built docs artifact
50+
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
51+
uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4
52+
with:
53+
name: docs-site
54+
path: docs/build/
55+
56+
deploy:
57+
name: Deploy to GitHub Pages
58+
needs: build
59+
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
60+
runs-on: ubuntu-latest
61+
timeout-minutes: 10
62+
permissions:
63+
contents: write # Required: push generated docs to gh-pages
64+
steps:
65+
- name: Download built docs artifact
66+
uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4
67+
with:
68+
name: docs-site
69+
path: docs/build/
70+
4971
- name: Deploy to GitHub Pages
5072
uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e # v4
51-
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
5273
with:
5374
publish_branch: gh-pages
5475
github_token: ${{ secrets.GITHUB_TOKEN }}

0 commit comments

Comments
 (0)