publish-docs.yml

name: Publish docs

on:
  push:
    branches: [ main ]
    paths:
      - "docs/**"
      - "mkdocs.yml"
  workflow_dispatch:  # Allows to trigger the workflow manually in GitHub UI

permissions:
  contents: write

jobs:
  run:
    name: "deploy docs"
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v4
      with:
        # See <https://github.com/mkdocs/mkdocs/issues/2370#issuecomment-821926264>
        fetch-depth: 0
    - name: Set up Python
      uses: actions/setup-python@v5
      with:
        python-version: 3.12

    - name: Set up pip cache
      if: runner.os == 'Linux'
      uses: actions/cache@v4
      with:
        path: ~/.cache/pip
        key: ${{ runner.os }}-pip-${{ hashFiles('pyproject.toml') }}
        restore-keys: ${{ runner.os }}-pip-

    - name: Install hatch
      run: |
        pipx install hatch

    - name: Publish doc
      run: hatch env run -e docs mkdocs gh-deploy