Improve release workflow with new automation

With the updated version bump job and release tagging script we can cut
out a few steps from the tagging and version bumping steps.

Change-Id: I4db39b71671d313df65a1f45d22e2c6efdda8d50
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>

diff --git a/docs/release-process/simultaneous-release.rst b/docs/release-process/simultaneous-release.rst
index ab5906cdae7cd795320bfbf357e7b12ba1b7cfff..3e2109a5ccc30a842c4ba8bc82c039aa04dffaa1 100644 (file)
--- a/docs/release-process/simultaneous-release.rst
+++ b/docs/release-process/simultaneous-release.rst
@@ -26,92 +26,90 @@ Verify the distribution-karaf file with the signature.
 Releasing OpenDaylight
 ======================
 
-- Block submit permissions for registered users and elevate RE's committer rights on gerrit. **(Helpdesk)**
+- Block submit permissions for registered users and elevate RE's committer
+  rights on Gerrit.
+  **(Helpdesk)**
 
   .. figure:: images/gerrit-update-committer-rights.png
 
   .. note::
 
-     Enable **Exclusive** checkbox for the submit button to override any existing persmissions.
+     Enable **Exclusive** checkbox for the submit button to override any
+     existing persmissions. Code-Review and Verify permissions are only needed
+     during version bumping. DO NOT enable it during code freeze.
 
-- Export ${RELEASE} and ${BUILDNUM} with current release name and build number.
+- Nexus: click release for staging repo
+  **(Helpdesk)**
 
-  .. code-block:: bash
+- Nexus: click release for gpgsign repo (created above in Preparations)
+  **(Helpdesk)**
 
-     export RELEASE=Beryllium-SR4
-     export BRANCH=${RELEASE//-*}
-     export BUILDNUM=55
+- Pull latest autorelease repository
+  **(Release Engineering Team)**
 
-- Nexus: click release for staging repo **(Helpdesk)**
-- Nexus: click release for gpgsign repo (created above in Preparations) **(Helpdesk)**
-- Send email to Helpdesk with binary URL to update website **(Helpdesk)**
-- Send email to TSC and Release mailing lists announcing release binaries location **(Release Engineering Team)**
-- Clone autorelease repository. **(Release Engineering Team)**
+  .. note:: If you already cloned autorelease the clone line can be skipped below.
 
   .. code-block:: bash
 
       git clone --recursive https://git.opendaylight.org/gerrit/releng/autorelease
-
-- Checkout autorelease and switch to release branch eg stable/carbon **(Release Engineering Team)**
-
-  .. code-block:: bash
-
-      git checkout -b stable/${BRANCH,,} origin/stable/${BRANCH,,}
+      cd autorelease
       git submodule update --init
-      git submodule foreach git checkout -b stable/${BRANCH,,} origin/stable/${BRANCH,,}
-
-- Make sure your git repo is setup to push (use git-review)
-
-  .. code-block:: bash
-
       git review -s
       git submodule foreach 'git review -s'
 
-- Download patches (\*.bundle files and taglist.log.gz) from log server.
+- Make sure the latest lftools is installed
+  **(Release Engineering Team)**
+
+  .. note:: If you already created an lftools virtualenv you can skip the mkvirtualenv step below.
 
   .. code-block:: bash
 
-      mkdir /tmp/patches && cd /tmp/patches
-      wget https://logs.opendaylight.org/releng/jenkins092/autorelease-release-${BRANCH,,}/${BUILDNUM}/archives/all-bundles.tar.gz
-      gunzip all-bundles.tar.gz
-      wget https://logs.opendaylight.org/releng/jenkins092/autorelease-release-${BRANCH,,}/${BUILDNUM}/archives/patches/taglist.log.gz
-      gunzip taglist.log.gz
+      mkvirtualenv lftools
+      workon lftools
+      pip install --upgrade lftools
 
-- Run the following commands for every project in the release, to apply patches to each project directory.
+- Publish release tags
+  **(Release Engineering Team)**
 
   .. code-block:: bash
 
-      pip install lftools
-      lftools version patch ${RELEASE}
-      git review -y -t ${RELEASE}
-      git push gerrit release/${RELEASE,,}
+      export RELEASE=Beryllium-SR4
+      export STREAM=${RELEASE//-*}
+      export BUILD_NUM=55
+      export PATCH_URL="https://logs.opendaylight.org/releng/jenkins092/autorelease-release-${STREAM,,}/${BUILD_NUM}/archives/patches.tar.gz"
+      ./scripts/release-tags.sh "${RELEASE}" /tmp/patches "$PATCH_URL"
 
-- Merge all patches on gerrit in the order generated by merge-order.log
+- Run autorelease-version-bump-${STREAM} job
+  **(Release Engineering Team)**
 
-- Tag autorelease too
+- Send email to Helpdesk with binary URL to update website
+  **(Helpdesk)**
 
-  .. code-block:: bash
+- Send email to TSC and Release mailing lists announcing release binaries location
+  **(Release Engineering Team)**
 
-      git checkout `cat /tmp/patches/taglist.log | grep autorelease | awk '{print $2}'`
-      git submodule foreach git checkout release/${RELEASE,,}
-      git commit -asSm "Release ${RELEASE}"
-      git tag -asm "OpenDaylight ${RELEASE} release" release/${RELEASE,,}
-      git push gerrit release/${RELEASE,,}
+- Merge all patches generated by the job
+  **(Release Engineering Team)**
 
-- Re-enable submit permissions for registered users and disable elevated RE committer rights on gerrit.
+- Re-enable submit permissions for registered users and disable elevated RE
+  committer rights on gerrit
+  **(Helpdesk)**
 
-- Release notes is auto generated by job autorelease-generate-release-notes-${BRANCH,,}
-  triggered at the end of every autorelease build. The release notes file (release_notes.rst) is
-  available under archives.
+- Send email to release/tsc/dev notifying tagging and version bump complete
+  **(Release Engineering Team)**
 
-  Alternatively, release notes can also be manually generated with the script.
+- Run autorelease-generate-release-notes-${STREAM} job
   **(Release Engineering Team)**
 
+  This job is run a the end of every autorelease build. The release notes file
+  (release_notes.rst) is available under archives.
+
+  Release notes can also be manually generated with the script.
+
   .. code-block:: bash
 
       git checkout stable/${BRANCH,,}
       cd scripts/release_notes_management/ && ./build.sh
 
-  The output file (release_notes.rst) generated by the build script is available under autorelease/scripts/release_notes_management/projects/.
-
-- Send email to release/tsc/dev notifying tagging and version bump complete **(Release Engineering Team)**
+  The output file (release_notes.rst) generated by the build script is available
+  under autorelease/scripts/release_notes_management/projects/.