Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/foo-software/lighthouse-check-action
GitHub Action for running @GoogleChromeLabs Lighthouse audits with all the bells and whistles 🔔 Multiple audits, Slack notifications, and more!
https://github.com/foo-software/lighthouse-check-action
accessibility actions best-practices github-actions lighthouse lighthouse-audits performance progressive-web-app seo website-performance website-performance-monitoring
Last synced: 26 days ago
JSON representation
GitHub Action for running @GoogleChromeLabs Lighthouse audits with all the bells and whistles 🔔 Multiple audits, Slack notifications, and more!
- Host: GitHub
- URL: https://github.com/foo-software/lighthouse-check-action
- Owner: foo-software
- License: mit
- Created: 2019-09-24T02:01:59.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-05-03T17:00:28.000Z (6 months ago)
- Last Synced: 2024-10-10T16:31:05.212Z (29 days ago)
- Topics: accessibility, actions, best-practices, github-actions, lighthouse, lighthouse-audits, performance, progressive-web-app, seo, website-performance, website-performance-monitoring
- Language: TypeScript
- Homepage: https://github.com/marketplace/actions/lighthouse-check
- Size: 169 MB
- Stars: 482
- Watchers: 7
- Forks: 24
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-actions - Runs Lighthouse and posts results to PRs and Slack
- fucking-awesome-actions - Runs Lighthouse and posts results to PRs and Slack
- awesome-ccamel - foo-software/lighthouse-check-action - GitHub Action for running @GoogleChromeLabs Lighthouse audits with all the bells and whistles 🔔 Multiple audits, Slack notifications, and more! (TypeScript)
- awesome-workflows - Runs Lighthouse and posts results to PRs and Slack
README
# 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](https://www.foo.software/docs/lighthouse-check-github-action/intro)!
# Quick Start
```yaml
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](https://www.foo.software/docs/lighthouse-check-github-action/intro)!
# 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](https://www.foo.software). 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!
