netlify-context-recorder

"Save Netlify's context information as part of the compiled assets"


Keywords
netlify, webpack
License
MIT
Install
npm install netlify-context-recorder@1.0.1

Documentation

Netlify Context Recorder for Webpack.

This Webpack plugin saves Netlify's context information into a JSON file. You can use this file to display information about the build context, like the git sha used to build the site.

Netlify Context Recorder is released under the MIT License. Please make sure you understand its implications and guarantees.

Usage

Add the plugin to your webpack configuration:

plugins: [
  ...
  new NetlifyContextRecorder()
],

Options

  • options.contextFilePath: path to save the context file within the distribution dir, by default "netlify-context.json".
  • options.enabledFor: array with context names the recorder is enabled for, by default ["deploy-preview", "branch-deploy"].