Lighthouse Config and Option Overrides JSON File

Introduces a new overridesJsonFile which is consumed by path.resolve(overridesJsonFile).

Usage

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. The two objects populating this JSON file are merged shallowly with the default config and options.

Example Content of overridesJsonFile

{
  "config": {
    "settings": {
      "onlyCategories": ["performance"]
    }
  },
  "options": {
    "chromeFlags": [
      "--disable-dev-shm-usage"
    ]
  }
}

Addresses Open Issues

• foo-software/lighthouse-check#23
• #12

Calmer PR Comments

This release adds support for calmer PR comments. When PR commenting is enabled, only one comment is left reflecting Lighthouse audits unless the user specifies they want new comments on every change (new prCommentSaveOld option). On every change if a comment exists, it will be updated with new scores.

• Adds prCommentEnabled option (defaults to true as a non-breaking change).
• Adds prCommentSaveOld option to allow comments to post every time (preserving old ones). This is the current behavior which will now need to be opted into.
• Updates comment if it exists, otherwise posts new. If prCommentSaveOld is set to true - always posts new.

Thanks to @schoenwaldnils for raising this issue in #18.

Better Logging

Adds better logging when fetches to the REST API fail as identified in issue #14.

Support for extra headers

This release provides support for the Lighthouse extraHeaders setting (similar to the CLI extra-headers option)

Thanks for @oskbor for opening the issue and to @bjszd for contributing.

PR Comments as Badges

Replaced markdown tables with badges in PR comments.

Lighthouse Check NPM Module Version Bump

Bumps @foo-software/lighthouse-check to support a fix for failing workflows by enforcing minimum scores.

Options for Connecting to Automated Lighthouse Check API

Options for running audits in the GitHub environment (default) or via Automated Lighthouse Check API.

Lighthouse Report URL on PR Comments

When a user has specified S3 options we add the uploaded report URL on PR comments when applicable.

Lighthouse Results on PR Comments

Automated PR comments with new accessToken option. To utilize this feature simply create an access token of an existing user or new one. Users can be created to represent bots.

Lighthouse Check Action - Initial Release

This is the initial release 🙌