Indigo Tree LHCI

lighthouse.yml

# yaml-language-server: $schema=https://json.schemastore.org/github-workflow

name: Run Lighthouse checks
on:
  workflow_dispatch:
  push:
    branches:
      - main
  schedule:
    - cron: "12 2 * * *"

jobs:
  lighthouseci:
    name: Lighthouse
    runs-on: ubuntu-latest
    steps:
      - name: Delay execution on branch push
        if: github.event_name == 'push'
        run: sleep 300 # Sleep for 5 minutes (300 seconds)

      - uses: actions/checkout@v3

      - name: Setup Node JS
        uses: actions/setup-node@v3
        with:
          node-version: "16"
          cache: "npm"

      - name: Install Dependencies
        run: npm install -g @lhci/cli

      - name: Configure Lighthouse Settings (for scheduled and manual runs)
        if: github.event_name != 'push'
        run: |
          commit_hash=${{ github.sha }}
          trimmed_hash=${commit_hash:0:-5}
          random_chars=$(date +%s%N | sha256sum | base64 | head -c 4)
          modified_hash="${trimmed_hash}-${random_chars}"
          echo "LHCI_BUILD_CONTEXT__CURRENT_HASH=${modified_hash}" >> $GITHUB_ENV
          echo "LHCI_BUILD_CONTEXT__COMMIT_TIME=$(date -u +"%Y-%m-%dT%H:%M:%S.%3NZ")" >> $GITHUB_ENV
          echo "LHCI_BUILD_CONTEXT__COMMIT_MESSAGE='Daily run'" >> $GITHUB_ENV
          echo "LHCI_BUILD_CONTEXT__AUTHOR='LHCI Automation <paul.wong-gibbs@indigotree.co.uk>'" >> $GITHUB_ENV
          echo "LHCI_BUILD_CONTEXT__AVATAR_URL=paul.wong-gibbs@indigotree.co.uk" >> $GITHUB_ENV

      - name: Run Lighthouse CI
        run: lhci autorun --collect.url="https://example.com" --collect.url="https://example.com/about-us" --upload.token="$ITD_LHCI_TOKEN"
        env:
          LHCI_SERVER_BASE_URL: ${{ secrets.LHCI_SERVER_BASE_URL }}
          LHCI_BASIC_AUTH__USERNAME: ${{ secrets.LHCI_BASIC_AUTH__USERNAME }}
          LHCI_BASIC_AUTH__PASSWORD: ${{ secrets.LHCI_BASIC_AUTH__PASSWORD }}
          ITD_LHCI_TOKEN: ${{ secrets.ITD_LHCI_TOKEN }}

Replace https://example.com with the website to test. As I show in this example, if the --collect.url appears more than once, then it will check all those specific pages.