Skip to content

Commit

Permalink
Merge pull request #364 from hoatle/improvements/#363-release-version…
Browse files Browse the repository at this point in the history
…-convention-update

@ #363 | should update releases/vX.X.X convention
  • Loading branch information
phuonglm committed Jul 21, 2017
2 parents b5fffc0 + b7b3645 commit fd6585b
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 14 deletions.
11 changes: 3 additions & 8 deletions docs/release.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
------------
Expand All @@ -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
Expand Down
16 changes: 10 additions & 6 deletions docs/release_process.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 an origin branch that is ready to be
released.

- The releasing branch should be named ``releases/vX.X.X``.

- 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
Expand All @@ -25,8 +29,8 @@ 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.
- After each staging release, create an issue for release test campaign to make sure the release
is stable enough and have good quality.

Ending
------
Expand All @@ -39,9 +43,9 @@ 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.
- Delete the released branch and we are done.

.. note::

Expand Down

0 comments on commit fd6585b

Please sign in to comment.