49 lines
1.1 KiB
YAML
49 lines
1.1 KiB
YAML
name: CI - Docs build check
|
|
|
|
on:
|
|
pull_request:
|
|
branches: [release-candidate]
|
|
push:
|
|
branches: [release-candidate]
|
|
workflow_dispatch:
|
|
|
|
permissions:
|
|
contents: read
|
|
|
|
env:
|
|
MKDOCS_STRICT: ${{ vars.MKDOCS_STRICT || 'true' }}
|
|
|
|
jobs:
|
|
build-check:
|
|
runs-on: ubuntu-latest
|
|
|
|
steps:
|
|
- name: Checkout
|
|
uses: actions/checkout@v4
|
|
|
|
- name: Setup Python
|
|
# if: false
|
|
uses: actions/setup-python@v5
|
|
with:
|
|
python-version: "3.11"
|
|
# cache: "pip"
|
|
# cache-dependency-path: mkdocs/requirements.txt
|
|
|
|
- name: Install dependencies
|
|
run: |
|
|
set -euo pipefail
|
|
pip install -r mkdocs/requirements.txt
|
|
|
|
- name: MkDocs build
|
|
run: |
|
|
set -euo pipefail
|
|
echo "MKDOCS_STRICT: $MKDOCS_STRICT"
|
|
MKDOCS_STRICT="${MKDOCS_STRICT:-true}"
|
|
STRICT_FLAG=""
|
|
if [ "${MKDOCS_STRICT}" = "true" ]; then
|
|
STRICT_FLAG="--strict"
|
|
fi
|
|
|
|
OFFLINE=true mkdocs build ${STRICT_FLAG} -f mkdocs/mkdocs.yml -d $RUNNER_TEMP/
|
|
|
|
|