A build tool for automatically bumping version numbers
Proteus reads the pull request body text and looks for any of the following words, bumping the semantic version accordingly:
| Word | Bump Type | Increment |
|---|---|---|
| breaking change | Major | 1.0.0 |
| new feature | Minor | 0.1.0 |
| bugfix | Patch | 0.0.1 |
| bug fix | Patch | 0.0.1 |
| patch | Patch | 0.0.1 |
| improvement | Patch | 0.0.1 |
However, if the current major version is 0 (i.e. this is a version 0.x.y product) then the major version will never be bumped as breaking changes are expected and permitted while in a v0 (unstable) product.
Your pull request text can be phrased any way you like, the Changelog will have a new section added like this:
## 0.0.1 ([28](link-to-pull-request) 2014-04-11 11:39)
Title of Pull Request
Body of Pull requestWe find it beneficial to write the body of your pull request like this:
### New features
- Now all singing *and* all dancing.
### Bug fixes
- I fixed this bug
- [CP-123](link-to-JIRA-ticket) I fixed this one too