Skip to content

Commit f868c52

Browse files
ci: add docs build check on pull requests (#35)
1 parent 788c642 commit f868c52

1 file changed

Lines changed: 39 additions & 0 deletions

File tree

.github/workflows/ci.yml

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,9 +70,48 @@ jobs:
7070
needs:
7171
- lint
7272
- test
73+
- docs-check
7374
runs-on: ubuntu-latest
7475
steps:
7576
- name: Decide whether the needed jobs succeeded or failed
7677
uses: re-actors/alls-green@release/v1
7778
with:
79+
allowed-skips: docs-check
7880
jobs: ${{ toJSON(needs) }}
81+
82+
docs-check:
83+
name: Docs build check
84+
runs-on: ubuntu-latest
85+
86+
steps:
87+
- uses: actions/checkout@v6
88+
89+
- uses: dorny/paths-filter@v4
90+
id: filter
91+
with:
92+
filters: |
93+
docs:
94+
- docs/**
95+
- mkdocs.yml
96+
- src/**
97+
- .github/workflows/docs.yml
98+
99+
- name: Install uv
100+
if: steps.filter.outputs.docs == 'true'
101+
uses: astral-sh/setup-uv@v8.0.0
102+
with:
103+
enable-cache: true
104+
105+
- name: Set up Python
106+
if: steps.filter.outputs.docs == 'true'
107+
uses: actions/setup-python@v6
108+
with:
109+
python-version-file: .python-version
110+
111+
- name: Install dependencies
112+
if: steps.filter.outputs.docs == 'true'
113+
run: uv sync --group dev
114+
115+
- name: Build docs (dry run)
116+
if: steps.filter.outputs.docs == 'true'
117+
run: uv run mkdocs build --clean --strict

0 commit comments

Comments
 (0)