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/VERSION b/VERSION
index 03aa22f..b221cd1 100644
--- a/VERSION
+++ b/VERSION
@@ -1 +1 @@
-2.12.25
+2.12.26
diff --git a/howto/release/repositories/ci-management/misc.rst b/howto/release/repositories/ci-management/misc.rst
index 59b6247..e98dfbc 100644
--- a/howto/release/repositories/ci-management/misc.rst
+++ b/howto/release/repositories/ci-management/misc.rst
@@ -1,6 +1,15 @@
Misc Todo Items
===============
+NOTE
+====
+
+When modifying repo:ci-management be sure to modify ``*.yaml`` sources or JJB
+will not regenerate configs. Ugly faiure mode, release pipelines can
+behave like scripts are running from branch=master.
+
+----
+
- Baseline build
- Update copyright notices :ref:`Release Task Copyright`
@@ -46,6 +55,17 @@
return (br)
}
+## jb/software-upgrades.yaml
+
+- `jjb/software-upgrades.yaml <https://gerrit.opencord.org/plugins/gitiles/ci-management/+/refs/heads/master/jjb/software-upgrades.yaml>`_
+
+ - Update onos packages to released versions.
+ - Post release edits are needed in both branches:
+
+ - branch=master is updated with ``*-SNAPSHOT`` versions
+ - branch=voltha-2.12 receives the non-SNAPSHOT release versions.
+
+
## TODO
- Tools bbsim and voltctl are versioned for release.
diff --git a/howto/release/repositories/go_mod_update.rst b/howto/release/repositories/go_mod_update.rst
new file mode 100644
index 0000000..c2dc1b7
--- /dev/null
+++ b/howto/release/repositories/go_mod_update.rst
@@ -0,0 +1 @@
+golang_gofmt_syntax.rst
diff --git a/howto/release/repositories/voltha-docs/dependencies.rst b/howto/release/repositories/voltha-docs/dependencies.rst
index e1775f0..7bb7fce 100644
--- a/howto/release/repositories/voltha-docs/dependencies.rst
+++ b/howto/release/repositories/voltha-docs/dependencies.rst
@@ -2,3 +2,4 @@
====================
- :ref:`_Release Repository ci-management`
+- :ref:`_Release Repository voltha-protos`
diff --git a/howto/release/repositories/voltha-lib-go/dependencies.rst b/howto/release/repositories/voltha-lib-go/dependencies.rst
index e1775f0..7bb7fce 100644
--- a/howto/release/repositories/voltha-lib-go/dependencies.rst
+++ b/howto/release/repositories/voltha-lib-go/dependencies.rst
@@ -2,3 +2,4 @@
====================
- :ref:`_Release Repository ci-management`
+- :ref:`_Release Repository voltha-protos`
diff --git a/howto/release/repositories/voltha-lib-go/deps.rst b/howto/release/repositories/voltha-lib-go/deps.rst
deleted file mode 100644
index e1775f0..0000000
--- a/howto/release/repositories/voltha-lib-go/deps.rst
+++ /dev/null
@@ -1,4 +0,0 @@
-Release Dependencies
-====================
-
-- :ref:`_Release Repository ci-management`
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
diff --git a/howto/release/repositories/voltha-onos/dependencies.rst b/howto/release/repositories/voltha-onos/dependencies.rst
index b6365c3..f925856 100644
--- a/howto/release/repositories/voltha-onos/dependencies.rst
+++ b/howto/release/repositories/voltha-onos/dependencies.rst
@@ -1,3 +1,3 @@
Dependencies: voltha-onos
-================================
+=========================
diff --git a/howto/release/repositories/voltha-onos/resources.rst b/howto/release/repositories/voltha-onos/resources.rst
index 0e0ca93..d651e83 100644
--- a/howto/release/repositories/voltha-onos/resources.rst
+++ b/howto/release/repositories/voltha-onos/resources.rst
@@ -4,5 +4,6 @@
https://repo.maven.apache.org/maven2/org/onosproject/onos/
- repo:voltha-onos
+
- consumed by Dockerfile.voltha-onos
- version too low, dockefile loads much higher
diff --git a/release_notes/voltha_2.12.rst b/release_notes/voltha_2.12.rst
index 2b831ea..9a498f8 100644
--- a/release_notes/voltha_2.12.rst
+++ b/release_notes/voltha_2.12.rst
@@ -322,26 +322,6 @@
-
-
- ``N``
- * - `bbsim <https://gerrit.opencord.org/gitweb?p=bbsim.git;a=tree>`__
- - ``1.14.4``
- - ``4.8.6``
- - `chart <https://gerrit.opencord.org/gitweb?p=helm-charts.git;a=tree;f=bbsim>`_
- -
- - `X <https://github.com/opencord/bbsim/tree/v1.14.4>`__
- - `X <https://hub.docker.com/layers/voltha/bbsim/1.14.4/images/sha256-c23de193c1d7cf8d32c48edfbec4bfa6c47dbeecd4b31d040da0255eeab2ec58?context=explore>`__
- -
- -
- - ``N`` `VOL-5246 <https://jira.opencord.org/browse/VOL-5246>`_
- * - `Bbsim-sadis-server <https://gerrit.opencord.org/gitweb?p=bbsim-sadis-server.git;a=tree>`__
- -
- - ``0.3.4``
- - `0.3.2 <https://gerrit.opencord.org/plugins/gitiles/voltha-helm-charts/+/refs/heads/master/bbsim-sadis-server/Chart.yaml>`_
- - `X <https://gerrit.opencord.org/plugins/gitiles/bbsim-sadis-server/+/refs/tags/v0.3.4>`__
- - `X <https://github.com/opencord/bbsim-sadis-server/releases/tag/v0.3.4>`__
- -
- -
- -
- - ``N``
* - `ofagent-go <https://gerrit.opencord.org/gitweb?p=ofagent-go.git;a=tree>`_
- ``2.2.1``
- ``2.2.1``
@@ -352,16 +332,6 @@
- `1.6.5(stale) <https://pkg.go.dev/github.com/opencord/ofagent-go/cmd/ofagent>`_
-
-
- * - `voltctl <https://gerrit.opencord.org/gitweb?p=voltctl.git;a=tree>`_
- - ``1.8.3``
- -
- -
- - `X <https://gerrit.opencord.org/plugins/gitiles/voltctl/+/refs/tags/v1.8.3>`__
- - `X <https://github.com/opencord/voltctl/tree/v1.8.3>`__
- -
- -
- -
- - ``N``
* - `voltha-go <https://gerrit.opencord.org/gitweb?p=voltha-go.git;a=tree>`_
- ``3.5.4``
- docker
@@ -394,24 +364,24 @@
- ``N``
* - `voltha-openonu-adapter-go <https://gerrit.opencord.org/gitweb?p=voltha-openonu-adapter-go.git;a=tree>`_
-
- - ``2.7.3``
+ - ``2.11.12``
-
- - `X <https://gerrit.opencord.org/plugins/gitiles/voltha-openonu-adapter-go/+/refs/tags/v2.7.3>`__
- - `X <https://github.com/opencord/voltha-openonu-adapter-go/tree/v2.7.3>`__
- - `X <https://hub.docker.com/layers/voltha/voltha-openonu-adapter-go/2.7.3/images/sha256-e9484a8963d08748af5766a6a8ce7f7485efb384488bcf93840ecc1142d7ad74?context=explore>`__
+ - `X <https://gerrit.opencord.org/plugins/gitiles/voltha-openonu-adapter-go/+/refs/tags/v2.11.12>`__
+ - `X <https://github.com/opencord/voltha-openonu-adapter-go/tree/v2.11.12>`__
+ - `X <https://hub.docker.com/layers/voltha/voltha-openonu-adapter-go/2.11.12/images/sha256-e9484a8963d08748af5766a6a8ce7f7485efb384488bcf93840ecc1142d7ad74?context=explore>`__
-
-
- - ``N``
+ - ``N`` `VOL-5252 <https://jira.opencord.org/browse/VOL-5252>`_
* - `voltha-openolt-adapter <https://gerrit.opencord.org/gitweb?p=voltha-openolt-adapter.git;a=tree>`_
- - ``v4.2.12``
+ - ``v4.4.11`` from ``4.4.9``
- ``4.2.6``
-
- - `X <https://gerrit.opencord.org/plugins/gitiles/voltha-openolt-adapter/+/refs/tags/v4.2.12>`__
- - `X <https://github.com/opencord/voltha-openolt-adapter/tree/v4.2.12>`__
- - `X <https://hub.docker.com/layers/voltha/voltha-openolt-adapter/4.2.12/images/sha256-844eac272323dc8bca10880a111957a95839578b3210dd777be5ac9370aaa52e?context=explore>`__
+ - `X <https://gerrit.opencord.org/plugins/gitiles/voltha-openolt-adapter/+/refs/tags/v4.4.9>`__
+ - `X <https://github.com/opencord/voltha-openolt-adapter/tree/v4.4.9>`__
+ - `X <https://hub.docker.com/layers/voltha/voltha-openolt-adapter/4.4.9/images/sha256-844eac272323dc8bca10880a111957a95839578b3210dd777be5ac9370aaa52e?context=explore>`__
-
-
- - ``N``
+ - ``N`` `VOL-5055 <https://jira.opencord.org/browse/VOL-5055>`_
* - `voltha-protos <https://gerrit.opencord.org/plugins/gitiles/voltha-protos>`_
- ``5.4.11``
- `5.4.11 <https://gerrit.opencord.org/plugins/gitiles/voltha-protos>`__
@@ -446,6 +416,85 @@
- `Docker Images: Voltha <https://docs.voltha.org/master/resources/docker.html>`_
+VOLTHA Tools
+++++++++++++
+
+.. list-table:: VOLTHA Components
+ :widths: 30, 5, 5, 5, 5, 5, 5, 5, 5, 5
+ :header-rows: 2
+
+ * - Component
+ - VOLTHA
+ - Component
+ -
+ - Gerrit
+ - Github
+ - `Docker <https://hub.docker.com/search?q=voltha>`_
+ - go
+ - pypi
+ -
+ * - Name
+ - Ver
+ - Ver
+ - `with Chart <https://gerrit.opencord.org/gitweb?p=helm-charts.git;a=tree;f=bbsim>`_
+ - ULR
+ - URL
+ - URL
+ -
+ -
+ - status
+ * -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ * - `voltha-docs <https://gerrit.opencord.org/plugins/gitiles/voltha-docs>`+ <br> `docs.voltha.org <https://docs.voltha.org>`_
+ - ``2.12.25``
+ -
+ -
+ - `X <https://gerrit.opencord.org/plugins/gitiles/voltha-docs/+/refs/tags/2.12.25>`__
+ - `X <https://github.com/opencord/voltha-docs/releases/tag/2.12.25>`__
+ -
+ -
+ -
+ - ``N``
+ * - `bbsim <https://gerrit.opencord.org/gitweb?p=bbsim.git;a=tree>`__
+ - ``1.14.4``
+ - ``4.8.6``
+ - `chart <https://gerrit.opencord.org/gitweb?p=helm-charts.git;a=tree;f=bbsim>`_
+ -
+ - `X <https://github.com/opencord/bbsim/tree/v1.14.4>`__
+ - `X <https://hub.docker.com/layers/voltha/bbsim/1.14.4/images/sha256-c23de193c1d7cf8d32c48edfbec4bfa6c47dbeecd4b31d040da0255eeab2ec58?context=explore>`__
+ -
+ -
+ - ``N``
+ * - `Bbsim-sadis-server <https://gerrit.opencord.org/gitweb?p=bbsim-sadis-server.git;a=tree>`__
+ -
+ - ``0.3.4``
+ - `0.3.2 <https://gerrit.opencord.org/plugins/gitiles/voltha-helm-charts/+/refs/heads/master/bbsim-sadis-server/Chart.yaml>`_
+ - `X <https://gerrit.opencord.org/plugins/gitiles/bbsim-sadis-server/+/refs/tags/v0.3.4>`__
+ - `X <https://github.com/opencord/bbsim-sadis-server/releases/tag/v0.3.4>`__
+ -
+ -
+ -
+ - ``N``
+ * - `voltctl <https://gerrit.opencord.org/gitweb?p=voltctl.git;a=tree>`_
+ - ``1.8.3``
+ -
+ -
+ - `X <https://gerrit.opencord.org/plugins/gitiles/voltctl/+/refs/tags/v1.8.3>`__
+ - `X <https://github.com/opencord/voltctl/tree/v1.8.3>`__
+ -
+ -
+ -
+ - ``N``
+
+
Helm Chart Versions
+++++++++++++++++++
This section refers to the macro charts to deploy the required infrastructure and a (or many) VOLTHA stacks: