Preparing for release, 5.1.0.

CHANGELOG.md

@@ -1,20 +1,19 @@
-# 5.1.0 (Next)
+### 5.1.0 (2017/06/04)
 
 * [#50](https://github.com/mongoid/mongoid_orderable/pull/50): Added Danger, PR linter - [@dblock](https://github.com/dblock).
 * [#51](https://github.com/mongoid/mongoid_orderable/pull/51): Added RuboCop - [@dblock](https://github.com/dblock).
 * [#49](https://github.com/mongoid/mongoid_orderable/pull/49): Fix orderable on embedded documents inside an inherited model - [@rafaelgaspar](https://github.com/rafaelgaspar).
-* Your contribution here.
 
-# 5.0.0 (2015/10/21)
+### 5.0.0 (2015/10/21)
 
 * [#41](https://github.com/mongoid/mongoid_orderable/pull/41): Mongoid 5 support - [@dblock](https://github.com/dblock).
 * [#41](https://github.com/mongoid/mongoid_orderable/pull/41): Dropped support for ruby 1.8 - [@dblock](https://github.com/dblock).
 
-# 4.1.1 (2014/12/19)
+### 4.1.1 (2014/12/19)
 
 * [#34](https://github.com/mongoid/mongoid_orderable/pull/34): Fix: index should respect scope - [@joeyAghion](https://github.com/joeyAghion).
 
-# 4.1.0 (2014/3/19)
+### 4.1.0 (2014/3/19)
 
 * [#30](https://github.com/mongoid/mongoid_orderable/pull/30): Fix: reset a single column when `orderable_scope` changed instead of removing it from list - [@Bharat311](https://github.com/Bharat311).
 * [#29](https://github.com/mongoid/mongoid_orderable/pull/29): Fix: incorrect position when orderable base is set - [@Bharat311](https://github.com/Bharat311).
@@ -26,29 +25,29 @@
 * [#20](https://github.com/mongoid/mongoid_orderable/pull/20): Added next and previous item methods - [@mrjlynch](https://github.com/mrjlynch).
 * [#19](https://github.com/mongoid/mongoid_orderable/pull/19): Added lower and higher item methods - [@mrjlynch](https://github.com/mrjlynch).
 
-# 4.0.0 (2013/10/22)
+### 4.0.0 (2013/10/22)
 
 * [#18](https://github.com/mongoid/mongoid_orderable/pull/18): Added Mongoid 4 support - [@dblock](https://github.com/dblock).
 * [#16](https://github.com/mongoid/mongoid_orderable/pull/16): Fix for Mongoid identity map combined with scoped orderable - [@johnnyshields](https://github.com/johnnyshields).
 * [#15](https://github.com/mongoid/mongoid_orderable/pull/15): Support pass-thru of Mongoid field alias (`:as` parameter) - [@johnnyshields](https://github.com/johnnyshields).
 * [#13](https://github.com/mongoid/mongoid_orderable/pull/13): Support inheritance - [@zhengjia](https://github.com/zhengjia).
 
-# 1.2.0 (2013/1/10)
+### 1.2.0 (2013/1/10)
 
 * [#12](https://github.com/mongoid/mongoid_orderable/pull/12): Added support for "base" in config options, in order to do a zero-based position - [@johnnyshields](https://github.com/johnnyshields).
 
-# 1.1.0 (2012/5/23)
+### 1.1.0 (2012/5/23)
 
 * Added Mongoid 3 support - [@pyromaniac](https://github.com/pyromaniac).
 
-# 1.0.0 (2012/2/14)
+### 1.0.0 (2012/2/14)
 
 * [#5](https://github.com/mongoid/mongoid_orderable/pull/5): Allow for use with default scopes - [@mattiassvedhem](https://github.com/mattiassvedhem).
 
-# 0.9.1 (2012/2/3)
+### 0.9.1 (2012/2/3)
 
-# 0.9.0 (2011/11/23)
+### 0.9.0 (2011/11/23)
 
-# 0.0.1 (2011/11/1)
+### 0.0.1 (2011/11/1)
 
 * Initial public release - [@pyromaniac](https://github.com/pyromaniac).

RELEASING.md

@@ -0,0 +1,68 @@
+Releasing Mongoid::Orderable
+============================
+
+There're no particular rules about when to release mongoid_orderable. Release bug fixes frequently, features not so frequently and breaking API changes rarely.
+
+### Release
+
+Run tests, check that all tests succeed locally.
+
+```
+bundle install
+rake
+```
+
+Check that the last build succeeded in [Travis CI](https://travis-ci.org/mongoid/mongoid_orderable) for all supported platforms.
+
+Increment the version, modify [lib/mongoid_orderable/version.rb](lib/mongoid_orderable/version.rb).
+
+*  Increment the third number if the release has bug fixes and/or very minor features, only (eg. change `0.5.1` to `0.5.2`).
+*  Increment the second number if the release contains major features or breaking API changes (eg. change `0.5.1` to `0.4.0`).
+
+Change "Next Release" in [CHANGELOG.md](CHANGELOG.md) to the new version.
+
+```
+### 0.4.0 (2014-01-27)
+```
+
+Remove the line with "Your contribution here.", since there will be no more contributions to this release.
+
+Commit your changes.
+
+```
+git add CHANGELOG.md lib/mongoid_orderable/version.rb
+git commit -m "Preparing for release, 0.4.0."
+git push origin master
+```
+
+Release.
+
+```
+$ rake release
+
+mongoid_orderable 0.4.0 built to pkg/mongoid_orderable-0.4.0.gem.
+Tagged v0.4.0.
+Pushed git commits and tags.
+Pushed mongoid_orderable 0.4.0 to rubygems.org.
+```
+
+### Prepare for the Next Version
+
+Add the next release to [CHANGELOG.md](CHANGELOG.md).
+
+```
+Next Release
+============
+
+* Your contribution here.
+```
+
+Increment the minor version, modify [lib/mongoid_orderable/version.rb](lib/mongoid_orderable/version.rb).
+
+Commit your changes.
+
+```
+git add CHANGELOG.md lib/mongoid_orderable/version.rb
+git commit -m "Preparing for next release, 0.4.1."
+git push origin master
+```

lib/mongoid_orderable/version.rb

@@ -1,3 +1,3 @@
 module MongoidOrderable
-  VERSION = '5.0.0'.freeze
+  VERSION = '5.1.0'.freeze
 end