release-docs.yml

name: Release Workshop Docs

on:
  push:
    branches:
      - main
    paths:
      - 'docs/**'
      - 'mkdocs.yml'
      - 'Makefile'
  workflow_dispatch: {}

permissions:
  contents: write         # Required for checkout and upload-pages-artifact actions
  deployments: write      # Required for deploy-pages action
  id-token: write         # Required for deploy-pages action if using OIDC for authentication
  pages: write            # Required for configure-pages, upload-pages-artifact, and deploy-pages actions

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

jobs:
  release-docs:
    runs-on: ubuntu-latest
    name: Build
    steps:
      - uses: actions/checkout@v4
      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: "3.12"
      - name: Capture branch and tag
        id: branch_name
        run: |
          echo "SOURCE_BRANCH=${GITHUB_REF#refs/heads/}" >> $GITHUB_ENV
          echo "SOURCE_TAG=${GITHUB_REF#refs/tags/}" >> $GITHUB_ENV
      - name: Build workshop site
        run: |
          make build-docs-website
      - name: Release all docs to branch
        uses: JamesIves/github-pages-deploy-action@v4
        with:
          folder: ./dist
          branch: gh-pages
          clean-exclude: |
            pr-preview
            .github
  publish-docs:
    name: Publish
    needs: release-docs
    uses: ./.github/workflows/publish-docs.yml