Merge pull request #12 from njgheorghita/update-bumpversion

[WIP] Add changelog instructions
This commit is contained in:
Jason Carver 2018-09-05 11:00:43 -07:00 committed by GitHub
commit 03f00d3fbe
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -86,7 +86,11 @@ The version format for this repo is `{major}.{minor}.{patch}` for stable, and
`{major}.{minor}.{patch}-{stage}.{devnum}` for unstable (`stage` can be alpha or beta). `{major}.{minor}.{patch}-{stage}.{devnum}` for unstable (`stage` can be alpha or beta).
To issue the next version in line, specify which part to bump, To issue the next version in line, specify which part to bump,
like `make release bump=minor` or `make release bump=devnum`. like `make release bump=minor` or `make release bump=devnum`. This is typically done from the
master branch, except when releasing a beta (in which case the beta is released from master,
and the previous stable branch is released from said branch). To include changes made with each
release, update "docs/releases.rst" with the changes, and apply commit directly to master
before release.
If you are in a beta version, `make release bump=stage` will switch to a stable. If you are in a beta version, `make release bump=stage` will switch to a stable.