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

A tool for reporting your application’s builds to Bugsnag

bengourley

imjoehaines

loopj

snmaynard

bugsnag-build-reporter

- Prefer remote named `origin` when detecting source control info (#7)

- Retry failed requests up to 5 times before failing (#1)

const findNearest = require('find-nearest-file')

const exec = require('child_process').exec

const relative = require('path').relative

  const pkg = findNearest('package.json', path)

  if (pkg) log.info('found a manifest:', relative(path, pkg))

    cb => extractPackageJsonRepoInfo(pkg, log, cb),

    cb => detectSourceInfoFromRepo(path, log, cb)

    const repository = (data[0] && data[0].repository)

        : ((data[1] && data[1].repository)

    const provider = getProviderFromUrl(repository)

    const revision = data[1] ? data[1].revision : undefined

    if (!provider || !repository || !revision) {

      log.warn('no source control info found (looked in package.json, .git, .hg)')

    cb(null, { provider, repository, revision })

  if (/^git@github\.com|https:\/\/github.com/.test(repo)) return 'github'

  if (/^git@gitlab\.com|https:\/\/gitlab.com/.test(repo)) return 'gitlab'

  if (/^git@bitbucket\.org|https:\/\/bitbucket.org|ssh:\/\/hg@bitbucket\.org|https:\/\/\w+@bitbucket\.org\//.test(repo)) return 'bitbucket'

const extractPackageJsonRepoInfo = (path, log, cb) => {

  readFile(path, 'utf8', (err, data) => {

      if (!pkg.repository) return cb(null, null)

      log.debug('repository info in manifest:', { repository: pkg.repository.url })

      cb(null, { repository: pkg.repository.url })

const detectSourceInfoFromRepo = (path, log, cb) => {

    log.debug(`${type} repo info:`, data)

  detectSourceInfoFromGit(path, (err, data) => {

    if (!err && data) return onSuccess('git', data)

    detectSourceInfoFromMercurial(path, (err, data) => {

      if (!err && data) return onSuccess('mercurial', data)

const detectSourceInfoFromGit = (cwd, cb) => {

    cb => exec('git rev-parse HEAD', { cwd }, cb),

      exec('git remote get-url origin', { cwd }, (err, data) => {

        // ignore this error in case origin doesn't exist

    cb => exec('git remote -v', { cwd }, cb)

      revision: data[0] ? data[0].trim() : null,

      repository: data[1] ? data[1].split(/\t|\s|\n/)[1] : null

      repository: data[1] ? data[1].trim() : (data[2] ? data[2].split(/\t|\s|\n/)[1] : null)

const detectSourceInfoFromMercurial = (cwd, cb) => {

    cb => exec('hg paths default', { cwd }, cb)

      repository: data[1] ? data[1].trim() : null

  "description": "A tool for reporting your application’s builds to Bugsnag",

    "test": "standard && nyc --reporter=lcov -- tape lib/**/*.test.js"

    "url": "https://github.com/bugsnag/bugsnag-build-reporter-node"

[![Build status](https://travis-ci.org/bugsnag/bugsnag-build-reporter-node.svg?branch=master)](https://travis-ci.org/bugsnag/bugsnag-build-reporter-node)

[![Build status](https://travis-ci.com/bugsnag/bugsnag-build-reporter-node.svg?branch=master)](https://travis-ci.com/bugsnag/bugsnag-build-reporter-node)

[![NPM](https://img.shields.io/npm/v/bugsnag-build-reporter.svg)](https://npmjs.org/package/bugsnag-build-reporter)

A tool for reporting your application's builds to Bugsnag. It can auto detect source control from `.git`, `.hg` and `package.json`.

If you are using any of the following tools in your build, you may find the following modules (that use this one under the hood) more convenient:

| Webpack | [webpack-bugsnag-plugins](https://github.com/bugsnag/webpack-bugsnag-plugins) | [![NPM](https://img.shields.io/npm/v/webpack-bugsnag-plugins.svg)](https://npmjs.org/package/webpack-bugsnag-plugins)

| Gulp    | [gulp-bugsnag](https://github.com/bugsnag/gulp-bugsnag) | [![NPM](https://img.shields.io/npm/v/gulp-bugsnag.svg)](https://npmjs.org/package/gulp-bugsnag) |

| Grunt   | [grunt-bugsnag](https://github.com/bugsnag/grunt-bugsnag) | [![NPM](https://img.shields.io/npm/v/grunt-bugsnag.svg)](https://npmjs.org/package/grunt-bugsnag) |

`bugsnag-build-reporter` should be used directly if your application is built by:

- some arbitrary Node-based environment (e.g. a build tool not listed above or something custom)

- a command based tool (e.g. npm scripts, make)

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

To use the JS API, install this module as a development dependency of your project:

const reportBuild = require('bugsnag-build-reporter')

reportBuild({ apiKey: 'YOUR_API_KEY', appVersion: '1.2.3' }, { /* opts */ })

  .catch(err => console.log('fail', err.messsage))

##### `reportBuild(build: object, opts: object) => Promise`

- `build` describes the build you are reporting to Bugsnag

  - `apiKey: string` your Bugsnag API key __[required]__

  - `appVersion: string` the version of the application you are building __[required]__

  - `releaseStage: string` `'production'`, `'staging'` etc. (leave blank if this build can be released to different `releaseStage`s)

  - `sourceControl: object` an object describing the source control of the build (if not specified, the module will attempt to detect source control information from `.git`, `.hg` and the nearest `package.json`)

    - `provider: string` can be one of: `'github'`, `'github-enterprise'`, `'gitlab'`, `'gitlab-onpremise'`, `'bitbucket'`, `'bitbucket-server'`

    - `repository: string` a URL (`git`/`ssh`/`https`) pointing to the repository, or webpage representing the repository

    - `revision: string` the unique identifier for the commit (e.g. git SHA)

  - `builderName: string` the name of the person/machine that created this build (defaults to the result of the `whoami` command)

  - `autoAssignRelease: boolean` automatically associate this build with any new error events and sessions that are received for the `releaseStage` until a subsequent build notification is received. If this is set to `true` and no `releaseStage` is provided the build will be applied to `'production'`.

  - `appVersionCode: string` if you're using this module to report Android app builds, set this option

  - `appBundleVersion: string` if you're using this module to report iOS/macOS/AppleTV app builds, set this option

  - `logLevel: string` the minimum severity of log to output (`'debug'`, `'info'`, `'warn'`, `'error'`)

  - `logger: object` provide a different logger object `{ debug, info, warn, error }`

  - `path: string` the path to search for source control info, defaults to `process.cwd()`

  - `endpoint: string` post the build payload to a URL other than the default (`https://build.bugsnag.com`)

_If installed locally, recent versions of npm come with a tool called [`npx`](https://github.com/zkat/npx) which will help run it without typing burdensome paths._

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

  --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)

  --builder-name, -n  Set the name of the entity that triggered the build

  --auto-assign-release, -a  Assign any subsequent error reports received to this release

  --endpoint, -u Specify an alternative endpoint

  --app-version-code, -c  Set the version code (Android only)

  --app-bundle-version, -b  Set the bundle version (iOS/macOS/tvOS only)

  Arbitrary "key=value" pairs will be passed to the build API as metadata

  --api-key cc814aead128d38d0767094327b4784a \

		# Changelog

		## 1.0.3 (2020-04-07)

		- Prefer remote named `origin` when detecting source control info (#7)

		## 1.0.2 (2019-05-23)
		@@ -4,0 +8,0 @@

		{
		"name": "bugsnag-build-reporter",
		"version": "1.0.2",
		"version": "1.0.3",
		"description": "A tool for reporting your application’s builds to Bugsnag",
		@@ -5,0 +5,0 @@ "keywords": [

Fixed alerts

Improved metrics

		@@ -83,2 +83,9 @@ const findNearest = require('find-nearest-file')
		cb => exec('git rev-parse HEAD', { cwd }, cb),
		cb => {
		// eslint-disable-next-line
		exec('git remote get-url origin', { cwd }, (err, data) => {
		// ignore this error in case origin doesn't exist
		cb(null, data)
		})
		},
		cb => exec('git remote -v', { cwd }, cb)
		@@ -88,3 +95,3 @@ ], (err, data) => {
		revision: data[0] ? data[0].trim() : null,
		repository: data[1] ? data[1].split(/\t\|\s\|\n/)[1] : null
		repository: data[1] ? data[1].trim() : (data[2] ? data[2].split(/\t\|\s\|\n/)[1] : null)
		})
		@@ -91,0 +98,0 @@ })

		# bugsnag-build-reporter
		[![Build status](https://travis-ci.org/bugsnag/bugsnag-build-reporter-node.svg?branch=master)](https://travis-ci.org/bugsnag/bugsnag-build-reporter-node)
		[![Build status](https://travis-ci.com/bugsnag/bugsnag-build-reporter-node.svg?branch=master)](https://travis-ci.com/bugsnag/bugsnag-build-reporter-node)
		[![NPM](https://img.shields.io/npm/v/bugsnag-build-reporter.svg)](https://npmjs.org/package/bugsnag-build-reporter)
		@@ -4,0 +4,0 @@