docs.yml

name: 'Documentation'
on:
  workflow_dispatch:
  push:
    tags:
      - 'v*'

jobs:
  build:
    if: github.event_name == 'workflow_dispatch' || contains(github.ref, 'v5')
    permissions:
      contents: read
    name: Build
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
        with:
          persist-credentials: false

      - name: Use Node.js LTS
        uses: actions/setup-node@2028fbc5c25fe9cf00d9f06a71cc4710d4507903 # v6.0.0
        with:
          node-version: 'lts/*'
          cache: 'npm'
          cache-dependency-path: docs/package.json

      - name: Install Dependencies
        run: |
          cd docs
          npm ci

      - name: build
        run: |
          cd docs
          npm run build

      - name: Upload Build Artifact
        uses: actions/upload-pages-artifact@7b1f4a764d45c48632c6b24a0339c27f5614fb0b # v4.0.0
        with:
          path: docs/build

  deploy:
    permissions:
      pages: write
      id-token: write
    name: Deploy to GH Pages
    needs: [build]
    runs-on: ubuntu-latest
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}

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