bhb / honeybadger-ruby

Ruby gem for reporting errors to honeybadger.io

Honeybadger for Ruby

This is the notifier gem for integrating apps with the ⚡ Honeybadger Exception Notifier for Ruby and Rails.

When an uncaught exception occurs, Honeybadger will POST the relevant data to the Honeybadger server specified in your environment.

Documentation and Support

For comprehensive documentation and support, check out our documentation site.

Changelog

See https://github.com/honeybadger-io/honeybadger-ruby/blob/master/CHANGELOG.md

Development

Pull requests are welcome. If you're adding a new feature, please submit an issue as a preliminary step; that way you can be (moderately) sure that your pull request will be accepted.

If you're integrating your gem/open source project with Honeybadger, please consider submitting an official plugin to our gem. Submit an issue to discuss with us!

We use YARD to document our API. Classes and methods which are safe to depend on in your gems/projects are marked "Public". All other classes/methods are considered internal and may change without notice -- don't depend on them! If you need a new public API, we're happy to work with you. Submit an issue to discuss.

To contribute your code:

1. Fork it.
2. Create a topic branch git checkout -b my_branch
3. Make your changes and add an entry to the CHANGELOG.
4. Commit your changes git commit -am "Boom"
5. Push to your branch git push origin my_branch
6. Send a pull request

Running the tests

We're using the Appraisal gem to run our RSpec test suite against multiple versions of Rails.

• The unit test suite can be run with rake spec:units.
• The integration test suite can be run with rake spec:features.
• The combined suite can be run with rake.

Releasing

To release a new [patch] version:

1. With a clean working tree, use rake bump:patch to bump the version and stage the changes (you can make additional manual changes at this point if necessary).
2. Use rake release to run the tests, commit/tag the release, build the gem, and push to GitHub/RubyGems.

See rake -T for additional tasks.

License

The Honeybadger gem is MIT licensed. See the LICENSE file in this repository for details.