signal-fish-server 0.2.0

# Documentation Deployment Workflow
#
# Builds and deploys MkDocs Material documentation to GitHub Pages.
# Uses the official GitHub Pages deployment actions for secure, token-free publishing.
#
# Runs on:
#   - Push to main branch (only for documentation-related changes)
#   - Manual workflow dispatch
#
# Jobs:
#   - build: Install Python dependencies, build MkDocs site with strict mode
#   - deploy: Deploy built site to GitHub Pages
#
# Configuration:
#   - mkdocs.yml: MkDocs site configuration
#   - requirements-docs.txt: Python dependencies for documentation build

name: Deploy Documentation

on:
  push:
    branches: [main]
    paths:
      - 'docs/**'
      - 'mkdocs.yml'
      - 'requirements-docs.txt'
      - '.github/workflows/docs-deploy.yml'
  workflow_dispatch:

permissions:
  contents: read
  pages: write
  id-token: write

concurrency:
  group: pages
  cancel-in-progress: false

jobs:
  build:
    name: Build Documentation
    runs-on: ubuntu-latest
    timeout-minutes: 10
    steps:
      - name: Checkout repository
        uses: actions/checkout@v6.0.2
      - name: Setup Python
        uses: actions/setup-python@v6.2.0
        with:
          python-version: '3.x'
          cache: pip
          cache-dependency-path: requirements-docs.txt

      - name: Install dependencies
        run: pip install -r requirements-docs.txt

      - name: Build documentation
        run: mkdocs build --strict

      - name: Upload pages artifact
        uses: actions/upload-pages-artifact@v4.0.0
        with:
          path: site/

  deploy:
    name: Deploy to GitHub Pages
    needs: build
    runs-on: ubuntu-latest
    timeout-minutes: 5
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - name: Configure GitHub Pages
        uses: actions/configure-pages@v5.0.0
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4.0.5