From b8e9649c3ce1f0c57f0b4942c8333fe6d3700d57 Mon Sep 17 00:00:00 2001 From: hoatle Date: Thu, 20 Jul 2017 08:28:08 +0700 Subject: [PATCH 1/3] @ #363 | should update releases/vX.X.X convention --- docs/release_process.rst | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/docs/release_process.rst b/docs/release_process.rst index d345d93e..dd642719 100644 --- a/docs/release_process.rst +++ b/docs/release_process.rst @@ -6,8 +6,12 @@ This is the general guide for releasing software packages at Teracy. Starting -------- -- Follow workflow, a release branch should be branched off from origin branch that is ready to be - released (for example: ``releases/0.1.0`` branch is branched off from the ``develop`` branch). +- Follow workflow, a releasing branch should be branched off from origin branch that is ready to be + released. + +- The releasing branch should be named ``releases/vX.X.X``. + +- For example: ``releases/v0.1.0`` branch is branched off from the ``develop`` branch. - Set the next iteration version for the ``develop`` branch. This will make sure there is no snapshot version conflict between the ``releases`` branch and the ``develop`` branch. Moreover, the @@ -26,7 +30,7 @@ Releasing - Remember that release branch should not introduce big changes. - After each staging releases, create an issue for release test campaign to make sure the release - is stable enough and have a good quality. + is stable enough and have good quality. Ending ------ @@ -39,7 +43,7 @@ Ending used for auto deployment, so make sure the message has the correct pattern. - Merge the tag release into the ``master`` branch, then the origin branch. This is specified on the - workflow. + project workflow. - Delete released branch and we are done. From 3ce5f41b8983f98a061ca2953e1f7ed5f5b0710b Mon Sep 17 00:00:00 2001 From: hoatle Date: Thu, 20 Jul 2017 11:38:46 +0700 Subject: [PATCH 2/3] @ #363 | should update releases/vX.X.X convention: feedbacks applied --- docs/release_process.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/release_process.rst b/docs/release_process.rst index dd642719..7153105a 100644 --- a/docs/release_process.rst +++ b/docs/release_process.rst @@ -6,12 +6,12 @@ This is the general guide for releasing software packages at Teracy. Starting -------- -- Follow workflow, a releasing branch should be branched off from origin branch that is ready to be +- Follow workflow, a releasing branch should be branched off from an origin branch that is ready to be released. - The releasing branch should be named ``releases/vX.X.X``. -- For example: ``releases/v0.1.0`` branch is branched off from the ``develop`` branch. +- For example: the ``releases/v0.1.0`` branch is branched off from the ``develop`` branch. - Set the next iteration version for the ``develop`` branch. This will make sure there is no snapshot version conflict between the ``releases`` branch and the ``develop`` branch. Moreover, the @@ -29,7 +29,7 @@ Releasing - Remember that release branch should not introduce big changes. -- After each staging releases, create an issue for release test campaign to make sure the release +- After each staging release, create an issue for release test campaign to make sure the release is stable enough and have good quality. Ending @@ -45,7 +45,7 @@ Ending - Merge the tag release into the ``master`` branch, then the origin branch. This is specified on the project workflow. -- Delete released branch and we are done. +- Delete the released branch and we are done. .. note:: From b7b36458e18a62a0cb225be02b10b415d50340ac Mon Sep 17 00:00:00 2001 From: hoatle Date: Thu, 20 Jul 2017 23:37:37 +0700 Subject: [PATCH 3/3] @ #363 | should update releases/vX.X.X convention: update release.rst, too --- docs/release.rst | 11 +++-------- 1 file changed, 3 insertions(+), 8 deletions(-) diff --git a/docs/release.rst b/docs/release.rst index 2f74b38e..68d4c2e9 100644 --- a/docs/release.rst +++ b/docs/release.rst @@ -10,7 +10,7 @@ vagrant_config.json README.rst ---------- -- change `develop` to the tag version. For example, `develop/` to `0.3.0/` +- change `develop` to the tag version. For example, `develop/` to `v0.5.0` docs/conf.py ------------ @@ -20,13 +20,8 @@ docs/conf.py docs/getting_started.rst ------------------------ -- Change `develop` to the tag version. For example, `develop` to `v0.3.0` - - -scripts/setup_vagrant_and_virtualbox.bat ----------------------------------------- - -- Change `develop` to the tag version. For example, `develop` to `v0.3.0` +- Change `develop` to the tag version. For example, `develop` to `v0.5.0` +- Keep the tag version for both the git tag and the master branch CHANGELOG.md