docs.yml

name: docs

on:
  push:
    branches: [develop]
    paths:
      - 'docs-site/**'
      - '.github/workflows/docs.yml'

permissions:
  contents: read

jobs:
  deploy:
    permissions:
      contents: write
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
        with:
          fetch-depth: 0
          # persist-credentials kept true — mkdocs gh-deploy pushes to gh-pages branch

      - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5
        with:
          python-version: 3.x

      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV

      - uses: actions/cache@0057852bfaa89a56745cba8c7296529d2fc39830 # v4
        with:
          key: mkdocs-material-${{ env.cache_id }}
          path: ~/.cache
          restore-keys: |
            mkdocs-material-

      - run: pip install -r docs-site/requirements-docs.txt

      - run: cd docs-site && mkdocs gh-deploy --force