From: Henry Gessau <gessau@cisco.com>
Date: Tue, 29 Sep 2015 16:15:06 +0000 (-0400)
Subject: Add devref for alembic milestone tagging
X-Git-Url: https://review.fuel-infra.org/gitweb?a=commitdiff_plain;h=10b4e0964a7fbdfb8ac191477153f95689c1d1bd;p=openstack-build%2Fneutron-build.git

Add devref for alembic milestone tagging

Related-Bug: #1499033

Change-Id: Iff58622c56be2c64cfb5659d20c4eae2f45a318c
---

diff --git a/doc/source/devref/alembic_migrations.rst b/doc/source/devref/alembic_migrations.rst
index 3d37199be..65dd63bc3 100644
--- a/doc/source/devref/alembic_migrations.rst
+++ b/doc/source/devref/alembic_migrations.rst
@@ -317,3 +317,20 @@ and then applying all available rules::
 
 It will apply all the rules from both the expand and the contract branches, in
 proper order.
+
+
+Tagging milestone revisions
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+When named release (liberty, mitaka, etc.) is done for neutron or a
+sub-project, the alembic revision scripts at the head of each branch for that
+release must be tagged. This is referred to as a milestone revision tag.
+
+For example, `here <https://review.openstack.org/228272>`_ is a patch that tags
+the liberty milestone revisions for the neutron-fwaas sub-project. Note that
+each branch (expand and contract) is tagged.
+
+Tagging milestones allows neutron-db-manage to upgrade the schema to a
+milestone release, e.g.::
+
+ neutron-db-manage upgrade liberty