ci-frontend.yml

name: Frontend Checks

on:
  workflow_call:
  pull_request:
    paths:
      - frontend/**
      - .github/workflows/ci-frontend.yml

defaults:
  run:
    working-directory: ./frontend

env:
  NODE_VERSION: 18
  LOCKFILE_PATH: ./frontend/package-lock.json # or yarn.lock
  PACKAGE_MANAGER: npm # or yarn

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

jobs:
  tests:
    name: FE Lint, Type Check, Format & Tests
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: ${{ env.NODE_VERSION }}
          cache-dependency-path: ${{ env.LOCKFILE_PATH }}
          cache: ${{ env.PACKAGE_MANAGER }}
      - run: npm ci

      - name: Run lint
        run: npm run lint

      - name: Run type check
        run: npm run ts:check

      - name: Run format
        run: npm run format-check

      - run: npm run test -- --testLocationInResults --json --outputFile=coverage/report.json
      - uses: ArtiomTr/jest-coverage-report-action@v2
        with:
          coverage-file: coverage/report.json
          test-script: npm test
          working-directory: ./frontend
          annotations: ${{ github.event.pull_request.head.repo.full_name == github.event.repository.name && 'failed-tests' || 'none' }}
          package-manager: npm
          icons: emoji
          skip-step: none
          output: ${{ github.event.pull_request.head.repo.full_name == github.event.repository.name && 'comment' || 'report-markdown' }}

  # Confirms the front end still builds successfully
  check-frontend-builds:
    name: FE Build Check
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: ${{ env.NODE_VERSION }}
          cache-dependency-path: ${{ env.LOCKFILE_PATH }}
          cache: ${{ env.PACKAGE_MANAGER }}

      # https://nextjs.org/docs/advanced-features/ci-build-caching
      - uses: actions/cache@v4
        with:
          path: |
            ~/.npm
            ${{ github.workspace }}/frontend/.next/cache
          # Generate a new cache whenever packages or source files change.
          key: ${{ runner.os }}-nextjs-${{ hashFiles('**/package-lock.json') }}-${{ hashFiles('**.[jt]s', '**.[jt]sx') }}
          # If source files changed but packages didn't, rebuild from a prior cache.
          restore-keys: |
            ${{ runner.os }}-nextjs-${{ hashFiles('**/package-lock.json') }}-

      - run: npm ci
      - run: npm run build -- --no-lint

  # Confirms Storybook still builds successfully
  check-storybook-builds:
    name: FE Storybook Build Check
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: ${{ env.NODE_VERSION }}
          cache-dependency-path: ${{ env.LOCKFILE_PATH }}
          cache: ${{ env.PACKAGE_MANAGER }}
      - run: npm ci
      - run: npm run storybook-build