docs.yml

name: Build and Deploy Docs

on:
  push:
    branches: [main]
    paths:
      - mkdocs.yml
      - docs/**
  pull_request:
    branches: [dev]
    paths:
      - mkdocs.yml
      - docs/**
  workflow_dispatch: {}

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

concurrency:
  group: docs-${{ github.ref }}
  cancel-in-progress: true

jobs:
  build:
    name: Build docs
    runs-on: ubuntu-latest

    steps:
      - # Checkout repository code
        name: Checkout
        uses: actions/checkout@v6

      - # Setup Python for MkDocs build
        name: Set up Python
        uses: actions/setup-python@v6
        with:
          python-version: "3.12"
          cache: pip

      - # Install docs dependencies
        name: Install docs dependencies
        run: |
          python -m pip install --upgrade pip
          python -m pip install \
            mkdocs \
            mkdocs-material \
            mkdocstrings \
            mkdocstrings-python \
            "OctoPrint>=1.10.0,<2" \
            setuptools

      - # Build site from repository root docs
        name: Build MkDocs site
        run: |
          mkdocs build --strict

      - # Upload built site as artifact for Pages deployment
        name: Upload Pages artifact
        uses: actions/upload-pages-artifact@v5
        with:
          path: site

  deploy:
    name: Deploy to GitHub Pages
    needs: build
    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
    runs-on: ubuntu-latest

    steps:
      - # Deploy built site to GitHub Pages
        name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v5