Giter Club home page Giter Club logo

lighthouse-check-action's Introduction

Lighthouse Check Action

Lighthouse

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

Lighthouse Check GitHub action output Output Lighthouse Check GitHub action save artifacts Save HTML Reports as Artifacts Lighthouse Check GitHub action HTML report HTML Reports
Lighthouse Check PR comments PR Comments Lighthouse Check GitHub action Slack notification Slack Notifications Lighthouse Check GitHub action fail if scores don't meet minimum requirement on a PR 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!

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.