netlify-build-plugin-perfbeacon

1.0.4 • Public • Published

Netlify PerfBeacon Deploy Plugin

This is a Build Plugin for Netlify that uses the PerfBeacon API to automatically trigger a round of tests after a successful build has occured.

At present, this build plugin will only run when Netlify's CONTEXT variable is production.

Usage

  1. Install the plugin using yarn:
yarn add netlify-build-plugin-perfbeacon
  1. Update your netlify.toml configuration file to reference the plugin in your plugins section:
[[plugins]]
package = "netlify-build-plugin-perfbeacon"
  1. Grab your PerfBeacon Token (See Tokens page) and the ID for the site you want to test (under Sites > Settings) and store them as environmental variables inside of Netlify. Save them as PERFBEACON_TOKEN and PERFBEACON_SITE_ID.

  2. Using the latest version of the Netlify CLI, run a dry build:

netlify build --dry

If you see Plugin netlify-build-plugin-perfbeacon attached to the onSuccess lifecycle, you should be all set.

Every deployment will track your changes in PerfBeacon.

Credits

Inspired by Tim Kadlec's work for SpeedCurve: https://github.com/tkadlec/netlify-build-plugin-speedcurve

Readme

Keywords

Package Sidebar

Install

npm i netlify-build-plugin-perfbeacon

Weekly Downloads

0

Version

1.0.4

License

MIT

Unpacked Size

4.23 kB

Total Files

5

Last publish

Collaborators

  • rozenmd-perfbeacon