Skip to content

Commit 3319756

Browse files
committed
Added RELEASING instructions.
1 parent 590a029 commit 3319756

File tree

1 file changed

+65
-0
lines changed

1 file changed

+65
-0
lines changed

RELEASING.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# Releasing Grape-Swagger-Rails
2+
3+
There're no particular rules about when to release grape-swagger-rails. Release bug fixes frequenty, features not so frequently and breaking API changes rarely.
4+
5+
### Release
6+
7+
Run tests, check that all tests succeed locally.
8+
9+
```
10+
bundle install
11+
rake
12+
```
13+
14+
Check that the last build succeeded in [Travis CI](https://travis-ci.org/TinkerDev/grape-swagger-rails) for all supported platforms.
15+
16+
Increment the version, modify [lib/grape-swagger-rails/version.rb](lib/grape-swagger-rails/version.rb).
17+
18+
* Increment the third number if the release has bug fixes and/or very minor features, only (eg. change `0.1.0` to `0.1.1`).
19+
* Increment the second number if the release contains major features or breaking API changes (eg. change `0.1.0` to `0.2.0`).
20+
21+
Change "Next Release" in [CHANGELOG.md](CHANGELOG.md) to the new version.
22+
23+
```
24+
### 0.1.1 (February 5, 2015)
25+
```
26+
27+
Remove the line with "Your contribution here.", since there will be no more contributions to this release.
28+
29+
Commit your changes.
30+
31+
```
32+
git add CHANGELOG.md lib/grape-swagger-rails/version.rb
33+
git commit -m "Preparing for release, 0.1.1."
34+
git push origin master
35+
```
36+
37+
Release.
38+
39+
```
40+
$ rake release
41+
42+
grape-swagger-rails 0.1.1 built to pkg/grape-swagger-rails-0.1.1.gem.
43+
Tagged v0.1.1.
44+
Pushed git commits and tags.
45+
Pushed grape-swagger-rails 0.1.1 to rubygems.org.
46+
```
47+
48+
### Prepare for the Next Version
49+
50+
Add the next release to [CHANGELOG.md](CHANGELOG.md).
51+
52+
```
53+
Next Release
54+
============
55+
56+
* Your contribution here.
57+
```
58+
59+
Comit your changes.
60+
61+
```
62+
git add CHANGELOG.md
63+
git commit -m "Preparing for next release."
64+
git push origin master
65+
```

0 commit comments

Comments
 (0)