pr.yml

name: PR

on:
  pull_request:

permissions:
  contents: read

jobs:
  detect-changes:
    runs-on: ubuntu-latest
    outputs:
      run_e2e: ${{ steps.e2e_changes.outputs.run_e2e }}
    steps:
      - name: Checkout
        uses: actions/checkout@v7.0.1
        with:
          fetch-depth: 0

      - name: Detect E2E-impacting changes
        id: e2e_changes
        env:
          BASE_SHA: ${{ github.event.pull_request.base.sha }}
          HEAD_SHA: ${{ github.event.pull_request.head.sha }}
        run: |
          changed_files="$(git diff --name-only "$BASE_SHA" "$HEAD_SHA")"
          printf '%s\n' "$changed_files"

          if printf '%s\n' "$changed_files" | grep -Eq '^(src/|tests/e2e/|docker/|docker-compose\.screenshots\.yml$|manifest\.(chromium|firefox)\.json$|package\.json$|pnpm-lock\.yaml$|playwright\.config\.ts$|vite(\.background)?\.config\.ts$|scripts/(firefox-e2e|firefox-screenshots|lib/))'; then
            echo "run_e2e=true" >> "$GITHUB_OUTPUT"
          else
            echo "run_e2e=false" >> "$GITHUB_OUTPUT"
          fi

  license:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v7.0.1

      - name: License validator
        uses: './.github/actions/license'

  lint:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v7.0.1

      - name: Setup pnpm
        uses: pnpm/action-setup@v6
        with:
          version: 10.10.0

      - name: Setup Node
        uses: actions/setup-node@v7.1.0
        with:
          node-version: 20
          cache: 'pnpm'

      - name: Install dependencies
        run: pnpm install --frozen-lockfile
        shell: bash

      - name: ESLint
        uses: './.github/actions/eslint'

      - name: Stylelint
        uses: './.github/actions/stylelint'

  typescript:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v7.0.1
        with:
          fetch-depth: 0

      - name: Detect TypeScript-impacting changes
        id: typescript_changes
        env:
          BASE_SHA: ${{ github.event.pull_request.base.sha }}
          HEAD_SHA: ${{ github.event.pull_request.head.sha }}
        run: |
          changed_files="$(git diff --name-only "$BASE_SHA" "$HEAD_SHA")"
          printf '%s\n' "$changed_files"

          if printf '%s\n' "$changed_files" | grep -Eq '^(src/|package\.json$|pnpm-lock\.yaml$|tsconfig\.json$|vite\.config\.ts$|vitest\.config\.ts$|\.github/actions/typescript/)'; then
            echo "run_typescript=true" >> "$GITHUB_OUTPUT"
          else
            echo "run_typescript=false" >> "$GITHUB_OUTPUT"
          fi

      - name: Skip TypeScript
        if: steps.typescript_changes.outputs.run_typescript != 'true'
        run: echo "Skipping TypeScript because this PR does not change TypeScript inputs."

      - name: TypeScript
        if: steps.typescript_changes.outputs.run_typescript == 'true'
        uses: './.github/actions/typescript'

  unit-tests:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v7.0.1
        with:
          fetch-depth: 0

      - name: Detect unit-test-impacting changes
        id: unit_changes
        env:
          BASE_SHA: ${{ github.event.pull_request.base.sha }}
          HEAD_SHA: ${{ github.event.pull_request.head.sha }}
        run: |
          changed_files="$(git diff --name-only "$BASE_SHA" "$HEAD_SHA")"
          printf '%s\n' "$changed_files"

          if printf '%s\n' "$changed_files" | grep -Eq '^(src/|tests/|package\.json$|pnpm-lock\.yaml$|tsconfig\.json$|vite\.config\.ts$|vitest\.config\.ts$)'; then
            echo "run_unit_tests=true" >> "$GITHUB_OUTPUT"
          else
            echo "run_unit_tests=false" >> "$GITHUB_OUTPUT"
          fi

      - name: Skip unit tests
        if: steps.unit_changes.outputs.run_unit_tests != 'true'
        run: echo "Skipping unit tests because this PR does not change unit-test inputs."

      - name: Setup pnpm
        if: steps.unit_changes.outputs.run_unit_tests == 'true'
        uses: pnpm/action-setup@v6
        with:
          version: 10.10.0

      - name: Install dependencies
        if: steps.unit_changes.outputs.run_unit_tests == 'true'
        run: pnpm install --frozen-lockfile
        shell: bash

      - name: Run unit tests
        if: steps.unit_changes.outputs.run_unit_tests == 'true'
        run: pnpm test:unit
        shell: bash

      - name: Archive test results
        if: always() && steps.unit_changes.outputs.run_unit_tests == 'true'
        uses: actions/upload-artifact@v7.0.1
        with:
          name: test-results
          path: reports/unit/
          retention-days: 5

  pr-build:
    needs: [license, lint, typescript, unit-tests]
    runs-on: ubuntu-latest
    outputs:
      head_sha: ${{ steps.set_build_metadata.outputs.head_sha }}
      short_sha: ${{ steps.set_build_metadata.outputs.short_sha }}
      chrome_artifact: ${{ steps.set_build_metadata.outputs.chrome_artifact }}
      firefox_artifact: ${{ steps.set_build_metadata.outputs.firefox_artifact }}
      firefox_sources_artifact: ${{ steps.set_build_metadata.outputs.firefox_sources_artifact }}
    steps:
      - name: Checkout
        uses: actions/checkout@v7.0.1

      - name: Setup pnpm
        uses: pnpm/action-setup@v6
        with:
          version: 10.10.0

      - name: Install dependencies
        run: pnpm install --frozen-lockfile
        shell: bash

      - name: Set build metadata
        id: set_build_metadata
        run: |
          HEAD_SHA="${{ github.event.pull_request.head.sha }}"
          SHORT_SHA="$(echo "$HEAD_SHA" | cut -c1-7)"

          echo "head_sha=$HEAD_SHA" >> "$GITHUB_OUTPUT"
          echo "short_sha=$SHORT_SHA" >> "$GITHUB_OUTPUT"
          echo "chrome_artifact=cloudhood-chrome-$HEAD_SHA" >> "$GITHUB_OUTPUT"
          echo "firefox_artifact=cloudhood-firefox-$HEAD_SHA" >> "$GITHUB_OUTPUT"
          echo "firefox_sources_artifact=cloudhood-firefox-sources-$HEAD_SHA" >> "$GITHUB_OUTPUT"

      - name: Build Chrome extension
        run: pnpm build:chromium
        shell: bash

      - name: Check Chrome build
        run: pnpm check:chrome-build
        shell: bash

      - name: Pack Chrome build folder to ZIP-file
        run: |
          cd build/chrome
          zip -r ../../cloudhood-chrome-${{ steps.set_build_metadata.outputs.short_sha }}.zip .

      - name: Build Firefox extension
        env:
          FIREFOX_EXTENSION_ID: ${{ vars.FIREFOX_EXTENSION_ID }}
        run: pnpm build:firefox
        shell: bash

      - name: Check Firefox build
        env:
          FIREFOX_EXTENSION_ID: ${{ vars.FIREFOX_EXTENSION_ID }}
        run: pnpm check:firefox-build
        shell: bash

      - name: Pack Firefox build folder to ZIP-file
        run: |
          cd build/firefox
          zip -r ../../cloudhood-firefox-${{ steps.set_build_metadata.outputs.short_sha }}.zip .

      - name: Build Firefox sources ZIP-file
        run: pnpm run build:firefox-sources
        shell: bash

      - name: Rename Firefox sources ZIP-file
        run: mv cloudhood-firefox-sources.zip cloudhood-firefox-sources-${{ steps.set_build_metadata.outputs.short_sha }}.zip

      - name: Upload Chrome build artifact
        uses: actions/upload-artifact@v7.0.1
        with:
          name: ${{ steps.set_build_metadata.outputs.chrome_artifact }}
          path: cloudhood-chrome-${{ steps.set_build_metadata.outputs.short_sha }}.zip
          retention-days: 14

      - name: Upload Firefox build artifact
        uses: actions/upload-artifact@v7.0.1
        with:
          name: ${{ steps.set_build_metadata.outputs.firefox_artifact }}
          path: cloudhood-firefox-${{ steps.set_build_metadata.outputs.short_sha }}.zip
          retention-days: 14

      - name: Upload Firefox sources artifact
        uses: actions/upload-artifact@v7.0.1
        with:
          name: ${{ steps.set_build_metadata.outputs.firefox_sources_artifact }}
          path: cloudhood-firefox-sources-${{ steps.set_build_metadata.outputs.short_sha }}.zip
          retention-days: 14

  e2e-test:
    runs-on: ubuntu-latest
    needs: [pr-build, detect-changes]
    if: needs.detect-changes.outputs.run_e2e == 'true'
    strategy:
      fail-fast: false
      matrix:
        include:
          - name: chrome-functional
            browser: chrome
            command: pnpm test:e2e:ci
          - name: firefox-functional
            browser: firefox
            command: pnpm test:e2e:firefox
          - name: chrome-screenshots
            browser: chrome
            command: pnpm test:e2e:screenshots:chrome
          - name: firefox-screenshots
            browser: firefox
            command: pnpm test:e2e:screenshots:firefox
    steps:
      - uses: actions/checkout@v7.0.1

      - name: Download Chrome build artifact
        if: matrix.browser == 'chrome'
        uses: actions/download-artifact@v8
        with:
          name: ${{ needs.pr-build.outputs.chrome_artifact }}

      - name: Extract Chrome extension
        if: matrix.browser == 'chrome'
        run: |
          mkdir -p build/chrome
          unzip -o cloudhood-chrome-${{ needs.pr-build.outputs.short_sha }}.zip -d build/chrome

      - name: Download Firefox build artifact
        if: matrix.browser == 'firefox'
        uses: actions/download-artifact@v8
        with:
          name: ${{ needs.pr-build.outputs.firefox_artifact }}

      - name: Extract Firefox extension
        if: matrix.browser == 'firefox'
        run: |
          mkdir -p build/firefox
          unzip -o cloudhood-firefox-${{ needs.pr-build.outputs.short_sha }}.zip -d build/firefox

      - name: Set up Docker Buildx
        uses: docker/setup-buildx-action@v3

      - name: Build Playwright screenshot image
        uses: docker/build-push-action@v6
        with:
          context: .
          file: docker/screenshots/Dockerfile
          tags: cloudhood-screenshots:latest
          load: true
          cache-from: type=gha,scope=screenshots
          cache-to: type=gha,mode=max,scope=screenshots

      - name: Run ${{ matrix.name }}
        run: docker compose -f docker-compose.screenshots.yml run --rm screenshots sh -lc "${{ matrix.command }}"

      - name: Upload test results
        if: always()
        uses: actions/upload-artifact@v7.0.1
        with:
          name: test-results-${{ matrix.name }}
          path: test-results/
          retention-days: 5
          if-no-files-found: ignore

  validate-build-artifacts:
    needs: [pr-build, e2e-test]
    if: always() && needs.pr-build.result == 'success' && (needs.e2e-test.result == 'success' || needs.e2e-test.result == 'skipped')
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v7.0.1

      - name: Download Chrome build artifact
        uses: actions/download-artifact@v8
        with:
          name: ${{ needs.pr-build.outputs.chrome_artifact }}
          path: dist/chrome

      - name: Download Firefox build artifact
        uses: actions/download-artifact@v8
        with:
          name: ${{ needs.pr-build.outputs.firefox_artifact }}
          path: dist/firefox

      - name: Download Firefox sources artifact
        uses: actions/download-artifact@v8
        with:
          name: ${{ needs.pr-build.outputs.firefox_sources_artifact }}
          path: dist/firefox-sources

      - name: Extract builds for release checks
        run: |
          mkdir -p build/chrome build/firefox
          unzip -o dist/chrome/cloudhood-chrome-${{ needs.pr-build.outputs.short_sha }}.zip -d build/chrome
          unzip -o dist/firefox/cloudhood-firefox-${{ needs.pr-build.outputs.short_sha }}.zip -d build/firefox

      - name: Check release builds
        env:
          FIREFOX_EXTENSION_ID: ${{ vars.FIREFOX_EXTENSION_ID }}
        run: node scripts/check-extension-builds.mjs