lighthouse.yml

name: Lighthouse

on:
  push:
  pull_request:
  schedule:
    - cron: '0 10 * * 0' # run at 10 AM UTC on Sunday

# This allows a subsequently queued workflow run to interrupt previous runs
concurrency:
  group: '${{ github.workflow }} @ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }}'
  cancel-in-progress: true

jobs:
  build-plugin:
    name: Build plugin
    runs-on: ubuntu-latest
    if: startsWith( github.repository, 'elementor/' )
    steps:
      - name: Checkout source code
        uses: actions/checkout@v3
      - name: Install Node.js 18.x
        uses: actions/setup-node@v2
        with:
          node-version: 18.x
      - name: Cache node modules
        uses: actions/cache@v2
        env:
          cache-name: cache-node-modules
        with:
          path: ~/.npm
          key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
          restore-keys: |
            ${{ runner.os }}-build-${{ env.cache-name }}-
            ${{ runner.os }}-build-
            ${{ runner.os }}-
      - name: Install dependencies
        run: npm ci
      - name: Build
        run: npx grunt build
      - name: Save build to cache
        uses: actions/cache@v2
        id: restore-build
        with:
          path: ./build/*
          key: ${{ github.sha }}

  lighthouse:
    name: Lighthouse test - WP ${{ matrix.wpCoreVersion }} on PHP ${{ matrix.phpVersion }}
    runs-on: ubuntu-latest
    needs: [build-plugin]
    strategy:
      matrix:
        include:
          - phpVersion: '8.0'
            wpCoreVersion: 'master'
          - phpVersion: '7.4'
            wpCoreVersion: 'latest'
    steps:
      - name: Checkout source code
        if: matrix.wpCoreVersion != 'master' || github.event_name == 'schedule'
        uses: actions/checkout@v3
      - name: Install Node.js 18.x
        if: matrix.wpCoreVersion != 'master' || github.event_name == 'schedule'
        uses: actions/setup-node@v2
        with:
          node-version: 18.x
      - name: Restore build from cache
        if: matrix.wpCoreVersion != 'master' || github.event_name == 'schedule'
        uses: actions/cache@v2
        id: restore-build
        with:
          path: ./build/*
          key: ${{ github.sha }}
      - name: Run wp-env
        if: matrix.wpCoreVersion != 'master' || github.event_name == 'schedule'
        uses: ./.github/workflows/run-wp-env
        with:
          TEMPLATES: './tests/lighthouse/templates'
          PHP_VERSION: ${{ matrix.phpVersion }}
          WP_CORE_VERSION: ${{ matrix.wpCoreVersion }}
      - name: Install lhci
        if: matrix.wpCoreVersion != 'master' || github.event_name == 'schedule'
        run: |
          npm ci
          npm install --no-package-lock --no-save @lhci/cli@0.11.1
      - name: WordPress debug information
        if: matrix.wpCoreVersion != 'master' || github.event_name == 'schedule'
        run: |
          npx wp-env run cli "wp core version"
          npx wp-env run cli "wp --info"
      - name: Run Lighthouse tests
        if: matrix.wpCoreVersion != 'master' || github.event_name == 'schedule'
        run: |
          bash "${GITHUB_WORKSPACE}/.github/scripts/run-lighthouse-tests.sh"
      - name: Save HTML dumps on failure
        if: failure() || matrix.wpCoreVersion != 'master' || github.event_name == 'schedule'
        run: |
          bash "${GITHUB_WORKSPACE}/.github/scripts/save-lighthouse-pages-html-dumps.sh"
      - name: Upload Lighthouse reports on failure
        if: failure() || matrix.wpCoreVersion != 'master' || github.event_name == 'schedule'
        uses: actions/upload-artifact@v2
        with:
          name: lighthouseci-reports
          path: ${{ github.workspace }}/.lighthouseci/reports/**/*
          retention-days: 7
      - name: Upload Lighthouse HTML dumps on failure
        if: failure() || matrix.wpCoreVersion != 'master' || github.event_name == 'schedule'
        uses: actions/upload-artifact@v2
        with:
          name: lighthouseci-htmls
          path: ${{ github.workspace }}/.lighthouseci/dumps/**/*
          retention-days: 7
      - name: Notify slack on failure
        if: failure() && github.event_name == 'schedule'
        env:
          SLACK_TOKEN: ${{ secrets.SLACK_TOKEN }}
          SLACK_CHANNEL: ${{ secrets.SLACK_LIGHTHOUSE_CHANNEL }}
          SLACK_BOT_NAME: ElementorBot
        run: |
          MESSAGE_TEXT="@channel Repo: *$GITHUB_REPOSITORY* Workflow: *$GITHUB_WORKFLOW* is FAILED - <$GITHUB_SERVER_URL/$GITHUB_REPOSITORY/actions/runs/$GITHUB_RUN_ID|link>"
          curl -X POST "https://slack.com/api/chat.postMessage" -d "username=${SLACK_BOT_NAME}&token=${SLACK_TOKEN}&channel=${SLACK_CHANNEL}&text=${MESSAGE_TEXT}&link_names=true"