Skip to content

Commit 9b4f0fb

Browse files
committed
feat: add automated documentation deployment workflow
1 parent 3fee35b commit 9b4f0fb

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed

.github/workflows/docs.yml

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
name: Deploy Documentation
2+
3+
on:
4+
push:
5+
branches: [ main ]
6+
workflow_dispatch:
7+
8+
permissions:
9+
contents: read
10+
pages: write
11+
id-token: write
12+
13+
concurrency:
14+
group: "pages"
15+
cancel-in-progress: false
16+
17+
jobs:
18+
docs:
19+
runs-on: ubuntu-latest
20+
21+
steps:
22+
- name: Checkout
23+
uses: actions/checkout@v4
24+
with:
25+
fetch-depth: 0
26+
27+
- name: Install uv
28+
uses: astral-sh/setup-uv@v5
29+
with:
30+
version: "latest"
31+
32+
- name: Set up Python
33+
run: uv python install 3.11
34+
35+
- name: Install dependencies
36+
run: uv sync --group docs
37+
38+
- name: Configure Git
39+
run: |
40+
git config --global user.name "github-actions[bot]"
41+
git config --global user.email "github-actions[bot]@users.noreply.github.com"
42+
43+
- name: Deploy documentation
44+
run: uv run mkdocs gh-deploy --force

0 commit comments

Comments
 (0)