Mirroristas/bigchaindb
2
0
Fork 0
mirror of https://github.com/bigchaindb/bigchaindb.git synced 2024-10-13 13:34:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

Various modifications to Release_Process.md

Browse Source
This commit is contained in:
Troy McConaghy 2017-02-07 11:46:25 +01:00
parent acc5b2fd42
commit a55ae0e44d
1 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
Release_Process.md
View File

@ -10,11 +10,11 @@ that [major version 0.x does not export a stable API](http://semver.org/#spec-it
A minor release is preceeded by a feature freeze and created from the 'master' branch. This is a summary of the steps we go through to release a new minor version of BigchainDB Server. A minor release is preceeded by a feature freeze and created from the 'master' branch. This is a summary of the steps we go through to release a new minor version of BigchainDB Server.
1. Update the `CHANGELOG.md` file in master 1. Update the `CHANGELOG.md` file in master
1. Create and checkout a new branch for the release, named after the minor version, without a preceeding 'v', e.g. `git checkout -b 0.9.4` 1. Create and checkout a new branch for the minor release, named after the minor version, without a preceeding 'v', e.g. `git checkout -b 0.9` (*not* 0.9.0, this new branch will be for e.g. 0.9.0, 0.9.1, 0.9.2, etc. each of which will be identified by a tagged commit)
1. In `bigchaindb/version.py`, update `__version__` and `__short_version__`, e.g. to `0.9` and `0.9.0` (with no `.dev` on the end) 1. In `bigchaindb/version.py`, update `__version__` and `__short_version__`, e.g. to `0.9` and `0.9.0` (with no `.dev` on the end)
1. Commit changes, push new branch to Github, and merge it into master 1. Commit that change, and push the new branch to GitHub
1. Follow steps outlined in [Common Steps](#common-steps) 1. Follow steps outlined in [Common Steps](#common-steps)
1. In 'master' branch, Edit `bigchaindb/version.py`, increment the minor version to the next planned release, e.g. `0.10.0.dev'. 1. In 'master' branch, Edit `bigchaindb/version.py`, increment the minor version to the next planned release, e.g. `0.10.0.dev'
This is so people reading the latest docs will know that they're for the latest (master branch) This is so people reading the latest docs will know that they're for the latest (master branch)
version of BigchainDB Server, not the docs at the time of the most recent release (which are also version of BigchainDB Server, not the docs at the time of the most recent release (which are also
available). available).
@ -25,11 +25,12 @@ Congratulations, you have released BigchainDB!
A patch release is similar to a minor release, but piggybacks on an existing minor release branch: A patch release is similar to a minor release, but piggybacks on an existing minor release branch:
1. Check out the minor release branch 1. Check out the minor release branch, e.g. `0.9`
1. Apply the changes you want, ie using `git cherry-pick`. 1. Apply the changes you want, e.g. using `git cherry-pick`.
1. Update the `CHANGELOG.md` file 1. Update the `CHANGELOG.md` file
1. Increment the patch version in `bigchaindb/version.py`, e.g. "0.9.1" 1. Increment the patch version in `bigchaindb/version.py`, e.g. "0.9.1"
1. Follow steps outlined in [Common Steps](#common-steps) 1. Follow steps outlined in [Common Steps](#common-steps)
1. Cherry-pick the `CHANGELOG.md` update commit (made above) to the `master` branch
## Common steps ## Common steps
@ -42,7 +43,8 @@ These steps are common between minor and patch releases:
- Target: the release branch that was just pushed - Target: the release branch that was just pushed
- Title: Same as tag name - Title: Same as tag name
- Description: The body of the changelog entry (Added, Changed etc) - Description: The body of the changelog entry (Added, Changed etc)
1. Publish the release on Github 1. Publish the release on GitHub
1. (Optional) Do a `make clean` in the repository root directory (`bigchaindb/`)
1. Generate the release tarball with `python setup.py sdist`. Upload the release to PyPI, e.g. `twine upload dist/BigchainDB-0.9.0.tar.gz` (requires you to have a `~/.pypirc` file) 1. Generate the release tarball with `python setup.py sdist`. Upload the release to PyPI, e.g. `twine upload dist/BigchainDB-0.9.0.tar.gz` (requires you to have a `~/.pypirc` file)
1. Login to readthedocs.org as a maintainer of the BigchainDB Server docs. 1. Login to readthedocs.org as a maintainer of the BigchainDB Server docs.
Go to Admin --> Versions and under **Choose Active Versions**, make sure that the new version's tag is Go to Admin --> Versions and under **Choose Active Versions**, make sure that the new version's tag is