gh-pages.yml

# Deploy Sphinx content to GitHub Pages
name: Docs

on:
  # Runs on pushes targeting the default branch
  push:
    paths:
      - .github/workflows/gh-pages.yml
      - build_docs.py
      - docs/**
      - src/**
    branches:
      - 'main'

  release:
    types:
      - published

  workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
  contents: read
  pages: write
  id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
  group: "pages"
  cancel-in-progress: false

jobs:
  build:
    name: Build the documentation with Sphinx
    uses: sandialabs/sansmic-ci/.github/workflows/build-sphinx-all.yml@main

  deploy:
    name: Deploy documentation to GitHub Pages
    needs: [build]
    if: ${{ success() || failure() }}
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    steps:
      - name: Harden Runner
        uses: step-security/harden-runner@cb605e52c26070c328afc4562f0b4ada7618a84e # v2.10.4
        with:
          disable-sudo: true
          egress-policy: block
          allowed-endpoints: >
            api.github.com:443

      - name: Setup Pages
        uses: actions/configure-pages@983d7736d9b0ae728b81ab479565c72886d7745b # v5.0.0

      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4.0.5