{"id":22021833,"url":"https://github.com/foo-software/lighthouse-check-orb","last_synced_at":"2025-10-24T04:23:41.118Z","repository":{"id":40410514,"uuid":"211516527","full_name":"foo-software/lighthouse-check-orb","owner":"foo-software","description":"CircleCI Orb for running Lighthouse audits with all the bells and whistles 🔔 Multiple audits, Slack notifications and more!","archived":false,"fork":false,"pushed_at":"2020-09-11T16:25:29.000Z","size":50,"stargazers_count":7,"open_issues_count":0,"forks_count":3,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-31T07:22:11.310Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://circleci.com/orbs/registry/orb/foo-software/lighthouse-check","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/foo-software.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-09-28T14:54:45.000Z","updated_at":"2023-12-24T13:11:10.000Z","dependencies_parsed_at":"2022-09-15T10:21:39.194Z","dependency_job_id":null,"html_url":"https://github.com/foo-software/lighthouse-check-orb","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/foo-software%2Flighthouse-check-orb","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/foo-software%2Flighthouse-check-orb/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/foo-software%2Flighthouse-check-orb/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/foo-software%2Flighthouse-check-orb/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/foo-software","download_url":"https://codeload.github.com/foo-software/lighthouse-check-orb/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252831069,"owners_count":21810775,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-30T06:15:27.621Z","updated_at":"2025-10-24T04:23:41.061Z","avatar_url":"https://github.com/foo-software.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Lighthouse Check Orb\n\n\u003e A CircleCI Orb for running Lighthouse audits automatically in a workflow with a rich set of extra features. Simple implementation or advanced customization including **Slack** notifications, **AWS S3** HTML report uploads, and more!\n\nThis project provides **two ways of running audits** - \"locally\" by default in a dockerized environment or remotely via [Foo's Automated Lighthouse Check](https://www.foo.software/lighthouse) API. For basic usage, running locally will suffice, but if you'd like to maintain a historical record of Lighthouse audits and utilize other features, you can follow the [steps and examples](#usage-foo-api).\n\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003ctd\u003e\n      \u003cimg alt=\"Lighthouse\" src=\"https://lighthouse-check.s3.amazonaws.com/images/lighthouse-600x600.png\" width=\"400\" /\u003e\n    \u003c/td\u003e\n    \u003ctd\u003e\n      \u003cimg alt=\"AWS S3\" src=\"https://lighthouse-check.s3.amazonaws.com/images/github-actions/aws-s3-logo.png\" /\u003e\n    \u003c/td\u003e\n    \u003ctd\u003e\n      \u003cimg alt=\"Slack\" src=\"https://lighthouse-check.s3.amazonaws.com/images/github-actions/slack-logo.png\" /\u003e\n    \u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n## How this Project Differs from Others\n\nSimple configuration or choose from a variety of features below. See the [example Lighthouse Check Orb implementation](#example-usage).\n\n- 💛 Lighthouse audit **multiple** URLs or just one.\n- 💛 Save a record of all your audits via [Foo's Automated Lighthouse Check](#usage-foo-api).\n- 💗 Save HTML reports locally.\n- 💚 Upload HTML reports as artifacts.\n- 💙 Upload HTML reports to AWS S3.\n- ❤️ Fail a workflow when minimum scores aren't met. [Example at the bottom](#user-content-example-usage-failing-workflows-by-enforcing-minimum-scores).\n- 💜 **Slack** notifications.\n- 💖 Slack notifications **with Git info** (author, branch, PR, etc).\n\n# Table of Contents\n\n- [Screenshots](#screenshots)\n  - [Output](#screenshot-output)\n  - [Save HTML Reports as Artifacts](#screenshot-save-html-reports-as-artifacts)\n  - [HTML Reports](#screenshot-html-reports)\n  - [Slack Notifications](#screenshot-slack-notifications)\n  - [Fail Workflow when Minimum Scores Aren't Met](#screenshot-fail-workflow-when-minimum-scores-arent-met)\n- [Parameters](#parameters)\n- [Usage](#usage)\n  - [Standard Example](#usage-standard-example)\n  - [Failing Workflows by Enforcing Minimum Scores](#usage-failing-workflows-by-enforcing-minimum-scores)\n  - [Foo API](#usage-foo-api)\n\n# Screenshots\n\nA visual look at the things you can do.\n\n## Screenshot: Output\n\u003cimg alt=\"Lighthouse Check Orb output\" src=\"https://lighthouse-check.s3.amazonaws.com/images/circleci/circleci-orb-lighthouse-check-output.png\" /\u003e\n\n## Screenshot: Save HTML Reports as Artifacts\n\u003cimg alt=\"Lighthouse Check Orb save artifacts\" src=\"https://lighthouse-check.s3.amazonaws.com/images/circleci/circleci-orb-lighthouse-check-artifacts.png\" /\u003e\n\n## Screenshot: HTML Reports\n\u003cimg alt=\"Lighthouse Check Orb HTML report\" src=\"https://lighthouse-check.s3.amazonaws.com/images/circleci/circleci-orb-lighthouse-check-report.png\" /\u003e\n\n## Screenshot: Slack Notifications\n\u003cimg alt=\"Lighthouse Check Orb Slack notification\" src=\"https://lighthouse-check.s3.amazonaws.com/images/circleci/circleci-orb-lighthouse-check-slack.png\" width=\"600\" /\u003e\n\n## Screenshot: Fail Workflow when Minimum Scores Aren't Met\n\n\u003cimg alt=\"Lighthouse Check Orb fail if scores don't meet minimum requirement on a PR\" src=\"https://lighthouse-check.s3.amazonaws.com/images/circleci/circleci-orb-lighthouse-check-fail.png\" /\u003e\n\n## Parameters\n\nYou can choose from two ways of running audits - \"locally\" in a dockerized environment (by default) or remotely via the [Foo's Automated Lighthouse Check](https://www.foo.software/lighthouse) API. For directions about how to run remotely see the [Foo API Usage](#usage-foo-api) section. We denote which options are available to a run type with the `Run Type` values of either `local`, `remote`, or `both` respectively.\n\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003cth\u003eName\u003c/th\u003e\n    \u003cth\u003eDescription\u003c/th\u003e\n    \u003cth\u003eType\u003c/th\u003e\n    \u003cth\u003eRun Type\u003c/th\u003e\n    \u003cth\u003eDefault\u003c/th\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003e\u003ccode\u003eapiToken\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003eThe foo.software account API token found in the dashboard.\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003estring\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003eremote\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003eundefined\u003c/code\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003e\u003ccode\u003eauthor\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003eFor Slack notifications: A user handle, typically from GitHub.\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003estring\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003eboth\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003e$CIRCLE_USERNAME\u003c/code\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003e\u003ccode\u003eawsAccessKeyId\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003eThe AWS \u003ccode\u003eaccessKeyId\u003c/code\u003e for an S3 bucket.\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003estring\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003elocal\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003e$LIGHTHOUSE_CHECK_AWS_ACCESS_KEY_ID\u003c/code\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003e\u003ccode\u003eawsBucket\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003eThe AWS \u003ccode\u003eBucket\u003c/code\u003e for an S3 bucket.\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003estring\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003elocal\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003e$LIGHTHOUSE_CHECK_AWS_BUCKET\u003c/code\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003e\u003ccode\u003eawsRegion\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003eThe AWS \u003ccode\u003eregion\u003c/code\u003e for an S3 bucket.\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003estring\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003elocal\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003e$LIGHTHOUSE_CHECK_AWS_REGION\u003c/code\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003e\u003ccode\u003eawsSecretAccessKey\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003eThe AWS \u003ccode\u003esecretAccessKey\u003c/code\u003e for an S3 bucket.\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003estring\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003elocal\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003e$LIGHTHOUSE_CHECK_AWS_SECRET_ACCESS_KEY\u003c/code\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003e\u003ccode\u003ebranch\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003eFor Slack notifications: A version control branch, typically from GitHub.\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003estring\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003eboth\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003e$CIRCLE_BRANCH\u003c/code\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003e\u003ccode\u003econfigFile\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003eA configuration file path in JSON format which holds all options defined here. This file should be relative to the file being interpretted. In this case it will most likely be the root of the repo (\"./\")\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003estring\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003eboth\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003eundefined\u003c/code\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003e\u003ccode\u003eemulatedFormFactor\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003eLighthouse setting only used for local audits. See \u003ca href=\"https://github.com/foo-software/lighthouse-check/tree/master/src/lighthouseConfig.js\"\u003e\u003ccode\u003elighthouse-check\u003c/code\u003e\u003c/a\u003e comments for details.\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003eoneOf(['mobile', 'desktop']\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003elocal\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003emobile\u003c/code\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003e\u003ccode\u003eextraHeaders\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003eStringified HTTP Header object key/value pairs to send in requests. example: \u003ccode\u003e'{ \\\"x-hello-world\\\": \\\"foobar\\\", \\\"x-some-other-thing\\\": \\\"hi\\\" }'\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003estring\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003elocal\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003eundefined\u003c/code\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003e\u003ccode\u003elocale\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003eA locale for Lighthouse reports. Example: \u003ccode\u003eja\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003estring\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003elocal\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003eundefined\u003c/code\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003e\u003ccode\u003emaxWaitForLoad\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003eThe maximum amount of time to wait for a page to load in ms.\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003enumber\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003elocal\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003eundefined\u003c/code\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003e\u003ccode\u003eoverridesJsonFile\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003eA JSON file with config and option fields to overrides defaults. \u003ca href=\"#usage-overriding-config-and-option-defaults\"\u003eRead more here\u003c/a\u003e.\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003estring\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003elocal\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003eundefined\u003c/code\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003e\u003ccode\u003epr\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003eFor Slack notifications: A version control pull request URL, typically from GitHub.\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003estring\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003eboth\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003eundefined\u003c/code\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003e\u003ccode\u003eprCommentAccessToken\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003ca href=\"https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line\"\u003eAccess token\u003c/a\u003e of a user to post PR comments.\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003estring\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003eboth\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003eundefined\u003c/code\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003e\u003ccode\u003eprCommentEnabled\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003eIf \u003ccode\u003etrue\u003c/code\u003e and \u003ccode\u003eprCommentAccessToken\u003c/code\u003e is set along with \u003ccode\u003eprCommentUrl\u003c/code\u003e, scores will be posted as comments.\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003eboolean\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003eboth\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003etrue\u003c/code\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003e\u003ccode\u003eprCommentSaveOld\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003eIf \u003ccode\u003etrue\u003c/code\u003e and PR comment options are set, new comments will be posted on every change vs only updating once comment with most recent scores.\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003eboolean\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003eboth\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003efalse\u003c/code\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003e\u003ccode\u003eprCommentUrl\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003eAn endpoint to post comments to. Typically this will from \u003ca href=\"https://developer.github.com/v3/pulls/reviews/#create-a-pull-request-review\"\u003eGitHub's API\u003c/a\u003e. Example: \u003ccode\u003ehttps://api.github.com/repos/:owner/:repo/pulls/:pull_number/reviews\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003estring\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003eboth\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003eundefined\u003c/code\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003e\u003ccode\u003esha\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003eFor Slack notifications: A version control \u003ccode\u003esha\u003c/code\u003e, typically from GitHub.\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003estring\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003eboth\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003eundefined\u003c/code\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003e\u003ccode\u003eslackWebhookUrl\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003eA Slack Incoming Webhook URL to send notifications to.\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003estring\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003eboth\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003e$LIGHTHOUSE_CHECK_SLACK_WEBHOOK_URL\u003c/code\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003e\u003ccode\u003ethrottling\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003eLighthouse setting only used for local audits. See \u003ca href=\"https://github.com/foo-software/lighthouse-check/tree/master/src/lighthouseConfig.js\"\u003e\u003ccode\u003elighthouse-check\u003c/code\u003e\u003c/a\u003e comments for details.\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003eoneOf(['mobileSlow4G', 'mobileRegluar3G'])\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003elocal\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003emobileSlow4G\u003c/code\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003e\u003ccode\u003etag\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003eAn optional tag or name (example: \u003ccode\u003ebuild #2\u003c/code\u003e or \u003ccode\u003ev0.0.2\u003c/code\u003e).\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003estring\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003eremote\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003eundefined\u003c/code\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003e\u003ccode\u003ethrottlingMethod\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003eLighthouse setting only used for local audits. See \u003ca href=\"https://github.com/foo-software/lighthouse-check/tree/master/src/lighthouseConfig.js\"\u003e\u003ccode\u003elighthouse-check\u003c/code\u003e\u003c/a\u003e comments for details.\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003eoneOf(['simulate', 'devtools', 'provided'])\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003elocal\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003esimulate\u003c/code\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003e\u003ccode\u003etimeout\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003eMinutes to timeout. If \u003ccode\u003ewait\u003c/code\u003e is \u003ccode\u003etrue\u003c/code\u003e (it is by default), we wait for results. If this timeout is reached before results are received an error is thrown.\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003estring\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003elocal\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003e10\u003c/code\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003e\u003ccode\u003eurls\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003eA comma-separated list of URLs to be audited.\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003estring\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003eboth\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003eundefined\u003c/code\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003e\u003ccode\u003ewait\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003eIf \u003ccode\u003etrue\u003c/code\u003e, waits for all audit results to be returned, otherwise URLs are only enqueued.\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003eboolean\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003eremote\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003ccode\u003etrue\u003c/code\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n## Usage\n\nBelow are example combinations of ways to use this Orb.\n\n## Usage: Standard Example\n\nIn the below example we run Lighthouse on two URLs, log scores, save the HTML reports as artifacts, upload reports to AWS S3, notify via Slack with details about the change from Git data.\n\n```yaml\nversion: 2.1\n\norbs:\n  lighthouse-check: foo-software/lighthouse-check@0.0.6 # ideally later :)\n\njobs:\n  test: \n    executor: lighthouse-check/default\n    steps:\n      - lighthouse-check/audit:\n          urls: https://www.foo.software,https://www.foo.software/contact\n          # this serves as an example, however if the below environment variables\n          # are set - the below params aren't even necessary. for example - if\n          # LIGHTHOUSE_CHECK_AWS_ACCESS_KEY_ID is already set - you don't need\n          # the line below.\n          awsAccessKeyId: $LIGHTHOUSE_CHECK_AWS_ACCESS_KEY_ID\n          awsBucket: $LIGHTHOUSE_CHECK_AWS_BUCKET\n          awsRegion: $LIGHTHOUSE_CHECK_AWS_REGION\n          awsSecretAccessKey: $LIGHTHOUSE_CHECK_AWS_SECRET_ACCESS_KEY\n          slackWebhookUrl: $LIGHTHOUSE_CHECK_SLACK_WEBHOOK_URL\n\nworkflows:\n  test:\n    jobs:\n      - test\n```\n\n## Usage: Failing Workflows by Enforcing Minimum Scores\n\nWe can optionally fail a workflow if minimum scores aren't met. We do this using the `validate-status` command.\n\n```yaml\nversion: 2.1\n\norbs:\n  lighthouse-check: foo-software/lighthouse-check@0.0.6 # ideally later :)\n\njobs:\n  test: \n    executor: lighthouse-check/default\n    steps:\n      - lighthouse-check/audit:\n          urls: https://www.foo.software,https://www.foo.software/contact\n      - lighthouse-check/validate-status:\n          minAccessibilityScore: \"50\"\n          minBestPracticesScore: \"50\"\n          minPerformanceScore: \"99\"\n          minProgressiveWebAppScore: \"50\"\n          minSeoScore: \"50\"\n\nworkflows:\n  test:\n    jobs:\n      - test\n```\n\n## Usage: Foo API\n\n[Foo's Automated Lighthouse Check](https://www.foo.software/lighthouse) can monitor your website's quality by running audits automatically! It can provide a historical record of audits over time to track progression and degradation of website quality. [Create a free account](https://www.foo.software/register) to get started. With this, not only will you have automatic audits, but also any that you trigger additionally. Below are steps to trigger audits on URLs that you've created in your account.\n\n#### Trigger Audits on All Pages in an Account\n\n- Navigate to [your account details](https://www.foo.software/account), click into \"Account Management\" and make note of the \"API Token\".\n- Use the account token as the [`apiToken` parameter](#parameters).\n\n\u003e Basic example\n\n```yaml\nusage:\n  version: 2.1\n\n  orbs:\n    lighthouse-check: foo-software/lighthouse-check@0.0.7 # ideally later :)\n\n  jobs:\n    test: \n      executor: lighthouse-check/default\n      steps:\n        - lighthouse-check/audit:\n            apiToken: $LIGHTHOUSE_CHECK_API_TOKEN\n\n  workflows:\n    test:\n      jobs:\n        - test\n```\n\n#### Trigger Audits on Only Certain Pages in an Account\n\n- Navigate to [your account details](https://www.foo.software/account), click into \"Account Management\" and make note of the \"API Token\".\n- Navigate to [your dashboard](https://www.foo.software/dashboard) and once you've created URLs to monitor, click on the \"More\" link of the URL you'd like to use. From the URL details screen, click the \"Edit\" link at the top of the page. You should see an \"API Token\" on this page. It represents the token for this specific page (not to be confused with an **account** API token).\n- Use the account token as the [`apiToken` parameter](#parameters) and page token (or group of page tokens) as [`urls` parameter](#parameters).\n\n\u003e Basic example\n\n```yaml\nusage:\n  version: 2.1\n\n  orbs:\n    lighthouse-check: foo-software/lighthouse-check@0.0.8 # ideally later :)\n\n  jobs:\n    test: \n      executor: lighthouse-check/default\n      steps:\n        - lighthouse-check/audit:\n            apiToken: $LIGHTHOUSE_CHECK_API_TOKEN\n            urls: 'mypagetoken1,mypagetoken2'\n\n  workflows:\n    test:\n      jobs:\n        - test\n```\n\n\u003e Example with pull request comments\n\n```yaml\nusage:\n  version: 2.1\n\n  orbs:\n    lighthouse-check: foo-software/lighthouse-check@0.0.8 # ideally later :)\n\n  jobs:\n    test: \n      executor: lighthouse-check/default\n      steps:\n        - lighthouse-check/audit:\n            apiToken: $LIGHTHOUSE_CHECK_API_TOKEN\n            prCommentAccessToken: $LIGHTHOUSE_CHECK_ACCESS_TOKEN\n            prCommentUrl: https://api.github.com/repos/foo-software/lighthouse-check-orb/pulls/${CIRCLE_PULL_REQUEST##*/}/reviews\n            urls: 'mypagetoken1,mypagetoken2'\n\n  workflows:\n    test:\n      jobs:\n        - test\n```\n\n## Usage: Overriding Config and Option Defaults\n\n\u003e **Note:** this approach is only available when running \"locally\" (not using the REST API)\n\nYou can override default config and options by specifying `overridesJsonFile` option which is consumed by [`path.resolve(overridesJsonFile)`](https://nodejs.org/api/path.html#path_path_resolve_paths). Contents of this overrides JSON file can have two possible fields; `options` and `config`. These two fields are eventually used by Lighthouse to populate `opts` and `config` arguments respectively as illustrated in [Using programmatically](https://github.com/GoogleChrome/lighthouse/blob/master/docs/readme.md#using-programmatically). The two objects populating this JSON file are merged shallowly with the default [config](https://github.com/foo-software/lighthouse-check/blob/master/src/__snapshots__/lighthouseConfig.test.js.snap) and [options](https://github.com/foo-software/lighthouse-check/blob/master/src/__snapshots__/lighthouseOptions.test.js.snap).\n\n\u003e Example content of `overridesJsonFile`\n\n```json\n{\n  \"config\": {\n    \"settings\": {\n      \"onlyCategories\": [\"performance\"]\n    }\n  },\n  \"options\": {\n    \"disableStorageReset\": true\n  }\n}\n```\n\n## Credits\n\n\u003e \u003cimg src=\"https://lighthouse-check.s3.amazonaws.com/images/logo-simple-blue-light-512.png\" width=\"100\" height=\"100\" align=\"left\" /\u003e This package was brought to you by [Foo - a website performance monitoring tool](https://www.foo.software). Create a **free account** with standard performance testing. Automatic website performance testing, uptime checks, charts showing performance metrics by day, month, and year. Foo also provides real time notifications. Users can integrate email, Slack and PagerDuty notifications.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffoo-software%2Flighthouse-check-orb","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffoo-software%2Flighthouse-check-orb","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffoo-software%2Flighthouse-check-orb/lists"}