Skip to content

Lighthouse CI

GitHub App

Lighthouse CI

GitHub App

Lighthouse CI posts the results of your Lighthouse runs in CI to PRs as separate status checks.

screenshot of GitHub status checks for Lighthouse CI

Quick Start

  1. Copy the token provided on the authorization confirmation page and add it to your build environment as LHCI_GITHUB_APP_TOKEN.
  2. Run Lighthouse CI in your build environment and configure an upload target (temporary-public-storage is free to use and provides publicly accessible links to your Lighthouse reports from the "Details" links in GitHub).
  3. Stay off the rocks with Lighthouse in your CI! ⛰ 🔦 🚢

.github/workflows/ci.yml

name: CI
on: [push]
jobs:
  lighthouseci:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: actions/setup-node@v1
      - run: npm install && npm install -g @lhci/cli@0.6.x
      - run: npm run build
      - run: lhci autorun
        env:
          LHCI_GITHUB_APP_TOKEN: ${{ secrets.LHCI_GITHUB_APP_TOKEN }}

Documentation

Developer

Lighthouse CI is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.

Report abuse