deploy-pages.yml

# Simple workflow for deploying static content to GitHub Pages
name: Deploy docs to Pages

on:
  # Runs on pushes targeting the default branch
  push:
    branches: ["main"]

  # 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

# 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:
  # Build job
  build:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout
        uses: apperry/action-cached-lfs-checkout@c0616236fe56259b047ba97925bad9d8b644be88

      - name: Setup Node.js environment
        uses: actions/setup-node@v4.0.0
        with:
          node-version: "18"
          cache: "yarn"

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

      - name: Install dependencies
        run: yarn install

      - name: Build
        run: yarn run docs:build

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

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