build-and-deploy-docs.yml

# Workflow for deploying static content to GitHub Pages
name: Deploy Docs to GitHub Pages

on:
  # Runs on pushes targeting the default branch
  push:
    branches: ["develop"]
    paths:
      - doc/** # Only run workflow when changes are made to the doc directory
  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

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

# 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:
  # Single deploy job since we're just deploying
  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v6
      - uses: actions/cache@v5
        name: Setup gnpm cache
        if: always()
        with:
          path: |
            ${{ env.STORE_PATH }}
            ~/.local/share/gnpm
            /usr/local/bin/gnpm
            /usr/local/bin/gnpm-0.0.12
          key: ${{ runner.os }}-gnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
          restore-keys: |
            ${{ runner.os }}-gnpm-store-
      - name: Setup gnpm
        uses: SamTV12345/gnpm-setup@main
        with:
          version: 0.0.12
      - name: Setup Pages
        uses: actions/configure-pages@v6
      - name: Install dependencies
        run: gnpm install
      - name: Build app
        working-directory: doc
        run: gnpm run docs:build
        env:
          COMMIT_REF: ${{ github.sha }}
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v5
        with:
          # Upload entire repository
          path: './doc/.vitepress/dist'
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v5