publish-docs.yml

name: publish-docs

permissions:
  id-token: write
  pages: write

on:
  workflow_run:
    workflows:
      - publish
    types:
      - completed

jobs:
  publish-docs:
    runs-on: ubuntu-latest
    strategy:
      max-parallel: 1
      matrix:
        python-version: ['3.10']

    steps:
      - uses: actions/checkout@v4
      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v5
        with:
          python-version: ${{ matrix.python-version }}
      # Avoid caching to be 100% confident things are working properly
      - name: Init python poetry action
        uses: abatilo/actions-poetry@v3.0.0
        with:
          poetry-version: 1.5.1

      - name: Install dependencies
        run: poetry install -E session

      - name: Check docs are up to date
        run: poetry run make docs-build

      # Publish docs to github pages
      - name: Setup Pages
        uses: actions/configure-pages@v4
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v2
        with:
          # Upload entire repository
          path: './site'
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4