docs.yml

name: Generate and Release Documentation

on:
  push:
    branches: [ "master" ]
  workflow_dispatch:

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4
      - name: Install Dependencies
        run: npm ci
      - name: Setup Pages
        id: pages
        uses: actions/configure-pages@v5
      - name: Build with JSDoc
        run: npm run docs
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: docs/
  deploy:
    environment:
      name: github-pages
      url: ${{steps.deployment.outputs.page_url}}
    # Grant GITHUB_TOKEN the permissions required to make a Pages deployment
    permissions:
      pages: write      # to deploy to Pages
      id-token: write   # to verify the deployment originates from an appropriate source
    runs-on: ubuntu-latest
    needs: build
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4