docs.yml

name: Publish Docs
on:
  push:
    branches:
      - master
      - docs/**
    paths:
      - 'docs/**'
      - mkdocs.yml
      - '.github/workflows/docs.yml'
  # Manual triggers
  workflow_dispatch:

permissions:
  contents: write

concurrency:
  group: ${{ github.ref }}
  cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}

jobs:
  publish-docs:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v5
        with:
          fetch-depth: 0

      - name: Configure Git Credentials
        run: |
          git config user.name github-actions[bot]
          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
      - uses: actions/setup-python@v5
        with:
          python-version: '3.11'
      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV 

      - uses: actions/cache@v4
        with:
          key: mkdocs-material-${{ env.cache_id }}
          path: ~/.cache 
          restore-keys: |
            mkdocs-material-
      - run: pip install -r .github/workflows/requirements.txt

      - run: mkdocs gh-deploy --force