bugsnag-build-reporter

bugsnag-build-reporter

A tool for reporting your application's builds to Bugsnag.

Usage

This module can be used in a Node environment via the JS API or as a CLI.

CLI

Install globally with npm i -g bugsnag-build-reporter or locally as a dev dependency npm i -D bugsnag-build-reporter. If installed via the latter, recent versions of npm come with a tool called npx which will help run it without typing burdensome paths.

A tool for reporting your application's builds to Bugsnag

Usage
  $ bugsnag-build-reporter <flags> <metadata>

Options
  --api-key, -k  Set your notifier API key [required]
  --app-version, -v  Set the app version [required]
  --release-stage, -s Set the release stage

  --source-control-provider, -p  Set the repo provider
  --source-control-repository, -r  Set the repo URL
  --source-control-revision, -e  Set the source control revision id (e.g commit SHA)

  --app-version-code, -c  Set the version code (Android only)
  --app-bundle-version, -b  Set the bundle version (iOS/macOS/tvOS only)
  --builder-name, -n  Set the name of the entity that triggered the build

  metadata
    Arbitrary "key=value" pairs will be passed to the build API as metadata
      e.g. foo=bar

Examples

  bugsnag-build-reporter \
    --api-key cc814aead128d38d0767094327b4784a \
    --app-version 1.3.5

  bugsnag-build-reporter \
    -k cc814aead128d38d0767094327b4784a \
    -v 1.3.5

npm scripts

scripts: {
  'report-build': 'bugsnag-build-reporter -k YOUR_API_KEY -v APP_VERSION'
}

JS API

const reportBuild = require('bugsnag-build-reporter')
reportBuild({
  apiKey: 'YOUR_API_KEY',
  appVersion: '1.2.3',
  /* other options... */
}/* , optional path, defaults to process.cwd() */)