pages.yml

---
name: Pages Deploy

on:
  release:
    types: [published]

jobs:
  deploy-pages:
    runs-on: ubuntu-latest
    environment: github-pages
    name: Build documentation site and deploy to GH-Pages
    steps:
      - name: Checkout sources
        uses: actions/checkout@v4
        with:
          fetch-depth: 0
          ref: ${{ github.ref }}
          ssh-key: ${{ secrets.DEPLOY_KEY }}

      - name: Setup Python
        uses: actions/setup-python@v5
        with:
          python-version: "3.13"

      - name: Cache pip repository
        uses: actions/cache@v4
        with:
          path: ~/.cache/pip
          key: ${{ runner.os }}-pip-${{ hashFiles('requirements.txt') }}

      - name: Prepare python environment
        run: pip install -rrequirements.txt

      - name: Configure git
        run: |
          git config user.name "${{ github.actor }}"
          git config user.email "${{ github.actor }}@users.noreply.github.com"

      - name: Deploy to GH Pages
        run: |
          git pull origin ${{ github.event.repository.default_branch }}
          mkdocs gh-deploy -m 'docs: deployed to gh-pages for ${{ github.ref }}'