Skip to content

[ImgBot] Optimize images #68

[ImgBot] Optimize images

[ImgBot] Optimize images #68

Workflow file for this run

name: Deploy MkDocs to GitHub Pages
on:
push:
branches: [main]
pull_request:
branches: [main]
workflow_dispatch:
permissions:
contents: read
# GitHub forces Node 24 for JavaScript actions from 2026-06-16; opt in early
# so the transition is tested under our own control.
env:
FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: true
concurrency:
group: pages-${{ github.ref }}
cancel-in-progress: true
jobs:
build:
name: Build MkDocs site
runs-on: ubuntu-latest
timeout-minutes: 10
permissions:
contents: read
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 1
persist-credentials: false
- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: "3.x"
- name: Install mkdocs-material and same-dir plugin
run: pip install mkdocs-material mkdocs-same-dir
- name: Build site
run: mkdocs build
- name: Inject bespoke landing page as site root
run: cp web/index.html _site/index.html
- name: Upload Pages artifact
if: github.event_name != 'pull_request'
uses: actions/upload-pages-artifact@v3
with:
path: _site/
deploy:
name: Deploy to GitHub Pages
if: (github.event_name == 'push' || github.event_name == 'workflow_dispatch') && github.ref == 'refs/heads/main'
needs: build
runs-on: ubuntu-latest
timeout-minutes: 5
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4