pr-checks.yml

# Runs on every pull request:
#   1. biome   – lint + format check (fails fast; annotates changed lines in the PR diff)
#   2. vitest  – unit/integration tests with coverage (posts a summary comment on the PR)
#   3. playwright – e2e tests (uploads an HTML report as an artifact; posts a pass/fail comment)
#
# Required repository permissions (already granted to GITHUB_TOKEN by default for
# non-fork PRs; no extra secrets needed):
#   • contents: read
#   • pull-requests: write

name: PR Checks

on:
  pull_request:
    branches:
      - main      # adjust if your default branch is named differently
      - master

# Cancel any in-progress run for the same PR branch so pushes don't queue up.
concurrency:
  group: pr-checks-${{ github.head_ref }}
  cancel-in-progress: true

jobs:
  # ─────────────────────────────────────────────
  # Job 1 · Biome – lint & format
  # ─────────────────────────────────────────────
  biome:
    name: Biome (lint + format)
    runs-on: ubuntu-latest
    permissions:
      contents: read
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      # biomejs/setup-biome installs the exact version declared in your
      # package.json / biome.json. Pin to "latest" to always use the newest
      # release, or pin to a semver string for reproducibility.
      - name: Setup Biome
        uses: biomejs/setup-biome@v2
        with:
          version: latest

      # `biome ci` is the recommended command for CI:
      #   • exits non-zero on any lint/format error
      #   • emits GitHub annotations so errors appear inline in the PR diff
      #   • never auto-fixes (safe for CI)
      - name: Run Biome CI
        run: biome ci .

  # ─────────────────────────────────────────────
  # Job 2 · Vitest – unit & integration tests
  # ─────────────────────────────────────────────
  vitest:
    name: Vitest (unit tests + coverage)
    runs-on: ubuntu-latest
    permissions:
      contents: read
      pull-requests: write  # needed to post the coverage comment
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Setup Node.js
        uses: actions/setup-node@v4
        with:
          node-version: lts/*
          cache: npm

      - name: Install dependencies
        run: npm ci

      # Run Vitest with coverage enabled.
      # Your vitest.config.ts should include at minimum:
      #
      #   coverage: {
      #     provider: 'v8',          // or 'istanbul'
      #     reporter: ['text', 'json-summary', 'json'],
      #   }
      #
      # The `json-summary` reporter is required by vitest-coverage-report-action.
      # The `json` reporter enables per-file coverage detail in the PR comment.
      - name: Run tests with coverage
        run: npx vitest run --coverage

      # Upload the coverage directory so the reporting step can consume it.
      - name: Upload coverage artifact
        if: always()
        uses: actions/upload-artifact@v4
        with:
          name: vitest-coverage
          path: coverage/
          retention-days: 7

      # Post (or update) a coverage summary comment directly on the PR.
      # Uses: https://github.com/davelosert/vitest-coverage-report-action
      - name: Report coverage on PR
        if: always()
        uses: davelosert/vitest-coverage-report-action@v2
        with:
          github-token: ${{ secrets.GITHUB_TOKEN }}
          json-summary-path: coverage/coverage-summary.json
          json-final-path: coverage/coverage-final.json

  # ─────────────────────────────────────────────
  # Job 3 · Playwright – end-to-end tests
  # ─────────────────────────────────────────────
  playwright:
    name: Playwright (e2e)
    runs-on: ubuntu-latest
    permissions:
      contents: read
      pull-requests: write  # needed to post the test-result comment
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Setup Node.js
        uses: actions/setup-node@v4
        with:
          node-version: lts/*
          cache: npm

      - name: Install dependencies
        run: npm ci

      # Install Playwright's browser binaries + OS-level dependencies.
      # Remove browsers you don't need to speed up the job.
      - name: Install Playwright browsers
        run: npx playwright install --with-deps chromium firefox webkit

      # Build the Next.js app before running e2e tests.
      # Remove this step if your Playwright config handles the dev server itself
      # via the `webServer` option (recommended for most setups).
      - name: Build Next.js app
        run: npm run build

      # Run Playwright. The `json` reporter writes results.json which is
      # consumed by the PR-comment action below.
      # Your playwright.config.ts reporter array should include:
      #   reporter: [['html'], ['json', { outputFile: 'results.json' }]]
      - name: Run Playwright tests
        run: npx playwright test --reporter=html,json
        env:
          # Ensure Playwright writes the JSON report to the project root.
          PLAYWRIGHT_JSON_OUTPUT_NAME: results.json

      # Always upload the HTML report so you can inspect failures even when
      # the job is marked red.
      - name: Upload Playwright HTML report
        if: always()
        uses: actions/upload-artifact@v4
        with:
          name: playwright-report
          path: playwright-report/
          retention-days: 14

      # Post (or update) a pass/fail summary comment on the PR.
      # Uses: https://github.com/daun/playwright-report-summary
      - name: Post Playwright results to PR
        if: always()
        uses: daun/playwright-report-summary@v4
        with:
          github-token: ${{ secrets.GITHUB_TOKEN }}
          report-file: results.json