Skip to content

Commit 1913a88

Browse files
committed
Add github workflows for: building docs, deploying docs, and PR check
1 parent 2f47104 commit 1913a88

3 files changed

Lines changed: 80 additions & 0 deletions

File tree

.github/workflows/build-docs.yaml

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: Build docs
2+
3+
on:
4+
workflow_call:
5+
inputs:
6+
upload-pages-artifact:
7+
required: false
8+
type: boolean
9+
default: false
10+
description: 'Whether to upload the build as an artifact'
11+
12+
jobs:
13+
build:
14+
name: Build
15+
runs-on: ubuntu-latest
16+
steps:
17+
- name: Checkout code
18+
uses: actions/checkout@v4
19+
20+
- name: Setup Python
21+
uses: actions/setup-python@v6
22+
with:
23+
python-version-file: ".python-version"
24+
25+
- name: Install uv
26+
uses: astral-sh/setup-uv@v7
27+
with:
28+
enable-cache: true
29+
30+
- name: Install python deps
31+
run: uv sync --locked
32+
33+
- name: Build
34+
run: uv run mkdocs build --strict
35+
36+
- name: Upload Pages artifact
37+
uses: actions/upload-pages-artifact@v4
38+
with:
39+
path: site

.github/workflows/check-docs.yaml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
name: Check docs
2+
3+
on:
4+
pull_request:
5+
workflow_dispatch:
6+
7+
jobs:
8+
build:
9+
uses: ./.github/workflows/build-docs.yaml
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: Publish docs via GitHub Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
workflow_dispatch:
8+
9+
jobs:
10+
build:
11+
uses: ./.github/workflows/build-docs.yaml
12+
with:
13+
upload-pages-artifact: true
14+
15+
deploy:
16+
needs: build
17+
permissions:
18+
pages: write
19+
id-token: write
20+
runs-on: ubuntu-latest
21+
environment:
22+
name: github-pages
23+
url: ${{ steps.deployment.outputs.page_url }}
24+
25+
steps:
26+
- name: Deploy
27+
id: deployment
28+
uses: actions/deploy-pages@v4
29+
30+
concurrency:
31+
group: pages
32+
cancel-in-progress: true

0 commit comments

Comments
 (0)