deploy-docs.yml

name: Deploy docs
# This job builds and deploys documenation to github pages.
# It runs on every push to main with a change in the docs folder.
on:
  workflow_dispatch:
  push:
    branches:
      - main
      # - "release/**"
    paths:
      - "docs/**"
      # - "x/**/*.md"
      - .github/workflows/deploy-docs.yml

permissions:
  contents: read

jobs:
  build-and-deploy:
    permissions:
      contents: write # for JamesIves/github-pages-deploy-action to push changes in repo
    runs-on: ubuntu-latest
    steps:
      - name: Checkout 🛎️
        uses: actions/checkout@v4
        with:
          persist-credentials: false
          fetch-depth: 0
          path: "."

      - name: Setup Node.js 🔧
        uses: actions/setup-node@v4
        with:
          node-version: "16.x"

      # npm install npm should be removed when https://github.com/npm/cli/issues/4942 is fixed
      - name: Build 🔧
        run: |
          npm install -g npm@8.5.5
          make build-docs

      - name: Deploy 🚀
        uses: JamesIves/github-pages-deploy-action@v4.5.0
        with:
          branch: gh-pages
          folder: ~/output
          single-commit: true