RELEASING.md in slack-ruby-bot-server-0.6.0 vs RELEASING.md in slack-ruby-bot-server-0.6.1
- old
+ new
@@ -1,8 +1,8 @@
# Releasing Slack-Ruby-Bot-Server
-There're no hard rules about when to release slack-ruby-bot-server. Release bug fixes frequenty, features not so frequently and breaking API changes rarely.
+There're no hard rules about when to release slack-ruby-bot-server. Release bug fixes frequently, features not so frequently and breaking API changes rarely.
### Release
Run tests, check that all tests succeed locally.
@@ -11,29 +11,30 @@
rake
```
Check that the last build succeeded in [Travis CI](https://travis-ci.org/slack-ruby/slack-ruby-bot-server) for all supported platforms.
-Increment the version, modify [lib/slack-ruby-bot-server/version.rb](lib/slack-ruby-bot-server/version.rb).
+Change "Next" in [CHANGELOG.md](CHANGELOG.md) to the current date.
-* Increment the third number if the release has bug fixes and/or very minor features, only (eg. change `0.2.1` to `0.2.2`).
-* Increment the second number if the release contains major features or breaking API changes (eg. change `0.2.1` to `0.3.0`).
-
-Change "Next Release" in [CHANGELOG.md](CHANGELOG.md) to the new version.
-
```
### 0.2.2 (7/10/2015)
```
Remove the line with "Your contribution here.", since there will be no more contributions to this release.
-Remove the "Stable Release" section in README that warns users that they are reading the documentation for an unreleased version.
+Change `**next**` in the "Stable Release" section in README that warns users that they are reading the documentation for an unreleased version with `**stable**`.
+```
+## Stable Release
+
+You're reading the documentation for the **stable** release of slack-ruby-bot-server, 0.2.2. See [UPGRADING](UPGRADING.md) when upgrading from an older version.
+```
+
Commit your changes.
```
-git add README.md CHANGELOG.md lib/slack-ruby-bot-server/version.rb
+git add README.md CHANGELOG.md
git commit -m "Preparing for release, 0.2.2."
git push origin master
```
Release.
@@ -50,20 +51,27 @@
### Prepare for the Next Version
Add the next release to [CHANGELOG.md](CHANGELOG.md).
```
-Next Release
-============
+### 0.2.3 (Next)
* Your contribution here.
```
Increment the third version number in [lib/slack-ruby-bot-server/version.rb](lib/slack-ruby-bot-server/version.rb).
-Comit your changes.
+Undo your change in README about the stable release.
```
-git add CHANGELOG.md lib/slack-ruby-bot-server/version.rb
+## Stable Release
+
+You're reading the documentation for the **next** release of slack-ruby-bot-server. Please see the documentation for the [last stable release, v0.2.2](https://github.com/slack-ruby/slack-ruby-bot-server/blob/v0.2.2/README.md) unless you're integrating with HEAD. See [UPGRADING](UPGRADING.md) when upgrading from an older version.
+```
+
+Commit your changes.
+
+```
+git add README.md CHANGELOG.md lib/slack-ruby-bot-server/version.rb
git commit -m "Preparing for next development iteration, 0.2.3."
git push origin master
```