44 lines
950 B
YAML
44 lines
950 B
YAML
name: CI - Docs build check
|
|
|
|
on:
|
|
pull_request:
|
|
branches-ignore:
|
|
- gh-pages
|
|
push:
|
|
workflow_dispatch:
|
|
|
|
permissions:
|
|
contents: read
|
|
|
|
jobs:
|
|
build-check:
|
|
runs-on: ubuntu-latest
|
|
|
|
steps:
|
|
- name: Checkout
|
|
uses: actions/checkout@v4
|
|
|
|
- name: Setup Python
|
|
uses: actions/setup-python@v5
|
|
with:
|
|
python-version: "3.11"
|
|
|
|
- name: Spellcheck
|
|
run: |
|
|
set -euo pipefail
|
|
npx --yes cspell \
|
|
--config tools/spellcheck/cspell.yml \
|
|
"docs/**/*.md" \
|
|
README.md
|
|
|
|
- name: Install build dependencies
|
|
run: |
|
|
set -euo pipefail
|
|
pip install -r mkdocs/requirements.txt
|
|
|
|
- name: MkDocs build (strict default)
|
|
run: |
|
|
set -euo pipefail
|
|
# Default not strict on if unset
|
|
export MKDOCS_STRICT="${MKDOCS_STRICT:-true}"
|
|
tools/build.sh --config mkdocs/mkdocs.yml |