From ed09cf3c8e4124a890fac7c43e9824380827eead Mon Sep 17 00:00:00 2001 From: Troy McConaghy Date: Wed, 9 Nov 2016 18:40:16 +0100 Subject: [PATCH 1/2] Created a file to outline our release process --- Release_Process.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 Release_Process.md diff --git a/Release_Process.md b/Release_Process.md new file mode 100644 index 00000000..dbfd10ed --- /dev/null +++ b/Release_Process.md @@ -0,0 +1,23 @@ +# Our Release Process + +This is a summary of the steps we go through to release a new version of BigchainDB Server. + +1. Update the `CHANGELOG.md` file +2. Update `bigchaindb/version.py` +3. Go to the [bigchaindb/bigchaindb Releases page on GitHub](https://github.com/bigchaindb/bigchaindb/releases) + and click the "Draft a new release" button +4. Name the tag something like v0.7.0 +5. The target should be a specific commit: the one when the update of `bigchaindb/version.py` got merged into master +6. The release title should be something like v0.7.0 +7. The description should be copied from the `CHANGELOG.md` file updated above +8. Generate and send the latest `bigchaindb` package to PyPI. Dimi and Sylvain can do this, maybe others +9. 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 + "Active" and "Public" + +After the release: + +1. Update `bigchaindb/version.py` again, to be something like 0.8.0.dev (with a dev on the end). +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 +available). From c30c32bcd57b987aa9e9c8f240650a89a06c78c6 Mon Sep 17 00:00:00 2001 From: troymc Date: Thu, 10 Nov 2016 16:44:42 +0100 Subject: [PATCH 2/2] In Release_Process.md, noted we use semantic versioning --- Release_Process.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Release_Process.md b/Release_Process.md index dbfd10ed..bb826ae9 100644 --- a/Release_Process.md +++ b/Release_Process.md @@ -3,7 +3,7 @@ This is a summary of the steps we go through to release a new version of BigchainDB Server. 1. Update the `CHANGELOG.md` file -2. Update `bigchaindb/version.py` +2. Update the version numbers in `bigchaindb/version.py`. Note that we try to use [semantic versioning](http://semver.org/) (i.e. MAJOR.MINOR.PATCH) 3. Go to the [bigchaindb/bigchaindb Releases page on GitHub](https://github.com/bigchaindb/bigchaindb/releases) and click the "Draft a new release" button 4. Name the tag something like v0.7.0