ci.yml

name: CI

on:
  push:
    branches:
      - 'master'
  pull_request:

jobs:
  test:
    name: Lint & Test
    runs-on: ubuntu-latest
    env:
      CI: true
    strategy:
      matrix:
        node: [18]
    steps:
      - name: Checkout
        uses: actions/checkout@v3

      - name: Setup environment
        id: setup
        run: |-
          echo "npm-cache-dir=$(npm config get cache)" >> ${GITHUB_OUTPUT}

      - name: Setup Node ${{ matrix.node }}
        uses: actions/setup-node@master
        with:
          node-version: ${{ matrix.node }}
          check-latest: true

      # TODO: this does work (it'll find the cache) but it appears it's not putting the cache
      #  back into ./node_modules because skipping the install step results in subsequent
      #  steps failing with messages like `prettier not found`, which implies there's no
      #  node_modules directory there with Prettier installed in it...
      #
      # - name: NPM cache check
      #   uses: actions/cache@v3
      #   id: npm-cache
      #   with:
      #     path: ${{ steps.setup.outputs.npm-cache-dir }}
      #     key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
      #     restore-keys: |
      #       ${{ runner.os }}-node-

      - name: Install packages
        # if: steps.npm-cache.outputs.cache-hit != 'true'
        run: npm ci

      - name: Lint
        run: |-
          npm run format:check;
          npm run lint;

      - name: Test
        run: |-
          npm run test:coverage;
          npm run test:types;

      - name: Upload coverage to Codecov
        # https://github.com/marketplace/actions/codecov
        uses: codecov/codecov-action@v2

      - name: Build # Tests to see if a build can succeed
        run: npm run build

  e2e:
    runs-on: ubuntu-22.04
    strategy:
      matrix:
        browser: [chrome, firefox]
    timeout-minutes: 20
    container:
      # https://hub.docker.com/r/cypress/browsers/tags
      # NOTE: at least Chrome 102 is required for testing `inert` attribute support
      image: cypress/browsers:node18.12.0-chrome106-ff106
      options: --user 1001 --shm-size=2g # @see https://github.com/cypress-io/github-action/issues/104#issuecomment-666047965
    steps:
      - name: Checkout
        uses: actions/checkout@v3

      - name: Test E2E
        # https://github.com/cypress-io/github-action
        # https://github.com/cypress-io/code-coverage
        uses: cypress-io/github-action@v5 # will run all tests found per cypress.config.js
        with:
          start: npm run start
          browser: ${{ matrix.browser }}