super-productivity/.github/workflows/ci.yml

name: CI
on:
  pull_request:
    branches:
      - master
      - main
    paths-ignore:
      - 'docs/wiki/**'
  workflow_dispatch:
    inputs: {}
  release:
    types: [published]
permissions:
  contents: read

jobs:
  # Verify package-lock.json only uses the official npm registry.
  # Prevents contributors using mirror registries from rewriting all resolved URLs.
  check-lockfile-registry:
    name: Check package-lock.json registry
    runs-on: ubuntu-latest
    if: github.event_name == 'pull_request'
    steps:
      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
        with:
          persist-credentials: false
      - name: Reject non-standard registry URLs
        run: |
          BAD_COUNT=$(grep '"resolved": "https\?://' package-lock.json | grep -cv 'registry.npmjs.org' || true)
          if [ "$BAD_COUNT" -gt 0 ]; then
            echo "::error::package-lock.json contains $BAD_COUNT resolved URLs pointing to a non-standard registry."
            echo "Examples:"
            grep '"resolved": "https\?://' package-lock.json | grep -v 'registry.npmjs.org' | head -5
            echo ""
            echo "Please delete node_modules and package-lock.json, then run 'npm install' with the default registry (https://registry.npmjs.org/)."
            exit 1
          fi

  # This job will scan dependency manifest files
  # surfacing known-vulnerable versions of the packages declared or updated.
  # Only runs on pull_request events as the action requires base/head refs
  dependency-vulnerability-review:
    name: Dependency Vulnerability Review
    runs-on: ubuntu-latest
    if: github.event_name == 'pull_request'
    steps:
      - name: 'Checkout Repository'
        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
        with:
          persist-credentials: false
      # work around for npm installs from git+https://github.com/johannesjo/J2M.git
      - name: Reconfigure git to use HTTP authentication
        run: >
          git config --global url."https://github.com/".insteadOf
          ssh://git@github.com/

      - name: 'Dependency Review'
        uses: actions/dependency-review-action@2031cfc080254a8a887f58cffee85186f0e49e48 # v4

  lint:
    name: Lint
    runs-on: ubuntu-latest
    steps:
      - uses: actions/setup-node@53b83947a5a98c8d113130e565377fae1a50d02f # v6
        with:
          node-version: 22
      - name: Check out Git repository
        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
        with:
          persist-credentials: false
      - name: Install npm Packages
        run: npm i
      - run: npm run lint

  test-on-linux:
    name: Tests
    runs-on: ubuntu-latest
    needs: [lint, dependency-vulnerability-review]
    if: ${{ !cancelled() && !failure() }}
    steps:
      - uses: actions/setup-node@53b83947a5a98c8d113130e565377fae1a50d02f # v6
        with:
          node-version: 22
      - name: Check out Git repository
        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
        with:
          persist-credentials: false
      # work around for npm installs from git+https://github.com/johannesjo/J2M.git
      - name: Reconfigure git to use HTTP authentication
        run: >
          git config --global url."https://github.com/".insteadOf
          ssh://git@github.com/
      - name: Get npm cache directory
        id: npm-cache-dir
        run: |
          echo "dir=$(npm config get cache)" >> $GITHUB_OUTPUT
      - uses: actions/cache@668228422ae6a00e4ad889ee87cd7109ec5666a7 # v5
        id: npm-cache # use this to check for `cache-hit` ==> if: steps.npm-cache.outputs.cache-hit != 'true'
        with:
          path: ${{ steps.npm-cache-dir.outputs.dir }}
          key: ${{ runner.os }}-node22-${{ hashFiles('**/package-lock.json') }}
          restore-keys: |
            ${{ runner.os }}-node22-
      - name: Install npm Packages
        run: npm i
      - name: Install Playwright Browsers
        run: |
          npx playwright install --with-deps chromium
          npx playwright install-deps chromium
      - run: npm run env # Generate env.generated.ts from environment variables
      - run: npm run int:test # Validate i18n JSON files
      - run: npm run test
      - name: Build Frontend for E2E
        run: npm run buildFrontend:e2e
      - name: Verify Build Output
        run: |
          test -f .tmp/angular-dist/browser/index.html || (echo "Build output missing" && exit 1)
          test -f .tmp/angular-dist/browser/assets/bundled-plugins/api-test-plugin/manifest.json || (echo "Plugin assets missing from build" && exit 1)
      - name: Test E2E
        run: npm run e2e:ci
      - name: 'Upload E2E results on failure'
        if: ${{ failure() }}
        uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0
        with:
          name: e2eResults
          path: .tmp/e2e-test-results/**/*.*
          retention-days: 14

  # Lighthouse is designed to audit the performance, accessibility, SEO, and other metrics of a web application.
  lighthouse:
    name: Lighthouse
    runs-on: ubuntu-latest
    env:
      UNSPLASH_KEY: ${{ secrets.UNSPLASH_KEY }}
      UNSPLASH_CLIENT_ID: ${{ secrets.UNSPLASH_CLIENT_ID }}
    steps:
      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6

      - uses: actions/setup-node@53b83947a5a98c8d113130e565377fae1a50d02f # v6
        with:
          node-version: 22
          cache: 'npm'

      - name: Install dependencies
        run: npm i

      - run: npm run env # Generate env.generated.ts

      - name: Build production web app
        run: npm run buildFrontend:prodWeb

      - name: Add swap space for Lighthouse
        run: |
          # Ensure Lighthouse/Chrome have enough memory on GitHub-hosted runners
          # Remove existing swapfile if present
          sudo swapoff /swapfile 2>/dev/null || true
          sudo rm -f /swapfile
          sudo fallocate -l 4G /swapfile
          sudo chmod 600 /swapfile
          sudo mkswap /swapfile
          sudo swapon /swapfile

      - name: Strip service worker artifacts for Lighthouse
        run: rm -f dist/browser/ngsw.json dist/browser/ngsw-worker.js dist/browser/safety-worker.js dist/browser/worker-basic.min.js

      - name: Run Lighthouse CI
        uses: treosh/lighthouse-ci-action@3e7e23fb74242897f95c0ba9cabad3d0227b9b18 # v12
        with:
          # Configure Lighthouse CI
          configPath: './tools/lighthouse/.lighthouserc.json'
          # Upload results to temporary storage
          uploadArtifacts: true
          temporaryPublicStorage: true
          # Run once to avoid long Chrome sessions on CI
          runs: 1
          # Configure budgets
          budgetPath: './tools/lighthouse/budget.json'