docs.yml

name: Deploy Docs

# Builds the VitePress documentation and deploys it to GitHub Pages on every
# push to master. Screenshots are committed to the repository, so this build
# never needs to launch the application.
#
# One-time setup: enable GitHub Pages with the "GitHub Actions" source under
# Settings -> Pages.
on:
  push:
    branches: [master]
  workflow_dispatch:

# Allow only one concurrent deployment.
concurrency:
  group: pages
  cancel-in-progress: false

permissions:
  contents: read
  pages: write
  id-token: write

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Setup Node.js
        uses: actions/setup-node@v4
        with:
          node-version: 20

      - name: Install dependencies
        run: npm install

      - name: Build docs
        run: npm run docs:build

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

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

  deploy:
    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@v4