ci(docs): verify the documentation site builds
Build-only. The site deploys from the Ansible control node via the vectislabs.automation docs_site role against nebula, so CI has nothing to publish; what it catches is a docs change that will not build at all, before it reaches a deploy. Path-filtered to docs sources, so the ~600 commits a month that touch no documentation do not run it.
This commit is contained in:
1 parent
c1ebc23985
commit
906b2114f4
1 file changed
+43
@@ -0,0 +1,43 @@
|
||||
name: docs
|
||||
|
||||
# Verification only. Deployment happens from the Ansible control node
|
||||
# (vectislabs.automation docs_site role against nebula), so there is nothing
|
||||
# for CI to publish. What CI is for here is catching a docs change that will
|
||||
# not build before it reaches a deploy.
|
||||
on:
|
||||
push:
|
||||
branches: [main]
|
||||
paths:
|
||||
- "docs/**"
|
||||
- "mkdocs.yml"
|
||||
- ".github/workflows/docs.yml"
|
||||
pull_request:
|
||||
paths:
|
||||
- "docs/**"
|
||||
- "mkdocs.yml"
|
||||
workflow_dispatch:
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
concurrency:
|
||||
group: docs-${{ github.ref }}
|
||||
cancel-in-progress: true
|
||||
|
||||
jobs:
|
||||
build:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v5
|
||||
|
||||
- uses: actions/setup-python@v6
|
||||
with:
|
||||
python-version: "3.13"
|
||||
cache: pip
|
||||
|
||||
- run: pip install mkdocs-material
|
||||
|
||||
# --strict fails on a broken internal link or an unknown config key. A
|
||||
# docs site that silently ships dead links is worse than one that refuses
|
||||
# to ship.
|
||||
- run: mkdocs build --strict
|
||||
Reference in new issue
Block a user