Change next targeted release from '3.1.0' to '4.0' in attempt to embrace semantic versioning [ci skip]
The next release will contain backwards incompatible changes when used with Rails, so this is important
This commit is contained in:
parent
3a17367845
commit
39e1e56374
|
@ -1,4 +1,4 @@
|
||||||
## 3.1.0 (Unreleased)
|
## 4.0.0 (Unreleased)
|
||||||
|
|
||||||
##### Breaking change: if you use a custom initializer for PaperTrail in conjunction with Rails, you will need to add this line of code to the beginning of it:
|
##### Breaking change: if you use a custom initializer for PaperTrail in conjunction with Rails, you will need to add this line of code to the beginning of it:
|
||||||
```ruby
|
```ruby
|
||||||
|
@ -38,7 +38,7 @@ PaperTrail::Rails::Engine.eager_load!
|
||||||
|
|
||||||
- [#401](https://github.com/airblade/paper_trail/issues/401) / [#406](https://github.com/airblade/paper_trail/issues/406)
|
- [#401](https://github.com/airblade/paper_trail/issues/401) / [#406](https://github.com/airblade/paper_trail/issues/406)
|
||||||
`PaperTrail::Version` class is not loaded via a `Rails::Engine`, even when the gem is used with in Rails. This feature has
|
`PaperTrail::Version` class is not loaded via a `Rails::Engine`, even when the gem is used with in Rails. This feature has
|
||||||
will be re-introduced in version `3.1.0`.
|
will be re-introduced in version `4.0`.
|
||||||
- [#398](https://github.com/airblade/paper_trail/pull/398) - Only require the `RSpec` helper if `RSpec::Core` is required.
|
- [#398](https://github.com/airblade/paper_trail/pull/398) - Only require the `RSpec` helper if `RSpec::Core` is required.
|
||||||
|
|
||||||
## 3.0.3
|
## 3.0.3
|
||||||
|
@ -94,8 +94,8 @@ in the `PaperTrail::Version` class through a `Rails::Engine` when the gem is use
|
||||||
- [#312](https://github.com/airblade/paper_trail/issues/312) - Fix RSpec `with_versioning` class level helper method.
|
- [#312](https://github.com/airblade/paper_trail/issues/312) - Fix RSpec `with_versioning` class level helper method.
|
||||||
- `model_instance.without_versioning` now yields the `model_instance`, enabling syntax like this:
|
- `model_instance.without_versioning` now yields the `model_instance`, enabling syntax like this:
|
||||||
`model_instance.without_versioning { |obj| obj.update_attributes(:name => 'value') }`.
|
`model_instance.without_versioning { |obj| obj.update_attributes(:name => 'value') }`.
|
||||||
- Deprecated `Model.paper_trail_on` and `Model.paper_trail_off` in favor of bang versions of the methods. Deprecation warning
|
- Deprecated `Model.paper_trail_on` and `Model.paper_trail_off` in favor of bang versions of the methods.
|
||||||
informs users that the non-bang versions of the methods will be removed in version `3.1.0`.
|
Deprecation warning informs users that the non-bang versions of the methods will be removed in version `4.0`
|
||||||
|
|
||||||
## 3.0.0
|
## 3.0.0
|
||||||
|
|
||||||
|
|
|
@ -30,7 +30,7 @@ There's an excellent [RailsCast on implementing Undo with Paper Trail](http://ra
|
||||||
|
|
||||||
## Compatibility
|
## Compatibility
|
||||||
|
|
||||||
Works with ActiveRecord 4 and ActiveRecord 3. Note: this code is on the `master` branch and tagged `v3.x`.
|
Works with `ActiveRecord` 3+. Note: this code is on the `master` branch and tagged `v4.x`.
|
||||||
|
|
||||||
Version 2 is on the branch named [`2.7-stable`](https://github.com/airblade/paper_trail/tree/2.7-stable) and is tagged `v2.x`, and works with Rails 3.
|
Version 2 is on the branch named [`2.7-stable`](https://github.com/airblade/paper_trail/tree/2.7-stable) and is tagged `v2.x`, and works with Rails 3.
|
||||||
|
|
||||||
|
@ -495,7 +495,7 @@ You can avoid having to do this manually by setting your initializer to pick up
|
||||||
```ruby
|
```ruby
|
||||||
# config/initializers/paper_trail.rb
|
# config/initializers/paper_trail.rb
|
||||||
|
|
||||||
# the following line is required for PaperTrail >= 3.1.0 with Rails
|
# the following line is required for PaperTrail >= 4.0.0 with Rails
|
||||||
PaperTrail::Rails::Engine.eager_load!
|
PaperTrail::Rails::Engine.eager_load!
|
||||||
|
|
||||||
if defined?(::Rails::Console)
|
if defined?(::Rails::Console)
|
||||||
|
@ -575,7 +575,7 @@ If you only use custom version classes and don't use PaperTrail's built-in one,
|
||||||
```ruby
|
```ruby
|
||||||
# config/initializers/paper_trail.rb
|
# config/initializers/paper_trail.rb
|
||||||
|
|
||||||
# the following line is required for PaperTrail >= 3.1.0 with Rails
|
# the following line is required for PaperTrail >= 4.0.0 with Rails
|
||||||
PaperTrail::Rails::Engine.eager_load!
|
PaperTrail::Rails::Engine.eager_load!
|
||||||
|
|
||||||
PaperTrail::Version.module_eval do
|
PaperTrail::Version.module_eval do
|
||||||
|
@ -771,7 +771,7 @@ For example:
|
||||||
```ruby
|
```ruby
|
||||||
# config/initializers/paper_trail.rb
|
# config/initializers/paper_trail.rb
|
||||||
|
|
||||||
# the following line is required for PaperTrail >= 3.1.0 with Rails
|
# the following line is required for PaperTrail >= 4.0.0 with Rails
|
||||||
PaperTrail::Rails::Engine.eager_load!
|
PaperTrail::Rails::Engine.eager_load!
|
||||||
|
|
||||||
module PaperTrail
|
module PaperTrail
|
||||||
|
|
|
@ -91,7 +91,7 @@ module PaperTrail
|
||||||
end
|
end
|
||||||
|
|
||||||
def paper_trail_off
|
def paper_trail_off
|
||||||
warn "DEPRECATED: use `paper_trail_off!` instead of `paper_trail_off`. Support for `paper_trail_off` will be removed in PaperTrail 3.1"
|
warn "DEPRECATED: use `paper_trail_off!` instead of `paper_trail_off`. Support for `paper_trail_off` will be removed in PaperTrail 4.0"
|
||||||
self.paper_trail_off!
|
self.paper_trail_off!
|
||||||
end
|
end
|
||||||
|
|
||||||
|
@ -101,7 +101,7 @@ module PaperTrail
|
||||||
end
|
end
|
||||||
|
|
||||||
def paper_trail_on
|
def paper_trail_on
|
||||||
warn "DEPRECATED: use `paper_trail_on!` instead of `paper_trail_on`. Support for `paper_trail_on` will be removed in PaperTrail 3.1"
|
warn "DEPRECATED: use `paper_trail_on!` instead of `paper_trail_on`. Support for `paper_trail_on` will be removed in PaperTrail 4.0"
|
||||||
self.paper_trail_on!
|
self.paper_trail_on!
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
module PaperTrail
|
module PaperTrail
|
||||||
module VERSION
|
module VERSION
|
||||||
MAJOR = 3
|
MAJOR = 4
|
||||||
MINOR = 1
|
MINOR = 0
|
||||||
TINY = 0
|
TINY = 0
|
||||||
PRE = 'alpha'
|
PRE = 'alpha'
|
||||||
|
|
||||||
|
|
|
@ -274,7 +274,7 @@ describe Widget, :type => :model do
|
||||||
end
|
end
|
||||||
|
|
||||||
it 'should display a deprecation warning' do
|
it 'should display a deprecation warning' do
|
||||||
is_expected.to receive(:warn).with("DEPRECATED: use `paper_trail_on!` instead of `paper_trail_on`. Support for `paper_trail_on` will be removed in PaperTrail 3.1")
|
is_expected.to receive(:warn).with("DEPRECATED: use `paper_trail_on!` instead of `paper_trail_on`. Support for `paper_trail_on` will be removed in PaperTrail 4.0")
|
||||||
subject.paper_trail_on
|
subject.paper_trail_on
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
@ -303,7 +303,7 @@ describe Widget, :type => :model do
|
||||||
end
|
end
|
||||||
|
|
||||||
it 'should display a deprecation warning' do
|
it 'should display a deprecation warning' do
|
||||||
is_expected.to receive(:warn).with("DEPRECATED: use `paper_trail_on!` instead of `paper_trail_on`. Support for `paper_trail_on` will be removed in PaperTrail 3.1")
|
is_expected.to receive(:warn).with("DEPRECATED: use `paper_trail_on!` instead of `paper_trail_on`. Support for `paper_trail_on` will be removed in PaperTrail 4.0")
|
||||||
subject.paper_trail_on
|
subject.paper_trail_on
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
Loading…
Reference in New Issue