test.yaml

name: Test

on:
  pull_request:

  push:
    branches:
      - 'feature/**'
      - 'v[0-9]'

  workflow_call:
    inputs:
      upload-artifact:
        default: false
        required: false
        type: boolean

  workflow_dispatch:
    inputs:
      runner:
        description: Run tests on
        type: choice
        default: ubuntu-latest
        options:
          - macos-latest
          - ubuntu-latest
          - windows-latest

jobs:
  build:
    name: Build
    runs-on: ${{ github.event.inputs.runner || 'ubuntu-latest' }}

    steps:
      - name: Checkout code
        uses: actions/checkout@v4.1.0

      - name: Restore build
        uses: actions/cache@v3.3.2
        id: build-cache

        with:
          key: build-cache-${{ runner.os }}-${{ github.sha }}
          path: deploy/public

      - name: Setup Node.js
        uses: actions/setup-node@v3.8.1
        if: steps.build-cache.outputs.cache-hit != 'true'

        with:
          cache: npm
          node-version-file: .nvmrc

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

      - name: Build
        if: steps.build-cache.outputs.cache-hit != 'true'
        run: npm run build

        # Share data between the build and deploy jobs so we don't need to run `npm run build` again on deploy
        # Upload the deploy folder as an artifact so it can be downloaded and used in the deploy job
      - name: Upload artifact
        uses: actions/upload-artifact@v3.1.3
        if: ${{ inputs.upload-artifact }}
        with:
          name: build
          path: deploy/**
          retention-days: 1

  test:
    name: ${{ matrix.task.description }}
    runs-on: ${{ github.event.inputs.runner || 'ubuntu-latest' }}
    needs: [build]

    strategy:
      fail-fast: false

      matrix:
        task:
          - description: Lint Sass
            run: npm run lint:scss

          - description: Lint JavaScript
            run: npm run lint:js

          - description: Lint HTML
            run: npm run lint:html --ignore-scripts

          - description: EditorConfig
            run: npm run lint:editorconfig

          - description: Prettier
            run: npm run lint:prettier
            continue-on-error: true

          - description: JavaScript tests
            run: npx jest --color --maxWorkers=2

          - description: Check broken links
            run: npm run check-links

    steps:
      - name: Checkout
        uses: actions/checkout@v4.1.0

      - name: Setup Node.js
        uses: actions/setup-node@v3.8.1
        with:
          cache: npm
          node-version-file: .nvmrc

      - name: Install dependencies
        run: npm ci

      - name: Restore build
        uses: actions/cache/restore@v3.3.2
        with:
          key: build-cache-${{ runner.os }}-${{ github.sha }}
          path: deploy/public

      - name: Run task
        id: task
        run: ${{ matrix.task.run }}
        continue-on-error: ${{ matrix.task.continue-on-error || false }}

      - name: Task warnings
        if: steps.task.outcome == 'failure'
        run: echo "::warning title=${{ matrix.task.description }} task failed::Check has been temporarily ignored"