Lighthouse Check Action

Abstract

1. Introduction

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.

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

2. Objective

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

This project demonstrates how TypeScript, GitHub Actions can be applied to a real-world Digital Marketing & SEO problem.

3. Key Features / Modules

• 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!

4. Technology Stack

5. System Requirements

General requirements for this technology stack — check the README for exact versions.

• Node.js (LTS) and npm / yarn / pnpm
• VS Code or any code editor
• Git (to clone the repository)

6. Installation & Setup

git clone https://github.com/foo-software/lighthouse-check-action.git
cd lighthouse-check-action

1. uses: actions/checkout@master
2. name: Lighthouse

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'

Full setup instructions are in the project README.

7. Future Enhancements

Suggested extensions you can add to make this your own project.

• Export reports to Google Sheets or PDF
• Schedule weekly automated reports
• Add competitor comparison

8. Viva / Review Questions

Common questions examiners ask for projects in this domain.

1. Which marketing or SEO problem does this tool solve?
2. Which data sources or APIs does it use (Search Console, Analytics, social platforms)?
3. Which metrics or KPIs does it report and how are they calculated?
4. How could the output help a business make decisions?
5. How would you schedule it to run automatically?

9. Source Code & License

This project is developed by foo-software and published on GitHub under the MIT License. Please follow the license terms and credit the original author when you use or modify this code.