Skip to content

Commit 546a280

Browse files
committed
cicd(docs): Test docs on push
1 parent 2d5d2ac commit 546a280

File tree

1 file changed

+22
-2
lines changed

1 file changed

+22
-2
lines changed

.github/workflows/deploy-mkdocs.yaml renamed to .github/workflows/mkdocs.yaml

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Publish docs via GitHub Pages
1+
name: MkDocs
22

33
on:
44
push:
@@ -10,12 +10,32 @@ on:
1010
- "deployment/**"
1111
- "docs/**"
1212
- "src/**"
13-
- ".github/workflows/deploy-mkdocs.yaml"
13+
- ".github/workflows/mkdocs.yaml"
1414

1515
jobs:
16+
test:
17+
name: Test docs
18+
runs-on: ubuntu-latest
19+
steps:
20+
- name: Checkout main
21+
uses: actions/checkout@v4
22+
23+
- name: Set up Python 3.11
24+
uses: actions/setup-python@v5
25+
with:
26+
python-version: 3.11
27+
28+
- uses: astral-sh/setup-uv@v4
29+
with:
30+
enable-cache: true
31+
32+
- name: Test docs
33+
run: uv run --extra docs mkdocs build --strict
34+
1635
build:
1736
name: Deploy docs
1837
runs-on: ubuntu-latest
38+
if: github.ref_name == 'main'
1939
steps:
2040
- name: Checkout main
2141
uses: actions/checkout@v4

0 commit comments

Comments
 (0)