Update docs.voltha.org release version matrix.
howot/release/repositories/
o Document more caveats for releasing indivdiual repositories.
o repo:ci-management must be released twice:
- first to establish a branhc for pipeline jobs.
- second to update dependent versions after downstream repos have been released
Change-Id: I33d7f2442a1d4ea45a48caef0e49df92988cc2ce
diff --git a/howto/release/repositories/voltha-lib-go/release.rst b/howto/release/repositories/voltha-lib-go/release.rst
index 83cf628..a51e50c 100644
--- a/howto/release/repositories/voltha-lib-go/release.rst
+++ b/howto/release/repositories/voltha-lib-go/release.rst
@@ -5,48 +5,39 @@
- Update .gitreview, set defaultbranch=voltha-2.12 for commits
- Update VERSION file to prevent future conflicts: {major}.{minor+1}.0
+## TODO: Replace with bttb.sh script usage
+ - git checkout -b voltha-2.12 tags/2.12.0
+ - Update .gitreview
+ - set defaultbranch=voltha-2.12 for commits
+
+- master branch
+
+ - Increment version file to prevent collision with release branch.
+ - Append a ``*-dev`` suffix to the version string
+ - {max}.{1+min}.0-dev
+
Release branching and tagging
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Releasing repository voltha-lib-go requires tag-then-release branching,
-first create a versioned tag 2.12.0-beta then create branch voltha-2.12-beta
+first create a versioned tag 2.12.0 then create branch voltha-2.12
from the release tag.
Repository tag names differ based on repository, golang repositories
use tags with the prefix vee v1.2.3, v2.45.0
-.. code-block:: shell-session
- :caption: First create a release tag
-
- # Determine repository tagname convention (with/with-out vee)
- git clone "ssh://gerrit.opencord.org:29418/${repo_name}.git"
- git tag --list-tags
-
- # ---------------------------
- # Step 1 create a release tag
- # ---------------------------
- local branch_name='voltha-2.12-beta'
- local tag_name='v2.12.0-beta'
-
- git tag -a "$tag_name" -m "${branch_name} release"
- git push origin "$tag_name"
.. code-block:: shell-session
- :caption: Create a release branch attached to the release tag
+ :caption: AUTOMATED: Release script bttb.sh
- # ------------------------------------------------------------
- # Step 2 - create a release branch attached to the release tag
- # ------------------------------------------------------------
- local branch_name='voltha-2.12-beta'
- local tag_name='v2.12.0-beta'
- local repo_name='voltha-lib-go'
-
- git clone "ssh://gerrit.opencord.org:29418/${repo_name}.git"
- git fetch --all --tags
-
- git checkout -b "$branch_name" "tags/tag_name"
- git push origin "$branch_name" "tags/$tag_name"
+ ## -----------------------------------------------------------
+ ## Use the bttb.sh (branch-tag_OR_tag-branch) script to branch/tag.
+ ## Script is aware of how to tag/branch VOLTHA repositories by name.
+ ## -----------------------------------------------------------
+ % git clone ssh://gerrit.opencord.org:29418/voltha-release.git
+ % cd voltha-release
+ % ./bttb.sh --sandbox sandbox --repo voltha-lib-go --version 2.12
See Also
--------
@@ -60,7 +51,7 @@
:caption: Create a release branch attached to the release tag
grep -v 'defaultbranch' .gitreview > .gitreview.tmp
- echo "defaultbranch=voltha-2.12-beta" >> .gitreview.tmp
+ echo "defaultbranch=voltha-2.12" >> .gitreview.tmp
mv -f .gitreview.tmp .gitreview