Documentation and Support
For comprehensive documentation and support, check out our documentation site.
- Fork it.
- Create a topic branch
git checkout -b my_branch
- Commit your changes
git commit -am "Boom"
- Push to your branch
git push origin my_branch
- Send a pull request
- To run the test suite by itself, use
- To run the tests across all supported platforms, set up a BrowserStack
account and use
BROWSERSTACK_USERNAME=your_username BROWSERSTACK_ACCESS_KEY=your-access-key npm run test:ci.
Releasing is done with two commands:
npm version and
npm publish. Both
commands should be used with care. The
npm publish command publishes to NPM
and to our js.honeybadger.io CDN (hosted on AWS via S3/CloudFront).
For the CDN release, make sure you have the following environment variable available in your shell:
export HONEYBADGER_JS_S3_BUCKET=honeybadger-js export HONEYBADGER_DISTRIBUTION_ID=cloudfront-id
AWS credentials are read from ~/.aws/credentials, using the default profile.
To perform a full release:
With a clean working tree, use
npm version [new version]to bump the version, commit the changes, tag the release, and push to GitHub. See
npm help versionfor documentation.
To publish the release, use
npm publish. See
npm help publishfor documentation.
If the CDN release fails for some reason (bad AWS credentials, for instance),
re-run the release manually with
npm run release-cdn.
The Honeybadger gem is MIT licensed. See the MIT-LICENSE file in this repository for details.
We use BrowserStack to run our automated integration tests on multiple platforms in CI.