webpack-sentry-plugin

Sentry plugin

A webpack plugin to upload source maps to Sentry.

Installation

Using npm:

$ npm install webpack-sentry-plugin --save-dev

Using yarn:

$ yarn add webpack-sentry-plugin --dev

Usage

1. Require webpack-sentry-plugin:

   var SentryPlugin = require('webpack-sentry-plugin');
   

2. Configure webpack to output source maps. Recommended reading: webpack docs, Sentry docs

3. Add to webpack config:

   var config = {
     plugins: [
       new SentryPlugin({
         // Sentry options are required
         organisation: 'your-organisation-name',
         project: 'your-project-name',
         apiKey: process.env.SENTRY_API_KEY,
         
         // Release version name/hash is required
         release: function() {
           return process.env.GIT_SHA
         }
       })
     ]
   }
   

Options

• exclude: RegExp to match for excluded files

  var config = {
    plugins: [
      new SentryPlugin({
        // Exclude uploading of html
        exclude: /\.html$/,
        ...
      })
    ]
  }
  

• include: RegExp to match for included files

  var config = {
    plugins: [
      new SentryPlugin({
        // Only upload foo.js & foo.js.map
        include: /foo.js/,
        ...
      })
    ]
  }
  

• filenameTransform: Function to transform filename before uploading to Sentry

  var config = {
    plugins: [
      new SentryPlugin({
        filenameTransform: function(filename) {
          return 'a-filename-prefix-' + filename
        }
      })
    ]
  }
  

• suppressErrors: Display warnings instead of failing webpack build - useful in case webpack compilation is done during deploy on multiple instances

• baseSentryURL: URL of Sentry instance. Shouldn't need to set if using sentry.io, but useful if self hosting

• organisation: Sentry organisation to upload files to

• project: Sentry project to upload files to

• apiKey: Sentry api key (Generate one here)

• release: Release name to attach source maps to. Can be string or function that returns a string

Thanks

• Thanks to @MikaAK for creating s3-webpack-plugin, which inspired much of this project
• Thanks to @danharper for creating the original build script implementation

Contributing

Contributions are welcome 😄. To run the tests, please ensure you have the relevant environment variables set up. You can cp .env.example .env and fill it in.

Commands to be aware of

Warning: The test suite will create releases & upload files. They should be cleaned up afterward, but ensure that you are not overwriting something important!

• npm test: Runs the test suite
• npm run build: Compiles distribution build