diff --git a/.github/workflows/ci-docs.yml b/.github/workflows/ci-docs.yml new file mode 100644 index 0000000..273884f --- /dev/null +++ b/.github/workflows/ci-docs.yml @@ -0,0 +1,42 @@ +name: CI - Docs build check + +on: + pull_request: + 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 strict on if unset + export MKDOCS_STRICT="${MKDOCS_STRICT:-true}" + tools/build.sh --config mkdocs/mkdocs.yml \ No newline at end of file