pull-request-tests.yml

name: PR Tests

# Only run on non-draft PRs, and when PRs are synched
on:
  pull_request:
    types: [opened, reopened, ready_for_review, synchronize]
    # If the PR has other files, a push w/ just .md or /docs
    # files will still cause tests to run
    paths-ignore:
      - "**.md"
      - "docs/**"

jobs:
  build:
    if: github.event.pull_request.draft == false
    runs-on: ${{ matrix.os }}

    strategy:
      fail-fast: false
      matrix:
        os: [ubuntu-latest]
        node: [22, 24]

    steps:
      - uses: actions/checkout@v6
      - uses: actions/setup-node@v6
        with:
          node-version: ${{ matrix.node }}

      - name: Install Dependencies
        run: npm ci

      - name: Install Playwright Browsers
        run: npx playwright install --with-deps

      - name: Build
        run: npm run build

      # Generate doc to ensure that there are no warnings/errors
      - name: Generate TypeDoc
        run: npm run typedoc

      - name: Lint
        run: npm run lint

      - name: Test in CI
        run: npm run test:ci

      - name: Code Coverage Summary Report
        uses: irongut/CodeCoverageSummary@v1.3.0
        with:
          filename: coverage/**/cobertura-coverage.xml
          badge: true
          fail_below_min: true
          format: markdown
          output: both
          thresholds: "100 100"

      - name: Add Coverage PR Comment
        uses: marocchino/sticky-pull-request-comment@v3
        if: github.event_name == 'pull_request' && matrix.node == 22
        with:
          recreate: true
          path: code-coverage-results.md