Merge branch 'casid:main' into main #10
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Validate docs | |
# Only run workflow if the docs are changing. | |
# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#onpushpull_requestpull_request_targetpathspaths-ignore | |
on: | |
pull_request: | |
paths: | |
- 'mkdocs.yml' | |
- 'docs/**' | |
push: | |
branches: | |
- main | |
jobs: | |
validate: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
with: | |
fetch-depth: 0 # all history for all branches and tags | |
- uses: actions/setup-python@v5 | |
with: | |
python-version: 3.x | |
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV | |
- uses: actions/cache@v4 | |
with: | |
key: mkdocs-material-${{ env.cache_id }} | |
path: .cache | |
restore-keys: | | |
mkdocs-material- | |
- name: Setup MkDocs | |
run: .github/scripts/setup-docs-dependencies.sh | |
- name: Build docs | |
# https://www.mkdocs.org/user-guide/cli/#mkdocs-build | |
# --strict cause MkDocs to abort the build on any warnings. | |
# For example, broken internal links. More about validation | |
# here: https://www.mkdocs.org/user-guide/configuration/#validation. | |
run: mkdocs build --strict |