deploy-docs.yml

name: Generate and push documentation

on:
  push:
    branches:
      - main
    paths:
      - 'mkdocs/**'
  release:
    types:
      - published

jobs:
  build_docs:
    name: Generate and push documentation
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0 # fetch all commits/branches

      - uses: actions/setup-python@v5
        with:
          python-version: "3.10"
          cache: pip
          cache-dependency-path: mkdocs/requirements.txt

      - name: Install Python dependencies
        run: python3 -m pip install -r ./mkdocs/requirements.txt

      - name: Configure Git user
        run: |
          git config --local user.email "github-actions[bot]@users.noreply.github.com"
          git config --local user.name "github-actions[bot]"

      - name: Deploy with mike 🚀
        if: ${{ github.event_name == 'release' }}
        run: |
          cd mkdocs
          mike deploy --push --update-aliases ${{ github.event.release.tag_name }} latest

      - name: Deploy with mike 🚀
        if: ${{ github.event_name == 'push' }}
        run: |
          cd mkdocs
          mike deploy --push main