deploy-docs.yml

name: Deploy Documentation

on:
  push:
    branches:
      - main
  workflow_dispatch:

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

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

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4
        with:
          submodules: recursive

      - name: Setup Python
        uses: actions/setup-python@v5
        with:
          python-version: '3.x'

      - name: Install plugin
        run: pip install -e .

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

      - name: Copy icon from submodule to docs
        run: |
          mkdir -p example/docs/cms-docs-common
          cp example/cms-docs-common/CMSlogo_white_nolabel_1024_May2014.png example/docs/cms-docs-common/

      - name: Build documentation
        run: |
          cd example
          mkdocs build --strict

      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: example/site

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