Update release notes, adding howto pages for documenting individual release activities
Change-Id: I2fb29c4ed4467126bfcdaa097b1dd8329ce7adfe
diff --git a/VERSION b/VERSION
index dcb27a7..3564f00 100644
--- a/VERSION
+++ b/VERSION
@@ -1 +1 @@
-2.12.5
+2.12.5.1-dev1
diff --git a/howto/release/charts/index.rst b/howto/release/charts/index.rst
index 8e79243..b1a4f20 100644
--- a/howto/release/charts/index.rst
+++ b/howto/release/charts/index.rst
@@ -13,3 +13,10 @@
- make test
- make lint-chart
- make lint-helm
+
+onos
+----
+
+- Update ONOS components `voltha-infra/values.yaml <https://gerrit.opencord.org/plugins/gitiles/voltha-helm-charts/+/refs/heads/master/voltha-infra/values.yaml>`_
+
+
diff --git a/howto/release/index.rst b/howto/release/index.rst
index 06b7d39..4d28d04 100644
--- a/howto/release/index.rst
+++ b/howto/release/index.rst
@@ -23,5 +23,7 @@
voltctl/see_also
checklist
+ repositories/index
scripts/preparation
scripts/repository-voltha-release
+ voltha-system-tests/index
diff --git a/howto/release/jjb/index.rst b/howto/release/jjb/index.rst
new file mode 100644
index 0000000..f934a9a
--- /dev/null
+++ b/howto/release/jjb/index.rst
@@ -0,0 +1,39 @@
+repo:ci-management jjb/
+=======================
+
+- grep -r 'voltha-2.11' jjb/
+
+ - Gather a complete list of pipeline files ot modify for release.
+
+- jjb/pipeline/voltha/master
+
+ - Add new release branch names
+
+- jjb/pipeline/voltha/
+
+ - jjb/pipeline/voltha/voltha-2.12/bbsim-tests.groovy
+ - jjb/pipeline/voltha/voltha-2.12/physical-build.groovy
+
+ - Clone master branch scripts into a release subdirectory:
+
+ - mkdir -p voltha-2.12
+ - rsync -rv --checksum master/. voltha-2.12/.
+
+ - Compare clone with an older release to augment master logic
+
+ - diff voltha-2.11 voltha-2.12
+ - Compare against the last release
+ - Update scripts to remove dependencies on master.
+
+- jjb/software-upgrades.yaml
+
+ - Clone ``*-master`` record into ``*-(release-branch)``
+ - Update version strings and nexus oar paths with deployed artifact versions.
+ - Update lingering `base-tag versions <https://jira.opencord.org/browse/VOL-5082>`_
+
+- See `VOL-5082 <https://jira.opencord.org/browse/VOL-5082>`_
+- jjb/verify/bbsim-sadis-server.yaml
+- jjb/verify/bbsim.yaml
+-
+ - Clone records for the new v.x release.
+ - Comment out deprecated releases beyond LTS (For 2.12: voltha-2.8, etc)
diff --git a/howto/release/repositories/ci-management/index.rst b/howto/release/repositories/ci-management/index.rst
new file mode 100644
index 0000000..f2dcad1
--- /dev/null
+++ b/howto/release/repositories/ci-management/index.rst
@@ -0,0 +1,23 @@
+Repository: ci-management
+=========================
+
+Release tasks for the volth-protos repository
+
+Preparation
+-----------
+- Create a jira ticket for tracking
+- Triage build for problems
+- Change VERSION string to be a ``*.1-dev`` developer release
+
+
+repo:ci-management jjb/
+-----------------------
+- Clone and branch test pipelines for testing
+
+Final prep and submit
+---------------------
+
+.. code-block:: shell-session
+ :caption: Final Prep
+
+ make lint
diff --git a/howto/release/repositories/index.rst b/howto/release/repositories/index.rst
new file mode 100644
index 0000000..60f9081
--- /dev/null
+++ b/howto/release/repositories/index.rst
@@ -0,0 +1,12 @@
+Release
+=======
+
+.. toctree::
+ :maxdepth: 1
+
+ voltha-protos/index
+
+ ci-management/index
+ ofagent-go/index
+ voltha-lib-go/index
+ voltha-onos/index
diff --git a/howto/release/repositories/voltha-onos/index.rst b/howto/release/repositories/voltha-onos/index.rst
new file mode 100644
index 0000000..73d3db8
--- /dev/null
+++ b/howto/release/repositories/voltha-onos/index.rst
@@ -0,0 +1,12 @@
+Repository: voltha-onos
+=======================
+
+- make sterile distclean
+- find . ! -path './vendor/*' -name '*.go' -print0 | xargs -0 gofmt -s -w
+- make mod-update
+- make lint
+- make help
+
+Charts
+------
+ o voltha-helm-charts/voltha-infra/values.yaml
diff --git a/release_notes/voltha_2.12.rst b/release_notes/voltha_2.12.rst
index 7331bfc..de1c08f 100644
--- a/release_notes/voltha_2.12.rst
+++ b/release_notes/voltha_2.12.rst
@@ -203,11 +203,13 @@
- `X <https://gerrit.opencord.org/plugins/gitiles/sadis/+/refs/tags/5.11.1>`__
- `X <https://github.com/opencord/sadis/releases/tag/5.11.1>`__
+- `Docker Images: opencord <https://hub.docker.com/search?q=opencord>`_
+
VOLTHA Components
+++++++++++++++++
.. list-table:: VOLTHA Components
- :widths: 30, 5, 5, 5, 5, 5, 5
+ :widths: 30, 5, 5, 5, 5, 5, 5, 5, 5, 5
:header-rows: 2
* - Component
@@ -217,13 +219,19 @@
- Gerrit
- Github
- `Docker <https://hub.docker.com/search?q=voltha>`_
+ - go
+ - pypi
+ -
* - Name
- - Version
- - Version
+ - Ver
+ - Ver
- `with Chart <https://gerrit.opencord.org/gitweb?p=helm-charts.git;a=tree;f=bbsim>`_
- ULR
- URL
- URL
+ -
+ -
+ - status
* -
-
-
@@ -231,6 +239,9 @@
-
-
-
+ -
+ -
+ -
* - `Helm Charts (voltha-helm-charts) <https://gerrit.opencord.org/gitweb?p=voltha-helm-charts.git;a=tree>`_
- ``3.2.2-dev1``
-
@@ -238,6 +249,9 @@
- `X <https://gerrit.opencord.org/plugins/gitiles/voltha-helm-charts/+/refs/heads/master>`__
- `X <https://github.com/opencord/voltha-helm-charts/tree/3.2.0>`__
-
+ -
+ -
+ -
* - `bbsim <https://gerrit.opencord.org/gitweb?p=bbsim.git;a=tree>`__
- ``1.14.4``
- ``4.8.6``
@@ -245,6 +259,9 @@
-
- `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>`__
+ -
+ -
+ -
* - `Bbsim-sadis-server <https://gerrit.opencord.org/gitweb?p=bbsim-sadis-server.git;a=tree>`_
-
- ``0.3.4``
@@ -252,6 +269,9 @@
- `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>`__
-
+ -
+ -
+ -
* - `ofagent-go <https://gerrit.opencord.org/gitweb?p=ofagent-go.git;a=tree>`_
- ``2.1.3``
- ``2.1.3``
@@ -259,6 +279,9 @@
-
- `X <https://github.com/opencord/ofagent-go>`__
- `1.1.4-? <https://hub.docker.com/layers/voltha/ofagent-go/1.1.4/images/sha256-8231111b69c8643c4981d64abff0a85d71f80763bb98632bb101e92b89882647?context=explore>`_
+ -
+ -
+ -
* - `openolt agent <https://gerrit.opencord.org/gitweb?p=openolt.git;a=tree>`_
-
- ``4.2.12``
@@ -266,6 +289,9 @@
-
- `X <https://github.com/opencord/openolt>`__
-
+ -
+ -
+ -
* - `voltctl <https://gerrit.opencord.org/gitweb?p=voltctl.git;a=tree>`_
- ``1.8.3``
-
@@ -273,6 +299,9 @@
- `X <https://gerrit.opencord.org/plugins/gitiles/voltctl/+/refs/tags/v1.8.3>`__
- `X <https://github.com/opencord/voltctl/tree/v1.8.3>`__
-
+ -
+ -
+ -
* - `voltha-go <https://gerrit.opencord.org/gitweb?p=voltha-go.git;a=tree>`_
- ``3.1.8``
- docker
@@ -280,13 +309,20 @@
- `X <https://gerrit.opencord.org/plugins/gitiles/voltha-go/+/refs/tags/v3.1.8>`__
- `X <https://github.com/opencord/voltha-go/tree/v3.1.8>`__
-
+ - `v7 <https://pkg.go.dev/github.com/opencord/voltha-lib-go/v7>`_
+ `v5 <https://pkg.go.dev/github.com/opencord/voltha-lib-go/v5>`_
+ -
+ -
* - `voltha-lib-go <https://gerrit.opencord.org/plugins/gitiles/voltha-lib-go>`_
- - ``2.11.3 (?)``
- - ``7.3.2``
+ - ``7.4.4``
-
- - `X <https://gerrit.opencord.org/plugins/gitiles/voltha-lib-go/+/refs/tags/v7.3.2>`__
- - `X <https://github.com/opencord/voltha-lib-go/releases/tag/v7.3.2>`__
-
+ - `X <https://gerrit.opencord.org/plugins/gitiles/voltha-lib-go/+/refs/tags/v7.4.4>`__
+ - `X <https://github.com/opencord/voltha-lib-go/releases/tag/v7.4.4>`__
+ -
+ -
+ -
+ - triage
* - `voltha-onos <https://gerrit.opencord.org/gitweb?p=voltha-onos.git;a=tree>`_
-
- ``5.1.2``
@@ -294,6 +330,9 @@
- `X <https://gerrit.opencord.org/plugins/gitiles/voltha-onos/+/refs/tags/5.1.3>`__
- `X <https://github.com/opencord/voltha-onos/tree/5.1.3>`__
- `X <https://hub.docker.com/layers/voltha/voltha-onos/5.1.3/images/sha256-d9c686acf177ed823ff359dc43ba59aab05ae067be27c92e48c08b72f94b9ca3?context=explore>`__
+ -
+ -
+ -
* - `voltha-openonu-adapter-go <https://gerrit.opencord.org/gitweb?p=voltha-openonu-adapter-go.git;a=tree>`_
-
- ``2.7.3``
@@ -301,6 +340,9 @@
- `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>`__
+ -
+ -
+ -
* - `voltha-openolt-adapter <https://gerrit.opencord.org/gitweb?p=voltha-openolt-adapter.git;a=tree>`_
- ``v4.2.12``
- ``4.2.6``
@@ -308,12 +350,19 @@
- `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>`__
+ -
+ -
+ -
* - `voltha-protos <https://gerrit.opencord.org/plugins/gitiles/voltha-protos>`_
-
- - `5.3.8 <https://pypi.org/project/voltha-protos/5.3.8>`__
+ - `5.4.7 <https://pypi.org/project/voltha-protos/>`__
+ `tgz <https://files.pythonhosted.org/packages/96/3d/c7ddb804cd8f47fb1fd1f7d11e11aa06fe22611e7363d3cf928852e2515d/voltha-protos-5.4.7.tar.gz>`_
-
- - `X <https://gerrit.opencord.org/plugins/gitiles/voltha-protos/+/refs/tags/v5.3.8>`__
- - `X <https://github.com/opencord/voltha-protos/tree/v5.3.8>`__
+ - `X <https://gerrit.opencord.org/plugins/gitiles/voltha-protos/+/refs/tags/v5.4.7>`__
+ - `X <https://github.com/opencord/voltha-protos/tree/v5.4.7>`__
+ - `stale <https://hub.docker.com/r/voltha/voltha-protos>`__
+ -
+ - `X <https://pypi.org/project/voltha-protos/>`__
-
* - `voltha-system-tests <https://github.com/opencord/voltha-system-tests/releases/tag/2.9.0>`__
- ``2.11.10``
@@ -321,6 +370,9 @@
-
- `X <https://gerrit.opencord.org/plugins/gitiles/voltha-system-tests/+/refs/tags/2.11.10>`__
- `X <https://github.com/opencord/voltha-system-tests/tree/2.11.10>`__
+ - `stale <https://hub.docker.com/r/voltha/voltha-protos>`_
+ -
+ -
-
* - ppoeagent
- ``1.2.1``
@@ -329,6 +381,9 @@
-
-
-
+ -
+ -
+ -
* - segmentrouting
- ``3.0.0``
-
@@ -336,6 +391,11 @@
-
-
-
+ -
+ -
+ -
+
+- `Docker Images: Voltha <https://docs.voltha.org/master/resources/docker.html>`_
Helm Chart Versions
@@ -422,7 +482,7 @@
Get Involved
------------
-We'd love to accept your patches and contributions to the VOLTHA project, join the community!
+<We'd love to accept your patches and contributions to the VOLTHA project, join the community!
| Here are a few resources to get you started: