Skip to content

Latest commit

 

History

History
56 lines (38 loc) · 2.73 KB

README.md

File metadata and controls

56 lines (38 loc) · 2.73 KB

Netlify Sentry plugin    

Automatically notify Sentry of new releases being deployed to your site after it finishes building in Netlify.

The Netlify Sentry build plugin:

  • Notifies Sentry of new releases being deployed.
  • Uploads source maps to Sentry.
  • Sends Sentry the commit SHA of HEAD to enable commit features.

Before proceeding, you'll first want to ensure that your Sentry project is set up properly to track commit metadata. The easiest way to do that is to install a repository integration.

Make sure build plugins are enabled on your site to see the plugin run.

Create a Sentry Internal Integration

For Jenkins to communicate securely with Sentry, you'll need to create a new internal integration. In Sentry, navigate to: Settings > Developer Settings > New Internal Integration.

Give your new integration a name (for example, Netlify Deploy Integration”) and specify the necessary permissions. In this case, we need Admin access for “Release” and Read access for “Organization”.

Click “Save” at the bottom of the page and then grab your token, you'll need this in the next step.

Installation

To install, add the following lines to your netlify.toml file:

[[plugins]]
  package = "netlify-plugin-sentry"

Note: The [[plugins]] line is required for each plugin, even if you have other plugins in your netlify.toml file already.

Configuration

Configure the plugin with your sentry settings.

[[plugins]]
  package = "netlify-plugin-sentry"

  [plugins.inputs]
    sentryOrg = ""
    sentryProject = ""
    sentryAuthToken = ""  # note: we recommend this be set as an environment variable (see below)
    sourceMapPath = "" # default: netlify publish directory
    sourceMapUrlPrefix = "" # default: "~/"
    skipSetCommits = false # default: false

For more information about the parameters above, please see the Sentry release management docs.

You can also use site environment variables to configure these values.

  • process.env.SENTRY_ORG - The slug of the organization name in Sentry
  • process.env.SENTRY_PROJECT - The slug of the project name in Sentry
  • process.env.SENTRY_ENVIRONMENT - The name of the environment being deployed to (default: netlify deploy context)
  • process.env.SENTRY_AUTH_TOKEN - Authentication token for Sentry