1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
|
# Releasing Hashie
There're no particular rules about when to release Hashie. Release bug fixes frequently, features not so frequently and breaking API changes rarely.
## Release
Run tests, check that all tests succeed locally.
```sh
bundle install
bundle exec rake spec
```
Check that the last build succeeded in [GHA](https://github.com/hashie/hashie/commits/master) for all supported platforms.
### Check Next Version
Check the version number that should have been incremented during the previous release and/or development. If needed, modify [lib/hashie/version.rb](lib/hashie/version.rb). [Changelog](CHANGELOG.md) entries should be helpfully categorized to assist in picking the next version number.
* Increment the third number (minor version) if the release has bug fixes and/or very minor features, only (eg. change `0.5.1` to `0.5.2`). These should be in the "Fixed", "Security", or "Miscellaneous" categories in the change log.
* Increment the second number (patch version) if the release contains major features or breaking API changes (eg. change `0.5.1` to `0.6.0`). These should be in the "Added" or "Deprecated" categories in the change log.
* Increment the first number (major version) if the release has any changed or removed behavior on public APIs (eg. change `0.5.1` to `1.0.0`). These should be in the "Changed" or "Removed" categories in the change log.
### Modify the Readme
Modify the "Stable Release" section in [README.md](README.md). Change the text to reflect that this is going to be the documentation for a stable release. Remove references to the previous release of Hashie. Keep the file open, you'll have to undo this change after the release.
```markdown
## Stable Release
You're reading the documentation for the stable release of Hashie, 3.3.0.
```
### Modify the Changelog
Change "Unreleased" in [CHANGELOG.md](CHANGELOG.md) to the new version.
```markdown
## [3.3.0] - 2014-08-25
[3.3.0]: https://github.com/hashie/hashie/compare/v<LAST_VERSION>..v<THIS_VERSION>
```
Replace `<LAST_VERSION>` and `<THIS_VERSION>` with the last and new-to-be-released versions to set up the compare view on Github.
Remove any sections that only have "Your contribution here." underneath them.
Commit your changes.
```sh
git add README.md CHANGELOG.md lib/hashie/version.rb
git commit -m "Preparing for release, 3.3.0."
git push origin master
```
### Push to RubyGems.org
Release.
```sh
$ rake release
hashie 3.3.0 built to pkg/hashie-3.3.0.gem.
Tagged v3.3.0.
Pushed git commits and tags.
Pushed hashie 3.3.0 to rubygems.org.
```
## Prepare for the Next Version
Modify the "Stable Release" section in [README.md](README.md). Change the text to reflect that this is going to be the next release.
```markdown
## Stable Release
You're reading the documentation for the next release of Hashie, which should be 3.3.1.
The current stable release is [3.3.0](https://github.com/hashie/hashie/blob/v3.3.0/README.md).
```
Add new "Unreleased" section to [CHANGELOG.md](CHANGELOG.md) using this template:
```markdown
## [Unreleased][unreleased]
[unreleased]: https://github.com/hashie/hashie/compare/v<THIS_VERSION>...master
### Added
* Your contribution here.
### Changed
* Your contribution here.
### Deprecated
* Your contribution here.
### Removed
* Your contribution here.
### Fixed
* Your contribution here.
### Security
* Your contribution here.
### Miscellaneous
* Your contribution here.
```
Replace `<THIS_VERSION>` with the newly released versions to set up the compare view on Github.
Increment the minor version, modify [lib/hashie/version.rb](lib/hashie/version.rb).
Commit your changes.
```sh
git add CHANGELOG.md README.md lib/hashie/version.rb
git commit -m "Preparing for next development iteration, 3.3.1."
git push origin master
```
|
