deploy_github-pages.yml

# See: https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions
# And: https://squidfunk.github.io/mkdocs-material/publishing-your-site/

name: 'Deploy: GitHub Pages'

on:
  workflow_dispatch:
  push:
    branches:
      - main

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - uses: actions/setup-python@v5
        with:
          python-version-file: '.python-version'
          cache: 'pip'

      - name: Install dependencies
        run: pip install -r requirements.txt

      - name: Build
        run: mkdocs build --site-dir www

      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: 'www'

  deploy:
    needs: build
    permissions:
          pages: write
          id-token: write
    environment: github-pages
    runs-on: ubuntu-latest
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4

      - name: Finish
        run: |
          echo "Deployed at: ${{ steps.deployment.outputs.page_url }}" >> $GITHUB_STEP_SUMMARY