deploy-docs.yml

# Workflow to build VitePress site and deploy it to GitHub Pages
#
name: Deploy VitePress Docs to Pages

on:
  # Run on pushes to the `develop` branch
  push:
    branches: [develop]
    # Only trigger when files in the doc directory change
    paths:
      - 'doc/**'

  # Allow manual running of this workflow from the Actions tab
  workflow_dispatch:

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

# Only allow one deployment at a time, skip runs queued between the running run and the latest queue
# However, do not cancel the running run, as we want to allow these production deployments to complete
concurrency:
  group: pages
  cancel-in-progress: false

jobs:
  # Build job
  build:
    runs-on: ubuntu-latest
    defaults:
      run:
        working-directory: ./doc
    steps:
      - name: Checkout
        uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - name: Setup Pages
        uses: actions/configure-pages@v4

      - name: Install dependencies
        run: npm install

      - name: Build with VitePress
        run: npm run docs:build
        env:
          GITHUB_PAGES: true

      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: ./doc/docs/.vitepress/dist

  # Deploy job
  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    needs: build
    runs-on: ubuntu-latest
    name: Deploy
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4