2024-10-03 23:59:47 +00:00
|
|
|
name: Build docs
|
2024-10-05 21:03:30 +00:00
|
|
|
|
2024-10-03 23:59:47 +00:00
|
|
|
on:
|
|
|
|
push:
|
|
|
|
branches:
|
|
|
|
- 'master'
|
|
|
|
- 'mirror/master'
|
|
|
|
paths:
|
|
|
|
- 'docs/**'
|
|
|
|
- '.github/workflows/docs.yml'
|
2024-10-05 21:03:30 +00:00
|
|
|
pull_request:
|
|
|
|
paths:
|
|
|
|
- 'docs/**'
|
|
|
|
- '.github/workflows/docs.yml'
|
2024-10-03 23:59:47 +00:00
|
|
|
workflow_dispatch:
|
2024-10-05 21:03:30 +00:00
|
|
|
inputs:
|
|
|
|
deploy:
|
|
|
|
description: 'Deploy to GitHub Pages'
|
|
|
|
required: false
|
|
|
|
default: false
|
|
|
|
type: boolean
|
|
|
|
|
2024-10-03 23:59:47 +00:00
|
|
|
permissions:
|
|
|
|
contents: write
|
2024-10-05 21:03:30 +00:00
|
|
|
checks: write
|
|
|
|
|
2024-10-03 23:59:47 +00:00
|
|
|
jobs:
|
2024-10-05 21:03:30 +00:00
|
|
|
build-docs:
|
2024-10-03 23:59:47 +00:00
|
|
|
runs-on: ubuntu-latest
|
|
|
|
steps:
|
|
|
|
- uses: actions/checkout@v4
|
2024-10-05 21:03:30 +00:00
|
|
|
|
2024-10-03 23:59:47 +00:00
|
|
|
- name: Configure Git Credentials
|
|
|
|
run: |
|
|
|
|
git config user.name github-actions[bot]
|
|
|
|
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
|
2024-10-05 21:03:30 +00:00
|
|
|
|
2024-10-03 23:59:47 +00:00
|
|
|
- uses: actions/setup-python@v5
|
|
|
|
with:
|
|
|
|
python-version: 3.x
|
2024-10-05 21:03:30 +00:00
|
|
|
|
|
|
|
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
|
|
|
|
|
2024-10-03 23:59:47 +00:00
|
|
|
- uses: actions/cache@v4
|
|
|
|
with:
|
|
|
|
key: mkdocs-material-${{ env.cache_id }}
|
|
|
|
path: .cache
|
|
|
|
restore-keys: |
|
|
|
|
mkdocs-material-
|
2024-10-05 21:03:30 +00:00
|
|
|
|
|
|
|
- run: pip install mkdocs-material
|
|
|
|
|
|
|
|
- name: Build Docs and Capture Warnings
|
|
|
|
id: build_docs
|
|
|
|
run: |
|
|
|
|
mkdocs build 2>&1 | tee mkdocs-output.log
|
|
|
|
|
|
|
|
- name: Annotate Warnings and Errors
|
|
|
|
if: always() && ${{ steps.build_docs.outcome != 'skipped' }}
|
|
|
|
run: |
|
|
|
|
warnings=$(grep -i 'WARNING' mkdocs-output.log || true)
|
|
|
|
errors=$(grep -i 'ERROR' mkdocs-output.log || true)
|
|
|
|
|
|
|
|
if [ -n "$warnings" ]; then
|
|
|
|
# Annotate warnings
|
|
|
|
echo "$warnings" | while read -r warning; do
|
|
|
|
echo "::warning::${warning}"
|
|
|
|
done
|
|
|
|
fi
|
|
|
|
|
|
|
|
if [ -n "$errors" ]; then
|
|
|
|
# Annotate errors
|
|
|
|
echo "$errors" | while read -r error; do
|
|
|
|
echo "::error::${error}"
|
|
|
|
done
|
|
|
|
|
|
|
|
# Fail the build if any errors were found
|
|
|
|
exit 1
|
|
|
|
fi
|
|
|
|
|
|
|
|
- name: Deploy to GitHub Pages
|
|
|
|
if: ${{ github.event_name == 'push' || github.event_name == 'workflow_dispatch' && github.event.inputs.deploy == true }}
|
|
|
|
run: mkdocs gh-deploy --force
|