Skip to content
This repository was archived by the owner on Dec 8, 2020. It is now read-only.

Commit 4d8b348

Browse files
committed
Add UPGRADING.md
1 parent 6361ebc commit 4d8b348

File tree

2 files changed

+52
-1
lines changed

2 files changed

+52
-1
lines changed

CHANGELOG.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
77

88
## [Unreleased]
99

10+
## [3.0.0] - 2019-03-28
11+
1012
### Changed
1113

1214
- Timber's Rails integration has been moved to the optional `timber_rails` gem: https://github.com/timberio/timber-ruby-rails
@@ -134,7 +136,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
134136
instead of applying back pressure.
135137

136138

137-
[Unreleased]: https://github.com/timberio/timber-ruby/compare/v2.6.1...HEAD
139+
[Unreleased]: https://github.com/timberio/timber-ruby/compare/v3.0.0...HEAD
140+
[3.0.0]: https://github.com/timberio/timber-ruby/compare/v2.6.1...v3.0.0
138141
[2.6.1]: https://github.com/timberio/timber-ruby/compare/v2.6.0...v2.6.1
139142
[2.6.0]: https://github.com/timberio/timber-ruby/compare/v2.5.1...v2.6.0
140143
[2.5.1]: https://github.com/timberio/timber-ruby/compare/v2.5.0...v2.5.1

UPGRADING.md

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Upgrading
2+
3+
## 2.x to 3.x
4+
5+
### Overview
6+
7+
We're excited to announce the 3.X line of Timber for Ruby! We've been making big
8+
strides with Timber as a whole and 3.X represents a lot of big improvements:
9+
10+
- A lighter code base
11+
- Better performance
12+
- A simpler, better install process and strategy
13+
- New docs: https://docs.timber.io/setup/languages/ruby
14+
- New integration libraries focused on the specific library they're integrating with
15+
16+
- https://github.com/timberio/timber-ruby-rack
17+
- https://github.com/timberio/timber-ruby-rails
18+
19+
Outside of that, 3.0 does not introduce any API changes, and is forward compatbile
20+
in that regard. This means actions like setting context and logging structured data
21+
will continue to work as expected.
22+
23+
### Rails
24+
25+
If you're on Rails, the upgrade process is simple. Simply add the `timber-rails`
26+
gem to your `Gemfile`:
27+
28+
```
29+
gem 'timber-rails', '~> 1.0'
30+
```
31+
32+
That's it! Everything is taken care of you via a Rails initializer.
33+
34+
More info: https://docs.timber.io/setup/languages/ruby/integrations/rack
35+
36+
### Non-rails
37+
38+
If you're not on rails, and you're using `Rack`, you'll want to install the
39+
`timber-rack` gem by adding it to your `Gemfile`:
40+
41+
```
42+
gem 'timber-rack', '~> 1.0'
43+
```
44+
45+
That's it! The middleware class names are still the same and should not
46+
require any altering.
47+
48+
More info: https://docs.timber.io/setup/languages/ruby/integrations/rack

0 commit comments

Comments
 (0)