Grunt

Report builds to Bugsnag using Grunt

Use our Grunt module to:

  • Report information when you build your app to enable linking to code in your source control provider from the releases dashboard, timeline annotations, and stack traces.

Installation

Install the grunt-bugsnag module.

npm install --save-dev grunt-bugsnag

Reporting builds

grunt-bugsnag can auto detect source control info from .git, .hg and package.json. For detailed usage instructions, check out the readme.

Here’s an example to get you started:

/* Gruntfile.js */

module.exports = grunt => {
  grunt.initConfig({
    bugsnagReportBuild: {
      apiKey: 'YOUR_API_KEY',
      appVersion: '1.2.3',
      options: {}
    }
  })

  // load the task(s) from this module
  grunt.loadNpmTasks('grunt-bugsnag')

  // add as the last task in your application's build task
  grunt.task('build', /* build tasks */, 'bugsnagReportBuild')
}

// $ grunt build
// runs your build process and then notifies
// Bugsnag if all the previous tasks succeed

Setting appVersion

There are a variety of ways to manage or inject version numbers in your build, so the following advice applies to whichever strategy you use.

  • Set appVersion in your notifier so that sessions and error reports are correctly associated with your reported builds
  • Keep the notifier appVersion in sync with the build reporter
  • appVersion should change any time your source code, or any of its dependencies changes

Uploading source maps

Support for uploading source maps is coming soon. Until then please see our source map support guide.