docs.yml

name: Deploy docs to GitHub Pages

# Only run this workflow when the YAML file itself changes or files change in the "docs" folder
on:
  push:
    branches: [master]
    paths:
      - ".github/workflows/docs.yml"
      - "docs/**"

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

# Allow one concurrent deployment
concurrency:
  group: "pages"
  cancel-in-progress: true

jobs:
  
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4
      
      - name: Build docs
        run: docs/build.sh
      
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v2
        with:
          path: "build/gh-pages"
  
  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@v2