Skip to content

Commit 03af2a3

Browse files
committed
Added a RELEASING doc.
1 parent cea5cf9 commit 03af2a3

File tree

1 file changed

+70
-0
lines changed

1 file changed

+70
-0
lines changed

RELEASING.md

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# Releasing Grape::ActiveModelSerializers
2+
3+
There're no particular rules about when to release grape-active_model_serializers. Release bug fixes frequently, 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/ruby-grape/grape-active_model_serializers) for all supported platforms.
15+
16+
Change "Next Release" in [CHANGELOG.md](CHANGELOG.md) to the new version.
17+
18+
```
19+
### 0.7.2 (February 6, 2014)
20+
```
21+
22+
Remove the line with "Your contribution here.", since there will be no more contributions to this release.
23+
24+
Commit your changes.
25+
26+
```
27+
git add CHANGELOG.md lib/grape-active_model_serializers/version.rb
28+
git commit -m "Preparing for release, 0.7.2."
29+
git push origin master
30+
```
31+
32+
Release.
33+
34+
```
35+
$ rake release
36+
37+
grape-active_model_serializers 0.7.2 built to pkg/grape-active_model_serializers-0.7.2.gem.
38+
Tagged v0.7.2.
39+
Pushed git commits and tags.
40+
Pushed grape-active_model_serializers 0.7.2 to rubygems.org.
41+
```
42+
43+
### Prepare for the Next Version
44+
45+
Modify [lib/grape-active_model_serializers/version.rb](lib/grape-active_model_serializers/version.rb), increment the third number (eg. change `0.7.2` to `0.7.3`).
46+
47+
48+
```ruby
49+
module Grape
50+
module ActiveModelSerializers
51+
VERSION = '0.7.3'.freeze
52+
end
53+
end
54+
```
55+
56+
Add the next release to [CHANGELOG.md](CHANGELOG.md).
57+
58+
```
59+
#### 0.7.3 (Next)
60+
61+
* Your contribution here.
62+
```
63+
64+
Commit your changes.
65+
66+
```
67+
git add CHANGELOG.md lib/grape-active_model_serializers/version.rb
68+
git commit -m "Preparing for next development iteration, 0.7.3."
69+
git push origin master
70+
```

0 commit comments

Comments
 (0)