foo-software / lighthouse-check-action

GitHub Action for running @GoogleChromeLabs Lighthouse audits with all the bells and whistles 🔔 Multiple audits, Slack notifications, and more!

Lighthouse Check Action

A GitHub Action for running Lighthouse audits automatically in CI workflows. Lighthouse Check Action provides simple configuration and a long list of features for advanced customization including Slack notifications, AWS S3 HTML report uploads, and more! Check out the docs to get started with advanced configurations or refer to the quick start section below.

Features

This project differs from others with its ease of use for simple cases and numerous features for advanced needs.

• ✨ Lighthouse audit multiple URLs or just one.
• 💬 PR comments of audit scores.
• 🎉 Save HTML reports locally.
• 💖 Upload HTML reports as artifacts.
• 🙌 Upload HTML reports to AWS S3.
• 🔥 Fail a workflow when minimum scores aren't met.
• 🛎️ Slack notifications with Git info (author, branch, PR, etc).
• 💎 Easily save a record of all your audits via Foo's free service.
• 🤗 Detailed documentation!

Quick Start

name: Lighthouse
on: [pull_request]

jobs:
  lighthouse:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@master
    - name: Lighthouse
      uses: foo-software/lighthouse-check-action@master
      with:
        urls: 'https://www.foo.software,https://www.google.com'

Inputs and Advanced Configuration

For detailed documentation of all inputs and advanced configuration - visit the documentation!

Screenshots

Output	Save HTML Reports as Artifacts	HTML Reports
PR Comments	Slack Notifications	Fail Workflow when Minimum Scores Aren't Met

Credits

This package was brought to you by Foo - a website quality monitoring tool. Automatically test and monitor website performance, SEO and accessibility with Lighthouse. Analyze historical records of Lighthouse tests with automated monitoring. Report with confidence about SEO and performance improvements to stay on top of changes when they happen!