deploy.yml

# Sample workflow for building and deploying a VitePress site to GitHub Pages

name: 🚀 Deploy Documentation

on:
  # Runs on pushes targeting the `main` branch. Change this to `master` if you're
  # using the `master` branch as the default branch.
  push:
    branches: [master]

  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

# Sets pins 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
    name: 🏗️ Build
    steps:
      - name: 🛒 Checkout
        uses: actions/checkout@v4

      - name: ⚙️  Action Setup
        uses: pnpm/action-setup@v2
        with:
          version: 8

      - name: 📐 Package Setup
        uses: actions/setup-node@v4
        with:
          node-version: 18
          cache: "pnpm"

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

      - name: 📦 Install dependencies
        run: pnpm install --frozen-lockfile

      - name: 🫸  Build with VitePress
        run: |
          pnpm build
          touch .vitepress/dist/.nojekyll

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

  # Deployment 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@v2