aboutsummaryrefslogtreecommitdiffstats
path: root/docs/testing/developer/devguide/overview.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/testing/developer/devguide/overview.rst')
-rw-r--r--docs/testing/developer/devguide/overview.rst50
1 files changed, 50 insertions, 0 deletions
diff --git a/docs/testing/developer/devguide/overview.rst b/docs/testing/developer/devguide/overview.rst
index 1d7e22fe..66712155 100644
--- a/docs/testing/developer/devguide/overview.rst
+++ b/docs/testing/developer/devguide/overview.rst
@@ -79,6 +79,48 @@ The test cases are written in `pytest`_. You may run it selectively with
pytest tests/unit/reporter
+
+Branching
+=========
+
+Stable branches are created when features are frozen for next release. According to
+`OPNFV release milestone description`_, stable branch window is open on MS6 and closed on MS7.
+
+#. Contact gerrit admin <opnfv-helpdesk@rt.linuxfoundation.org> to create branch for project.
+#. Setup `qtip jobs`_ and `docker jobs`_ for stable branch in releng
+#. Follow `instructions for stable branch`_.
+
+NOTE: we do **NOT** create branches for feature development as in the popular `GitHub Flow`_
+
+
+Releasing
+=========
+
+Tag Deliverable and write release note
+
+Git repository
+--------------
+
+Follow the example in `Git Tagging Instructions for Danube`_ to tag the source code::
+
+ git fetch gerrit
+ git checkout stable/<release-name>
+ git tag -am "<release-version>" <release-version>
+ git push gerrit <release-version>
+
+Docker image
+------------
+
+#. Login `OPNFV Jenkins`_
+#. Go to the `qtip-docker-build-push-<release>`_ and click "Build With Parameters"
+#. Fill in ``RELEASE_VERSION`` with version number not including release name, e.g. ``1.0``
+#. Trigger a manual build
+
+Release note
+------------
+
+Create release note under ``qtip/docs/release/release-notes`` and update ``index.rst``
+
.. _Connexion: https://pypi.python.org/pypi/connexion/
.. _Click: http://click.pocoo.org/
.. _Jinja2: http://jinja.pocoo.org/
@@ -87,3 +129,11 @@ The test cases are written in `pytest`_. You may run it selectively with
.. _sphinx: http://www.sphinx-doc.org/en/stable/
.. _The Hitchhiker's Guide to Python: http://python-guide-pt-br.readthedocs.io/en/latest/writing/structure/
.. _tox: https://tox.readthedocs.io/
+.. _OPNFV release milestone description: https://wiki.opnfv.org/display/SWREL/Release+Milestone+Description
+.. _qtip jobs: https://git.opnfv.org/releng/tree/jjb/qtip/
+.. _docker jobs: https://git.opnfv.org/releng/tree/jjb/releng/opnfv-docker.yml
+.. _instructions for stable branch: https://wiki.opnfv.org/display/SWREL/Stablebranch
+.. _GitHub Flow: https://guides.github.com/introduction/flow/
+.. _Git Tagging Instructions for Danube: https://wiki.opnfv.org/display/SWREL/Git+Tagging+Instructions+for+Danube
+.. _OPNFV Jenkins: https://build.opnfv.org/ci/view/qtip/
+.. _docker build job: https://build.opnfv.org/ci/view/qtip/job/qtip-docker-build-push-danube/