Automated Website Audit

Easy Lighthouse Action: Simplify Your Website Performance Audits

A custom GitHub Action to run Google PageSpeed Insights on URLs or sitemaps with ease.

Get Started
Learn More

Key Features

Explore the powerful features that make Easy Lighthouse Action the perfect choice for your website audits.

Automated Audits

Run Google PageSpeed Insights audits automatically on your URLs or sitemaps.

Customizable Thresholds

Set performance, SEO, accessibility, and best practices thresholds to meet your needs.

Device Emulation

Test your website on mobile or desktop devices for a comprehensive audit.

Sitemap Support

Easily audit all pages in your sitemap with a single configuration.

Detailed Reports

Get detailed scores for performance, SEO, accessibility, and best practices.

Easy Integration

Seamlessly integrate with your GitHub workflows for continuous auditing.

Getting Started

Follow these simple steps to integrate Easy Lighthouse Action into your GitHub workflows.

1

Create a Workflow File

Create a new workflow file in your repository under .github/workflows/*.yaml.

2

Decide How to Trigger the Workflow

Determine how you want the workflow to be triggered. You can use any event supported by GitHub Actions. Here are two common examples:

On Code Commit

on:
  push:
    branches:
      - main

Scheduled Automated Recurrence

on:
  schedule:
    - cron: '0 0 * * *' # Fires daily at midnight UTC
3

Add the Workflow Configuration

Reference Easy Lighthouse Action in your workflow YAML file:

jobs:
  example-job:
    runs-on: ubuntu-latest
    steps:
      - name: Run PageSpeed Insights Action
        uses: leothelegion/easy-lighthouse-action@v1.0.0
        with:
          device: 'mobile'
          page_insights_key: ${{ secrets.PAGE_INSIGHTS_KEY }}
          performance_threshold: 90
          seo_threshold: 90
          accessibility_threshold: 90
          best_practices_threshold: 90
          mode: 'SITEMAP'
          sitemap_url: 'https://example.com/sitemap.xml'

Learn More

For detailed information about this action, please visit the official GitHub repository:

Visit GitHub Repository

Frequently Asked Questions

What is Easy Lighthouse Action?

It is a GitHub Action that automates Google PageSpeed Insights audits for your URLs or sitemaps.

Do I need a Google API key?

Yes, you need a Google PageSpeed Insights API key to use this action.

Can I customize thresholds?

Yes, you can set thresholds for performance, SEO, accessibility, and best practices.

Does it support sitemaps?

Yes, you can audit all pages in your sitemap by specifying the sitemap URL.

Need Help Installing Easy Lighthouse Action?

I'm here to assist you in setting it up in your GitHub Actions pipeline. Feel free to reach out to me on LinkedIn.

Connect on LinkedIn