name: Docs/Test WorkFlow

on:
  pull_request:
    branches: ["main", "release/*", "develop"]
  push:
    branches: ["main", "release/*", "develop"]
  workflow_dispatch: {}

# Restrict permissions by default
permissions:
  contents: read # Required for checkout
  checks: write # Required for test reporting

jobs:
  docs-build-test:
    name: Test docs build
    runs-on: ubuntu-latest
    timeout-minutes: 10
    steps:
      - name: 📥 Checkout the repository
        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
        with:
          fetch-depth: 0

      - name: 🐍 Install uv and set Python
        uses: astral-sh/setup-uv@61cb8a9741eeb8a550a1b8544337180c0fc8476b # v7.2.0
        with:
          python-version: "3.10"
          activate-environment: true

      - name: 🏗️ Install dependencies
        timeout-minutes: 5
        run: uv pip install -e ".[plus]" --group docs

      - name: 🧪 Test Docs Build
        run: uv run --no-sync mkdocs build --verbose

      - name: 📤 Upload docs artifact
        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4
        with:
          name: docs-site
          path: site/
          retention-days: 7

      - name: Minimize uv cache
        run: uv cache prune --ci