docs.yml

name: Docs

# Builds the VitePress docs on every PR (clean-build verification) and
# deploys to GitHub Pages on release / dispatch / workflow_call. The
# cadence is "deploy on release," not "deploy on every commit."
#
# Triggers:
#   pull_request    — build only (no deploy), to verify the site still
#                     builds when docs change.
#   release         — covers manually-created GitHub Releases. Releases
#                     created by monorel via GITHUB_TOKEN don't propagate
#                     this event (GitHub anti-recursion); those flow
#                     through workflow_call from release.yml's deploy-docs
#                     job.
#   workflow_dispatch — manual escape hatch.
#   workflow_call   — invoked from release.yml after a monorel-driven
#                     release is cut.

on:
  pull_request:
    branches: [main]
    paths:
      - 'docs/**'
      - '.github/workflows/docs.yml'
  release:
    types: [published]
  workflow_dispatch:
  workflow_call:

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

concurrency:
  group: pages
  cancel-in-progress: false

jobs:
  build:
    name: Build
    runs-on: ubuntu-latest
    defaults:
      run:
        working-directory: docs
    steps:
      - uses: actions/checkout@v4

      - name: Set up Bun
        uses: oven-sh/setup-bun@v2
        with:
          bun-version: latest

      - name: Install dependencies
        run: bun install --frozen-lockfile

      - name: Build site
        run: bun run docs:build

      - name: Upload pages artifact
        if: github.event_name != 'pull_request'
        uses: actions/upload-pages-artifact@v3
        with:
          path: docs/.vitepress/dist

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