update to deploy-rc
All checks were successful
CI - Docs build check / build-check (push) Successful in 8s

This commit is contained in:
2026-02-05 08:41:17 -06:00
committed by Anthony Correa
parent 15be04dac7
commit 351af45301
6 changed files with 144 additions and 120 deletions

View File

@@ -1,19 +1,26 @@
name: CI - Docs build check
on:
pull_request:
branches-ignore:
- gh-pages
push:
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
@@ -27,9 +34,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,8 +43,15 @@ jobs:
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
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}"