RELEASING.md
# Releasing Grape-Swagger
There're no particular rules about when to release grape-swagger. Release bug fixes frequenty, 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/ruby-grape/grape-swagger) for all supported platforms.
Increment the version, modify [lib/grape-swagger/version.rb](lib/grape-swagger/version.rb).
* Increment the third number if the release has bug fixes and/or very minor features, only (eg. change `0.7.1` to `0.7.2`).
* Increment the second number if the release contains major features or breaking API changes (eg. change `0.7.1` to `0.8.0`).
Change "Next Release" in [CHANGELOG.md](CHANGELOG.md) to the new version.
```
### 0.7.2 (February 6, 2014)
```
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/grape-swagger/version.rb
git commit -m "Preparing for release, 0.7.2."
git push origin master
```
Release.
```
$ rake release
grape-swagger 0.7.2 built to pkg/grape-swagger-0.7.2.gem.
Tagged v0.7.2.
Pushed git commits and tags.
Pushed grape-swagger 0.7.2 to rubygems.org.
```
### Prepare for the Next Version
Add the next release to [CHANGELOG.md](CHANGELOG.md).
```
Next Release
============
* Your contribution here.
```
Comit your changes.
```
git add CHANGELOG.md
git commit -m "Preparing for next release."
git push origin master
```
### Make an Announcement
Make an announcement on the [ruby-grape@googlegroups.com](mailto:ruby-grape@googlegroups.com) mailing list. The general format is as follows.
```
Grape-Swagger 0.7.2 has been released.
There were 8 contributors to this release, not counting documentation.
Please note the breaking API change in ...
[copy/paste CHANGELOG here]
```