deploy.yml

name: publish
on:
    workflow_dispatch:

permissions:
    contents: read
    pages: write
    id-token: write

concurrency:
    group: 'pages'
    cancel-in-progress: false

jobs:
    build:
      name: build docs
      runs-on: ubuntu-latest
      steps:
        - uses: actions/checkout@v4
          with:
            ref: '1.20.1'
            sparse-checkout: 'docs'
            path: '.'
        - uses: actions/setup-python@v4
          with:
            python-version: '3.11'
            cache: 'pip'
        - run: pip install -r requirements.txt
        - uses: actions/cache@v4
          with:
              key: 'mkdocs-cache'
              path: '.cache'
        - name: Build static files
          id: mkdocs
          run: mkdocs build
        - name: Upload pages as artifact
          id: artifact
          uses: actions/upload-pages-artifact@v3
          with:
            path: 'site/'

    deploy:
      runs-on: ubuntu-latest
      needs: build
      environment:
        name: github-pages
        url: ${{ steps.deployment.outputs.page_url }}
      steps:
        - name: Deploy Pages
          id: deployment
          uses: actions/deploy-pages@v4