reusable-e2e.yml

name: E2E
on:
  workflow_call:

env:
  E2E_DIR: projects/ngx-meta/e2e
  COVERAGE_DIR: coverage/ngx-meta
  # 👇 Keep in sync with example apps workflow
  COVERAGE_ARTIFACT_NAME_SUFFIX: -coverage
  # 👇 Keep in sync with example apps workflow
  EXAMPLE_APP_ARTIFACT_NAME_SUFFIX: -example-app
  # 👇 Keep in sync with e2e and coverage workflows
  COVERAGE_REPORT_ARTIFACT_NAME_SUFFIX: -coverage-report

jobs:
  load-config:
    name: Load CI/CD configuration
    runs-on: ubuntu-latest
    timeout-minutes: 5
    outputs:
      example-apps-version-aliases: ${{ steps.load-config.outputs.example-apps-version-aliases }}
    steps:
      - name: Checkout
        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
      - name: Load CI/CD configuration
        id: load-config
        uses: ./.github/actions/config

  e2e:
    name: E2E tests - Angular ${{ matrix.cli-version-alias }}
    needs: load-config
    runs-on: ubuntu-latest
    timeout-minutes: 5
    strategy:
      matrix:
        cli-version-alias: ${{ fromJSON(needs.load-config.outputs.example-apps-version-aliases) }}
    env:
      EXAMPLE_APP_DIR: projects/ngx-meta/example-apps/apps/${{ matrix.cli-version-alias }}
    defaults:
      run:
        working-directory: ${{ env.E2E_DIR }}
    steps:
      - name: Checkout
        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
      - name: Download example app with coverage instrumentation
        uses: actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16 # v4
        with:
          name: ngx-meta${{ env.EXAMPLE_APP_ARTIFACT_NAME_SUFFIX }}-${{ matrix.cli-version-alias }}${{ env.COVERAGE_ARTIFACT_NAME_SUFFIX }}
          path: ${{ env.EXAMPLE_APP_DIR }}
      - name: Setup pnpm
        uses: pnpm/action-setup@fe02b34f77f8bc703788d5817da081398fad5dd2 # v4.0.0
      - name: Setup Node.js
        uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4
        with:
          cache: pnpm
          cache-dependency-path: ${{ env.E2E_DIR }}/pnpm-lock.yaml
          node-version-file: .node-version # should be one compatible with Angular example app
      - name: Configure Cypress cache directory
        run: echo "CYPRESS_CACHE_FOLDER=$HOME/.cache/Cypress" >> "$GITHUB_ENV"
      - name: Cypress cache
        uses: actions/cache@1bd1e32a3bdc45362d1e726936510720a7c30a57 # v4
        env:
          cache-name: ngx-meta-e2e-cypress
          e2e_lockfile_hash: ${{ hashFiles(format('{0}/pnpm-lock.yaml', env.E2E_DIR)) }}
        with:
          path: ${{ env.CYPRESS_CACHE_FOLDER }}
          key: ${{ env.cache-name }}-${{ env.e2e_lockfile_hash }}
      - name: Install dependencies
        run: pnpm install --frozen-lockfile
      - name: Serve app
        run: pnpm run ci:serve &
        working-directory: ${{ env.EXAMPLE_APP_DIR }}
      - name: Cypress run
        uses: cypress-io/github-action@57b70560982e6a11d23d4b8bec7f8a487cdbb71b # v6.7.8
        env:
          COVERAGE_JSON_REPORT_NAME: e2e-${{ matrix.cli-version-alias }}.json
        with:
          working-directory: ${{ env.E2E_DIR }}
          browser: chrome
          # 👇 Action doesn't support pnpm caching right now
          # https://github.com/cypress-io/github-action/tree/v6.6.1?tab=readme-ov-file#pnpm
          # Given we're doing caching manually, installing apart to leverage cache
          install: false
      - name: Upload coverage report
        uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08 # v4
        if: failure() || success()
        with:
          name: ngx-meta-e2e-${{ matrix.cli-version-alias }}${{ env.COVERAGE_REPORT_ARTIFACT_NAME_SUFFIX }}
          path: ${{ env.COVERAGE_DIR }}/*.json
          retention-days: 5