Anthony Correa
f59d056cf4
All checks were successful
Build & publish docs (rc + release) / publish (push) Successful in 8s
+ update spellcheck to use cspell
57 lines
1.3 KiB
YAML
57 lines
1.3 KiB
YAML
name: CI - Docs build check
|
|
|
|
on:
|
|
push:
|
|
branches:
|
|
- main
|
|
- develop
|
|
- release-candidate
|
|
workflow_dispatch:
|
|
|
|
permissions:
|
|
contents: read
|
|
|
|
env:
|
|
MKDOCS_STRICT: ${{ vars.MKDOCS_STRICT || 'true' }}
|
|
MKDOCS_CONFIG: mkdocs/mkdocs.yml
|
|
MKDOCS_OFFLINE: false
|
|
CSPELL_CONFIG: tools/spellcheck/cspell.yml
|
|
CSPELL_TARGETS: docs/**/*.md README.md
|
|
|
|
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 ${CSPELL_CONFIG} \
|
|
${CSPELL_TARGETS}
|
|
|
|
- name: Install build dependencies
|
|
run: |
|
|
set -euo pipefail
|
|
pip install -r mkdocs/requirements.txt
|
|
|
|
- name: MkDocs build (strict default)
|
|
|
|
run: |
|
|
set -euo pipefail
|
|
echo "Strict is set to ${MKDOCS_STRICT}"
|
|
FLAGS=()
|
|
|
|
if [ "${MKDOCS_STRICT}" = "true" ]; then
|
|
FLAGS+=(--strict)
|
|
fi
|
|
MKDOCS_OUTPUT_DIR="${RUNNER_TEMP:-${TMPDIR:-/tmp}}/dist"
|
|
|
|
mkdocs build "${FLAGS[@]}" -f "${MKDOCS_CONFIG}" -d "${MKDOCS_OUTPUT_DIR}" |