deploy.yml

name: Deploy Documentation Site to GitHub Pages

on:
  push:
    branches:
      - main

  workflow_dispatch:

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

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

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

      - name: Setup Node
        uses: actions/setup-node@v5
        with:
          node-version: "24"
          cache: npm

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

      - name: Restore Next.js cache
        uses: actions/cache@v5
        with:
          path: |
            .next/cache
          key: ${{ runner.os }}-nextjs-${{ hashFiles('**/package-lock.json') }}-${{ hashFiles('**.[jt]s', '**.[jt]sx') }}
          restore-keys: |
            ${{ runner.os }}-nextjs-${{ hashFiles('**/package-lock.json') }}-

      - name: Install dependencies
        run: npm ci

      # LikeC4 runs from the repo's own dependency rather than likec4/actions,
      # whose image pins Playwright 1.56.1 browsers and cannot run likec4 1.58+.
      # This supports manual layout snapshots rendering the same in CI as they do locally.
      - name: LikeC4 code generation
        run: npm run likec4:codegen

      - name: Install Playwright Chromium
        run: npx playwright install --with-deps chromium

      - name: LikeC4 PNG export
        run: npx likec4 export png likec4_src -o public/images/likec4

      # Must use `npm run build` (not `npx next build`) so the postbuild
      # Pagefind step runs and writes search assets into out/_pagefind.
      - name: Build static site
        run: npm run build

      - name: Verify Pagefind index
        run: test -f out/_pagefind/pagefind.js

      - name: Upload artifact
        uses: actions/upload-pages-artifact@v5
        with:
          path: out

  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@v5