|
@@ -48,59 +48,63 @@ nomenclature for naming the branches:
|
|
|
|
|
|
|
|
|
Writing release notes
|
|
|
---------------------
|
|
|
|
|
|
Release notes should be updated in relevant branches as the issues are
|
|
|
getting resolved. You can use the following template when filling-up
|
|
|
the release notes::
|
|
|
getting resolved. The following template should be used when
|
|
|
filling-up the release notes (take note the links to issues are kept
|
|
|
on separate page)::
|
|
|
|
|
|
VERSION
|
|
|
-------
|
|
|
|
|
|
GENERAL DESCRIPTION
|
|
|
|
|
|
Breaking changes:
|
|
|
|
|
|
* DESCRIPTION [ `CONNT-NUMBER <https://projects.majic.rs/conntrackt/issues/CONNT-NUMBER>`_ ]
|
|
|
* DESCRIPTION
|
|
|
[ `CONNT-NUMBER <https://projects.majic.rs/conntrackt/issues/CONNT-NUMBER>`_ ]
|
|
|
|
|
|
New features/improvements:
|
|
|
|
|
|
* DESCRIPTION [ `CONNT-NUMBER <https://projects.majic.rs/conntrackt/issues/CONNT-NUMBER>`_ ]
|
|
|
* DESCRIPTION
|
|
|
[ `CONNT-NUMBER <https://projects.majic.rs/conntrackt/issues/CONNT-NUMBER>`_ ]
|
|
|
|
|
|
Bug-fixes:
|
|
|
|
|
|
* DESCRIPTION [ `CONNT-NUMBER <https://projects.majic.rs/conntrackt/issues/CONNT-NUMBER>`_ ]
|
|
|
* DESCRIPTION
|
|
|
[ `CONNT-NUMBER <https://projects.majic.rs/conntrackt/issues/CONNT-NUMBER>`_ ]
|
|
|
|
|
|
|
|
|
Release issue template
|
|
|
----------------------
|
|
|
|
|
|
In order to make life easier, the following template can be used when
|
|
|
creating the issue for a release in the issue tracker:
|
|
|
The following template can be used when creating the issue for a
|
|
|
release in the issue tracker:
|
|
|
|
|
|
- Set *subject* to ``Release version MAJOR.MINOR.PATCH``.
|
|
|
- Set *description* to::
|
|
|
|
|
|
Release version MAJOR.MINOR.PATCH. Release should be done
|
|
|
according to release procedures outlined in offline documentation.
|
|
|
|
|
|
|
|
|
Backporting fixes
|
|
|
-----------------
|
|
|
|
|
|
From time to time it might become useful to apply a bug-fix to both the master
|
|
|
branch, and to maintenace branch.
|
|
|
From time to time it might become useful to apply a bug-fix to both
|
|
|
the default development branch, and to maintenace branch.
|
|
|
|
|
|
When a bug is discovered in one of the roles (or maybe documentation), and it
|
|
|
should be applied to maintenance branch as well, procedure is as follows:
|
|
|
|
|
|
1. Create a new bug report in `issue tracker
|
|
|
<https://projects.majic.rs/conntrackt>`_. Target version should be
|
|
|
either the next minor or next major release (i.e. whatver will get released
|
|
|
from the master branch).
|
|
|
from the default development branch).
|
|
|
|
|
|
2. Create a copy of the bug report, modifying the issue title to include phrase
|
|
|
``(backport to MAJOR.MINOR)`` at the end, with ``MAJOR`` and ``MINOR``
|
|
|
replaced with correct versioning information for the maintenance
|
|
|
branch. Make sure to set correct target version (patch release).
|
|
|
|
|
@@ -128,19 +132,19 @@ 2. Prepare release environment:
|
|
|
|
|
|
workon conntrackt
|
|
|
|
|
|
2. Set release version, and set issue associated with making the
|
|
|
release::
|
|
|
|
|
|
NEW_VERSION="MAJOR.MINOR.PATCH"
|
|
|
VERSION="MAJOR.MINOR.PATCH"
|
|
|
ISSUE="CONNT-NUMBER"
|
|
|
BRANCH="${NEW_VERSION%.*}"
|
|
|
BRANCH="${VERSION%.*}"
|
|
|
|
|
|
3. Verify the information has been set correctly::
|
|
|
|
|
|
echo "[$ISSUE] $BRANCH -> $NEW_VERSION"
|
|
|
echo "[$ISSUE] $BRANCH -> $VERSION"
|
|
|
|
|
|
3. If this is a new major/minor release, prepare the maintenance
|
|
|
branch:
|
|
|
|
|
|
.. warning::
|
|
|
Make sure **not** to run these steps when making a patch release!
|
|
@@ -235,19 +239,19 @@ 7. Push release to PyPI:
|
|
|
python setup.py upload
|
|
|
|
|
|
8. Clean-up the maintenance branch:
|
|
|
|
|
|
1. Start a new release notes section in ``docs/releasenotes.rst``::
|
|
|
|
|
|
sed "/^Release Notes$/{N;s/$/\n\n\n${BRANCH-maint}\n-----------/}" docs/releasenotes.rst
|
|
|
sed -i "/^Release Notes$/{N;s/$/\n\n\n${BRANCH}-maint\n-----------/}" docs/releasenotes.rst
|
|
|
|
|
|
2. Update versioning information in documentation and setup
|
|
|
script::
|
|
|
|
|
|
sed -i -e "s/^version = .*/version = '${BRANCH}-maint'/" docs/conf.py
|
|
|
sed -i -e "s/^ version=.*/ version='${BRANC}-maint',/" setup.py
|
|
|
sed -i -e "s/^ version=.*/ version='${BRANCH}-maint',/" setup.py
|
|
|
|
|
|
3. Fix the title underline for version string in
|
|
|
``docs/releasenotes.rst``.
|
|
|
|
|
|
4. Show differences before committing::
|
|
|
|
|
@@ -270,17 +274,17 @@ 9. Clean-up the default branch if you ha
|
|
|
2. Verify the switch::
|
|
|
|
|
|
hg branch
|
|
|
|
|
|
3. Update versioning information in release notes::
|
|
|
|
|
|
sed -i -e "s/^dev$/${BRANCH}-maint/" docs/releasenotes.rst
|
|
|
sed -i -e "s/^dev$/${VERSION}/" docs/releasenotes.rst
|
|
|
|
|
|
4. Start a new release notes section in ``docs/releasenotes.rst``::
|
|
|
|
|
|
sed "/^Release Notes$/{N;s/$/\n\n\n$dev\n---/}" docs/releasenotes.rst
|
|
|
sed -i "/^Release Notes$/{N;s/\$/\n\n\ndev\n---/}" docs/releasenotes.rst
|
|
|
|
|
|
5. Fix the title underlines for version strings in
|
|
|
``docs/releasenotes.rst``.
|
|
|
|
|
|
6. Show differences before committing::
|
|
|
|