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