docs_workflow.yml

name: CI/CD Release Workflow

on:
  push:
    branches:
      - main

  release:
    types: [published]

env:
  PIXI_VERSION: "v0.63.0"

jobs:
  publish-docs:
    runs-on: ubuntu-latest
    defaults:
      run:
        shell: bash -el {0}
    timeout-minutes: 20
    steps:
      - uses: actions/checkout@v6
        with:
          persist-credentials: false
          fetch-depth: 0

      - name: Set up Pixi
        uses: prefix-dev/setup-pixi@v0.9.5
        with:
          pixi-version: ${{ env.PIXI_VERSION }}
          environments: default
          activate-environment: true
          cache: true
          locked: true

      - name: Build Sphinx Docs
        run: |
          set -e
          pip check
          cd docs
          DOCS_VERSION=${{ github.ref_name }} make versioned-html
      - name: Copy Docs and Commit
        run: |
          set -e
          pip check
          cd docs
          # gh-pages branch must already exist
          git clone https://github.com/MPAS-Dev/geometric_features.git --branch gh-pages --single-branch gh-pages

          # Make sure we're in the gh-pages directory.
          cd gh-pages
          # Create `.nojekyll` (if it doesn't already exist) for proper GH Pages configuration.
          touch .nojekyll
          # Add `index.html` to point to the `main` branch automatically.
          printf '<meta http-equiv="refresh" content="0; url=./main/index.html" />' > index.html
          # Only replace docs in a directory with the destination branch name with latest changes. Docs for
          # releases should be untouched.
          rm -rf ${{ github.head_ref || github.ref_name }}
          # don't clobber existing release versions (in case we retroactively fixed them)
          cp -r -n ../_build/html/* .
          # Configure git using GitHub Actions credentials.
          git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com"
          git config --local user.name "github-actions[bot]"
          # The second command will fail if no changes were present, so we ignore it
          git add .
          git commit -m "Update documentation" -a || true
      - name: Push Changes
        uses: ad-m/github-push-action@master
        with:
          branch: gh-pages
          directory: docs/gh-pages
          github_token: ${{ secrets.GITHUB_TOKEN }}
          force: true