Miss any of our Open RFC calls?Watch the recordings here! »


1.12.0 • Public • Published

Sentry Webpack Plugin

Travis codecov npm version npm dm npm dt

deps deps dev deps peer

A webpack plugin acting as an interface to Sentry CLI.


Using npm:

$ npm install @sentry/webpack-plugin --only=dev

Using yarn:

$ yarn add @sentry/webpack-plugin --dev

CLI Configuration

You can use either .sentryclirc file or ENV variables described here https://docs.sentry.io/learn/cli/configuration/


const SentryCliPlugin = require('@sentry/webpack-plugin');
const config = {
  plugins: [
    new SentryCliPlugin({
      include: '.',
      ignoreFile: '.sentrycliignore',
      ignore: ['node_modules', 'webpack.config.js'],
      configFile: 'sentry.properties',

Also, check the example directory.


Option Type Required Description
release string optional unique name of a release, must be a string, should uniquely identify your release, defaults to sentry-cli releases propose-version command which should always return the correct version (requires access to git CLI and root directory to be a valid repository).
include string/array required one or more paths that Sentry CLI should scan recursively for sources. It will upload all .map files and match associated .js files
entries array/RegExp/function(key: string): bool optional a filter for entry points that should be processed. By default, the release will be injected into all entry points.
ignoreFile string optional path to a file containing list of files/directories to ignore. Can point to .gitignore or anything with same format
ignore string/array optional one or more paths to ignore during upload. Overrides entries in ignoreFile file. If neither ignoreFile or ignore are present, defaults to ['node_modules']
configFile string optional path to Sentry CLI config properties, as described in https://docs.sentry.io/learn/cli/configuration/#properties-files. By default, the config file is looked for upwards from the current path and defaults from ~/.sentryclirc are always loaded
ext array optional this sets the file extensions to be considered. By default the following file extensions are processed: js, map, jsbundle and bundle.
urlPrefix string optional this sets an URL prefix at the beginning of all files. This defaults to ~/ but you might want to set this to the full URL. This is also useful if your files are stored in a sub folder. eg: url-prefix '~/static/js'
urlSuffix string optional this sets an URL suffix at the end of all files. Useful for appending query parameters.
validate boolean optional this attempts sourcemap validation before upload when rewriting is not enabled. It will spot a variety of issues with source maps and cancel the upload if any are found. This is not the default as this can cause false positives.
stripPrefix array optional when paired with rewrite this will chop-off a prefix from uploaded files. For instance you can use this to remove a path that is build machine specific.
stripCommonPrefix boolean optional when paired with rewrite this will add ~ to the stripPrefix array.
sourceMapReference boolean optional this prevents the automatic detection of sourcemap references.
rewrite boolean optional enables rewriting of matching sourcemaps so that indexed maps are flattened and missing sources are inlined if possible. defaults to true
finalize boolean optional determines whether processed release should be automatically finalized after artifacts upload. defaults to true
dryRun boolean optional attempts a dry run (useful for dev environments)
debug boolean optional print some useful debug information
silent boolean optional if true, all logs are suppressed (useful for --json option)
errorHandler function(err: Error, invokeErr: function(): void, compilation: Compilation): void optional when Cli error occurs, plugin calls this function. webpack compilation failure can be chosen by calling invokeErr callback or not. If you don't want this plugin to prevent further compilation, you can use a compilation warning instead by setting this option to (err, invokeErr, compilation) => { compilation.warnings.push('Sentry CLI Plugin: ' + err.message) } instead. defaults to (err, invokeErr) => { invokeErr() }
setCommits Object optional Adds commits to sentry - see own table below for more details
deploy Object optional Creates a new release deployment - see own table below for more details


Option Type Required Description
repo string optional/required the full git repo name as defined in Sentry. Required if auto option is not true.
commit string optional/required the current (last) commit in the release. Required if auto option is not true.
previousCommit string optional the commit before the beginning of this release (in other words, the last commit of the previous release). If omitted, this will default to the last commit of the previous release in Sentry. If there was no previous release, the last 10 commits will be used
auto boolean optional automatically choose the associated commit (uses the current commit). Overrides other options


Option Type Required Description
env string required environment for this release. Values that make sense here would be production or staging
started number optional unix timestamp when the deployment started
finished number optional unix timestamp when the deployment finished
time number optional deployment duration in seconds. This can be specified alternatively to started and finished
name string optional human readable name for this deployment
url string optional URL that points to the deployment

You can find more information about these options in our official docs: https://docs.sentry.io/cli/releases/#sentry-cli-sourcemaps


npm i @sentry/webpack-plugin

DownloadsWeekly Downloads






Unpacked Size

44.4 kB

Total Files


Last publish


  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar