Skip to content

Commit

Permalink
Add an upgrade guide (#370)
Browse files Browse the repository at this point in the history
  • Loading branch information
kattrali authored Sep 20, 2017
1 parent f484dbf commit 403d8fa
Showing 1 changed file with 57 additions and 0 deletions.
57 changes: 57 additions & 0 deletions UPGRADING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# Upgrade Guide

## 5.x to 6.x

_Our Ruby library has gone through some major improvements and there are a few
changes required to use the new integrations_

#### Capistrano and deploys

Support for notifying Bugsnag of deployments has been separated into a separate
gem named `bugsnag-capistrano`. See the [integration
guide](https://docs.bugsnag.com/platforms/ruby/capistrano) for more information.


#### Configuration

* `Configuration.use_ssl` has been removed. Include the preferred protocol in `Configuration.endpoint` instead.
```diff
Bugsnag.configure do |config|
- config.use_ssl = true
- config.endpoint = 'myserver.example.com'
+ config.endpoint = 'https://myserver.example.com'
end
```
* `Configuration.ignore_classes` now no longer accepts strings. Use classes directly instead.
* `Configuration.delay_with_resque` has been removed
* `Configuration.vendor_paths` has been removed
* `Configuration.params_filters` has been renamed to `Configuration.meta_data_filters` to be clearer

#### Notifying

* `notify` now only supports block syntax. Replace usage of the overrides hash with a block

```diff
- Bugsnag.notify(e, {severity: 'info'})
+ Bugsnag.notify(e) do |report|
+ report.severity = 'info'
+ end
```

* `Bugsnag.notify_or_ignore` and `Bugsnag.auto_notify` have been removed removed. Call `notify` directly instead.
* `after_notify_callbacks` has been removed
* `Bugsnag::Notification` has been renamed to `Bugsnag::Report`

#### Logging

* `config.debug` boolean has been removed. Set the logger level directly

```diff
+ require 'logger'

Bugsnag.configure do |config|
# .. set API key and other properties
- config.debug = true
+ config.logger.level = Logger::DEBUG
end
```

0 comments on commit 403d8fa

Please sign in to comment.