This commit is contained in:
2026-02-05 12:44:38 -06:00
parent ead328c075
commit afd82d071c

View File

@@ -10,6 +10,12 @@ on:
permissions:
contents: read
env:
MKDOCS_STRICT: ${{ vars.MKDOCS_STRICT:-true }}
MKDOCS_CONFIG: mkdocs/mkdocs.yml
CSPELL_CONFIG: tools/spellcheck/cspell.yml
CSPELL_TARGETS: "docs/**/*.md" README.md
jobs:
build-check:
runs-on: ubuntu-latest
@@ -27,9 +33,8 @@ jobs:
run: |
set -euo pipefail
npx --yes cspell \
--config tools/spellcheck/cspell.yml \
"docs/**/*.md" \
README.md
--config ${CSPELL_CONFIG \
${CSPELL_TARGETS}
- name: Install build dependencies
run: |
@@ -37,10 +42,15 @@ jobs:
pip install -r mkdocs/requirements.txt
- name: MkDocs build (strict default)
env:
MKDOCS_STRICT: ${{ vars.MKDOCS_STRICT }}
run: |
set -euo pipefail
# Default strict on if unset
echo "Strict is set to ${MKDOCS_STRICT}"
tools/build.sh
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}"