diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index d0612954..1c07a213 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -88,4 +88,16 @@ cd ../.. DB=postgres bundle exec rake ``` +### Releases + +1. Set the version in lib/paper_trail/version_number.rb + - Set PRE to nil unless it's a pre-release (beta, rc, etc.) +1. In the changelog, replace "Unreleased" with the date. +1. In the readme, + - remove "unreleased" from the doc versions table + - update any other references to version number +1. Commit and tag with `git tag -a -m "v5.0.0" "v5.0.0"` +1. `git push --tags origin master` +1. `gem push paper_trail` + [1]: https://github.com/airblade/paper_trail/blob/master/doc/bug_report_template.rb diff --git a/CHANGELOG.md b/CHANGELOG.md index eac46037..f169d7a2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,4 @@ -## 5.0.0 (Unreleased) +## 5.0.0 (2016-05-02) ### Breaking Changes diff --git a/README.md b/README.md index addaec71..36027d99 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ has been destroyed. | Version | Documentation | | -------------- | ------------- | -| 5 (unreleased) | https://github.com/airblade/paper_trail/blob/master/README.md | +| 5 | https://github.com/airblade/paper_trail/blob/master/README.md | | 4.1 | https://github.com/airblade/paper_trail/blob/4.1-stable/README.md | | 4.0 | https://github.com/airblade/paper_trail/blob/4.0-stable/README.md | | 3 | https://github.com/airblade/paper_trail/blob/3.0-stable/README.md | @@ -48,7 +48,7 @@ has been destroyed. | paper_trail | branch | tags | ruby | activerecord | | -------------- | ---------- | ------ | -------- | ------------ | -| 5 (unreleased) | master | none | >= 1.9.3 | >= 3.0, < 6 | +| 5 | master | v5.x | >= 1.9.3 | >= 3.0, < 6 | | 4 | 4.0-stable | v4.x | >= 1.8.7 | >= 3.0, < 6 | | 3 | 3.0-stable | v3.x | >= 1.8.7 | >= 3.0, < 5 | | 2 | 2.7-stable | v2.x | >= 1.8.7 | >= 3.0, < 4 | @@ -194,7 +194,7 @@ Widget.paper_trail_enabled_for_model? widget.paper_trail_enabled_for_model? ``` -And a `PaperTrail::Version` instance (which is just an ordinary ActiveRecord +And a `PaperTrail::Version` instance (which is just an ordinary ActiveRecord instance, with all the usual methods) adds these methods: ```ruby @@ -1397,7 +1397,7 @@ setting up your app with PaperTrail will look something like this: 1. Add PaperTrail to your `Gemfile`. - `gem 'paper_trail', '~> 4.0.0'` + `gem 'paper_trail'` 2. Generate a migration to add a `versions` table to your database. diff --git a/lib/paper_trail/version_number.rb b/lib/paper_trail/version_number.rb index b53d1d66..e64ab341 100644 --- a/lib/paper_trail/version_number.rb +++ b/lib/paper_trail/version_number.rb @@ -4,7 +4,7 @@ module PaperTrail MAJOR = 5 MINOR = 0 TINY = 0 - PRE = "pre".freeze + PRE = nil STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".").freeze