foo-software/Lighthouse Check
GitHub Action for running one or multiple Lighthouse audits featuring PR comments, Slack notifications and more!
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| accessToken | Legacy field (use "gitHubAccessToken"): Access token of a user to post PR comments. | — | — |
| apiToken | Legacy field (use "fooApiToken"): The foo.software account API token found in the dashboard. | — | — |
| author | Legacy field (use "gitAuthor"): Used in Slack notifications, linking the authoring user to their GitHub profile. In a GitHub context you could use "github.actor". | — | — |
| awsAccessKeyId | The AWS accessKeyId for an S3 bucket. | — | — |
| awsBucket | The AWS Bucket for an S3 bucket. | — | — |
| awsRegion | The AWS region for an S3 bucket. | — | — |
| awsSecretAccessKey | The AWS secretAccessKey for an S3 bucket. | — | — |
| branch | Legacy field (use "gitBranch"): Used in Slack notifications. In a GitHub context you could use "github.ref". | — | — |
| commentUrl | An endpoint to post comments to. This is only needed if you want to trigger comments on 'push'. A 'pull_request' trigger does not require this to be set. Typically this will be from GitHub's API. Example: https://api.github.com/repos/:owner/:repo/commits/:commit_sha/comments. | — | — |
| device | The device in which to run Lighthouse (either "desktop" or "mobile") | — | — |
| emulatedFormFactor | Legacy field (use "device): The device in which to run Lighthouse (either "desktop" or "mobile") | — | — |
| extraHeaders | Stringified HTTP Header object key/value pairs to send in requests. | — | — |
| fooApiToken | The foo.software account API token found in the dashboard. | — | — |
| gitAuthor | Used in Slack notifications, linking the authoring user to their GitHub profile. In a GitHub context you could use 'github.actor'. | — | — |
| gitBranch | Used in Slack notifications. In a GitHub context you could use 'github.ref'. | — | — |
| gitHubAccessToken | Access token of a user to post PR comments. | — | — |
| locale | A locale for Lighthouse reports. Example: ja | — | — |
| maxRetries | The maximum number of times to retry. Note: This is not supported when running against Foo's API as retry logic is already in place. | — | — |
| outputDirectory | An absolute directory path to output report. You can do this an an alternative or combined with an S3 upload. | — | — |
| overridesJsonFile | A JSON file with config and option fields to override defaults. | — | — |
| prCommentEnabled | If true and gitHubAccessToken is set scores will be posted as comments. | — | — |
| prCommentSaveOld | If true and PR comment options are set, new comments will be posted on every change vs only updating once comment with most recent scores. | — | — |
| sha | Used in Slack notifications. A git sha. | — | — |
| slackWebhookUrl | A Slack Incoming Webhook URL to send notifications to. | — | — |
| tag | An optional tag or name (example: "build #2" or "v0.0.2"). | — | — |
| throttlingMethod | Lighthouse setting only used for local audits. See lighthouse-check NPM module comments for details. | — | — |
| throttling | Lighthouse setting only used for local audits. See lighthouse-check NPM module comments for details. | — | — |
| timeout | Minutes to timeout for remote runs. If "wait" option is "true" (it is by default), we wait for results. If this timeout is met before results are received an error is thrown. | — | — |
| urls | A comma-separated list of URLs (or page API tokens if running remotely). | — | — |
| urlsJson | An alternative way of passing URLs to Lighthouse Check to fulfill more advanced cases in which URLs have commas or you need to associate a URL with a Foo page token. | — | — |
| verbose | If "true", print out steps and results to the console. | — | — |
| wait | If "true", waits for all audit results to be returned, otherwise URLs are only enqueued. | — | — |
Outputs
no outputs