slack-ruby/slack-ruby-bot

View on GitHub
RELEASING.md

Summary

Maintainability
Test Coverage
# Releasing Slack-Ruby-Bot

There are no particular rules about when to release slack-ruby-bot. Release bug fixes frequently, features not so frequently and breaking API changes rarely.

### Release

Run tests, check that all tests succeed locally.

```
export CONCURRENCY=async-websocket
bundle install
rake
```

Check that the last build succeeded in [Travis CI](https://travis-ci.org/slack-ruby/slack-ruby-bot) for all supported platforms.

If needed, increment the version, modify [lib/slack-ruby-bot/version.rb](lib/slack-ruby-bot/version.rb).

*  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`).

Add today's date to the 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.

In the "Stable Release" section of the README, change **next** to **stable** so users know that they are reading the documentation for a released version.

```
## Stable Release

You're reading the documentation for the **stable** release of slack-ruby-bot, 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/version.rb
git commit -m "Preparing for release, 0.2.2."
git push origin master
```

Release.

```
$ rake release

slack-ruby-bot 0.2.2 built to pkg/slack-ruby-bot-0.2.2.gem.
Tagged v0.2.2.
Pushed git commits and tags.
Pushed slack-ruby-bot 0.2.2 to rubygems.org.
```

### Prepare for the Next Version

Add the next release to [CHANGELOG.md](CHANGELOG.md).

```
### 0.2.3 (Next)

* Your contribution here.
```

Increment the third version number in [lib/slack-ruby-bot/version.rb](lib/slack-ruby-bot/version.rb).

Undo your change in README about the stable release.

```
## Stable Release

You're reading the documentation for the **next** release of slack-ruby-bot.
Please see the documentation for the [last stable release, v0.2.2](https://github.com/slack-ruby/slack-ruby-bot/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 CHANGELOG.md lib/slack-ruby-bot/version.rb
git commit -m "Preparing for next development iteration, 0.2.3."
git push origin master
```