Create placeholders for documenting release by repository
Change-Id: I0e4af607de9e6aac3424676f344714e0d9e6fde8
diff --git a/VERSION b/VERSION
index 9634e38..14f37ac 100644
--- a/VERSION
+++ b/VERSION
@@ -1 +1 @@
-2.12.12
+2.12.13
diff --git a/howto/code/voltha-protos.rst b/howto/code/voltha-protos.rst
index 2403b63..71da5e1 100644
--- a/howto/code/voltha-protos.rst
+++ b/howto/code/voltha-protos.rst
@@ -1,3 +1,5 @@
+.. howto_code_voltha-protos:
+
Modifying repository voltha-protos
==================================
@@ -16,9 +18,9 @@
cd voltha-protos
vi ...
- make build
- make test
- make lint
+ % make lint
+ % make build
+ % make test
.. list-table:: Build & Test locally
:widths: 30, 80
diff --git a/howto/release/checklist.rst b/howto/release/checklist.rst
index 4c9c265..474a5b5 100644
--- a/howto/release/checklist.rst
+++ b/howto/release/checklist.rst
@@ -172,3 +172,6 @@
Release voltha-protos & friends in order
----------------------------------------
https://docs.voltha.org/master/overview/release_process.html?highlight=charts%20yaml
+
+EOF
+---
diff --git a/howto/release/components/onos_components.rst b/howto/release/components/onos_components.rst
index 896b42a..0bc27bb 100644
--- a/howto/release/components/onos_components.rst
+++ b/howto/release/components/onos_components.rst
@@ -1,3 +1,5 @@
+.. _howto_release_components_onos_components:
+
VOLTHA Components: ONOS
=======================
diff --git a/howto/release/components/sadis b/howto/release/components/sadis
index a916270..be770ed 100644
--- a/howto/release/components/sadis
+++ b/howto/release/components/sadis
@@ -6,7 +6,7 @@
Inventory pom.xml
Update MVN Plugin versions in use.
-For Relase remove -SNAPSHOT and build.
+For Release remove -SNAPSHOT and build.
# Document component dependency page
diff --git a/howto/release/components/voltha-protos.rst b/howto/release/components/voltha-protos.rst
index 6e4e108..ae087a5 100644
--- a/howto/release/components/voltha-protos.rst
+++ b/howto/release/components/voltha-protos.rst
@@ -66,3 +66,7 @@
- Release branch created
- VERSION file edit on master has bumped version to {major}.{minor+1}.0.``-dev``
- All jenkins jobs for repo:voltha-protos reports PASS.
+
+See Also
+========
+- :ref:`howto_code_voltha-protos`
diff --git a/howto/release/hierarchy/index.rst b/howto/release/hierarchy/index.rst
index f4ee747..813171e 100644
--- a/howto/release/hierarchy/index.rst
+++ b/howto/release/hierarchy/index.rst
@@ -1,6 +1,16 @@
VOLTHA Components: hierarchy
============================
+Release: bbsim
+^^^^^^^^^^^^^^
+ - update: repo:ci-management:vars/installVoltctl.groovy
+
+voltha-go
+^^^^^^^^^
+
+voltha-lib-go
+^^^^^^^^^^^^^
+
voltha-onos
^^^^^^^^^^^
@@ -20,10 +30,6 @@
- voltha-lib-go
- voltha-protos
-Relase: voltctl
-
- - update: repo:ci-management:vars/installVoltctl.groovy
-
voltha-protos
^^^^^^^^^^^^^
- `deps: go.mod <https://gerrit.opencord.org/plugins/gitiles/ofagent-go/+/refs/heads/master/go.mod>`_
@@ -31,8 +37,8 @@
- voltha-lib-go
- voltha-protos
-Relase: voltctl
-
+Release: voltctl
+^^^^^^^^^^^^^^^^
- update: repo:ci-management:vars/installVoltctl.groovy
See Also
diff --git a/howto/release/preparation.rst b/howto/release/preparation.rst
index c922106..9b44aea 100644
--- a/howto/release/preparation.rst
+++ b/howto/release/preparation.rst
@@ -16,6 +16,19 @@
- On release day click the [Release] button to close out the desktop.
+Release-less tickets
+^^^^^^^^^^^^^^^^^^^^
+
+- `docs.voltha.org::Fix Version/s <https://docs.voltha.org/master/overview/contributing/jira_tickets.html>`_
+
+ - VOLTHA enhancements, features, etc are considered for release notes based
+ on the "Fix Version/s" field of a jira ticket. Ticket owner and target
+ release will need to be specified for each.
+ - Use the query below to identify problems and fix or ask people to review
+ during the weekly TST meeting.
+ - Query for `release-less v2.12 <https://jira.opencord.org/browse/VOL-5105?jql=(%20project%20IN%20(SEBA%2CVOL)%20)%20AND%20(Resolved%20%3E%3D%202022-12-31)%20AND%20(Resolved%20%3C%3D%202024-02-01)%20AND%20(resolution%20NOT%20IN%20(%22Duplicate%22%2C%22Won%27t%20Do%22%2C%22Won%27t%20Fix%22))%20AND%20(resolved%20IS%20NOT%20EMPTY)%20AND%20(fixversion%20IS%20EMPTY)>_ tickets. These are tickets opened between 2022-12-01 and 2024-02-01.
+ - Adjust query release dates and insert url ``ctrl-K`` into the `Weekly TST Meeting Agenda Page <https://www.google.com/url?q=https://docs.google.com/document/d/1mNqronCip_-tDjFI-ZoudNteC3AnOcVONPHz7HuW8Eg/edit?usp%3Dsharing&sa=D&source=calendar&ust=1704724031747005&usg=AOvVaw1fRxjG_mEhovC-cPGZ4F_c>`_
+
Confluence
----------
Create a `release tracking page <https://wiki.opencord.org>`_ in confluence, there are a lot of details
diff --git a/howto/release/repositories/ci-management/index.rst b/howto/release/repositories/ci-management/index.rst
index f2dcad1..38c9ae2 100644
--- a/howto/release/repositories/ci-management/index.rst
+++ b/howto/release/repositories/ci-management/index.rst
@@ -1,23 +1,6 @@
Repository: ci-management
=========================
-Release tasks for the volth-protos repository
+.. toctree::
+ :maxdepth: 1
-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
index 3500072..e79b098 100644
--- a/howto/release/repositories/index.rst
+++ b/howto/release/repositories/index.rst
@@ -12,8 +12,7 @@
voltha-go/index
voltha-onos/index
- voltha-protos/index
- voltha-openolt-adapter/index
+ voltha-openolt-adapter-go/index
voltha-helm-charts/index
voltctl/index
bbsim/index
diff --git a/howto/release/repositories/pod-configs/index.rst b/howto/release/repositories/pod-configs/index.rst
index 952183a..6dd3133 100644
--- a/howto/release/repositories/pod-configs/index.rst
+++ b/howto/release/repositories/pod-configs/index.rst
@@ -4,4 +4,3 @@
.. toctree::
:maxdepth: 1
- release
diff --git a/howto/release/repositories/voltha-lib-go/index.rst b/howto/release/repositories/voltha-lib-go/index.rst
index 7634c91..0702669 100644
--- a/howto/release/repositories/voltha-lib-go/index.rst
+++ b/howto/release/repositories/voltha-lib-go/index.rst
@@ -4,4 +4,3 @@
.. toctree::
:maxdepth: 1
- release
diff --git a/howto/release/repositories/voltha-lib-go/misc.rst b/howto/release/repositories/voltha-lib-go/misc.rst
index 90260f4..9658441 100644
--- a/howto/release/repositories/voltha-lib-go/misc.rst
+++ b/howto/release/repositories/voltha-lib-go/misc.rst
@@ -1,10 +1,12 @@
Misc Todo Items
===============
-- Update copyright notices
-- find . ! -path './vendor/\*' -print | xargs -n1 gofmt -s -e -w
-- go.mod
+- Baseline build
+ - Update copyright notices :ref:`Release Task Copyright`
+ - Golang syntax formatting :ref:`Release Task Golang Syntax`
+
+- Pre-branch build
- Update module versions for voltha/onos components
- make mod-update
diff --git a/howto/release/repositories/voltha-onos/index.rst b/howto/release/repositories/voltha-onos/index.rst
index 0553034..abef329 100644
--- a/howto/release/repositories/voltha-onos/index.rst
+++ b/howto/release/repositories/voltha-onos/index.rst
@@ -4,6 +4,4 @@
.. toctree::
:maxdepth: 1
- release
- dependencies
- todo
+ resources
diff --git a/howto/release/repositories/voltha-onos/resources.rst b/howto/release/repositories/voltha-onos/resources.rst
new file mode 100644
index 0000000..0e0ca93
--- /dev/null
+++ b/howto/release/repositories/voltha-onos/resources.rst
@@ -0,0 +1,8 @@
+Resources
+=========
+
+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/howto/release/repositories/voltha-onos/todo.rst b/howto/release/repositories/voltha-onos/todo.rst
index 73d3db8..2058ad3 100644
--- a/howto/release/repositories/voltha-onos/todo.rst
+++ b/howto/release/repositories/voltha-onos/todo.rst
@@ -2,7 +2,7 @@
=======================
- make sterile distclean
-- find . ! -path './vendor/*' -name '*.go' -print0 | xargs -0 gofmt -s -w
+- Golang syntax formatting :ref:`Release Task Golang Syntax`
- make mod-update
- make lint
- make help
diff --git a/howto/release/repositories/voltha-openolt-adapter-go/index.rst b/howto/release/repositories/voltha-openolt-adapter-go/index.rst
new file mode 100644
index 0000000..73aa3ce
--- /dev/null
+++ b/howto/release/repositories/voltha-openolt-adapter-go/index.rst
@@ -0,0 +1,6 @@
+Repository: voltha-openolt-adapter-go
+=====================================
+
+.. toctree::
+ :maxdepth: 1
+
diff --git a/howto/release/tasks/copyright.rst b/howto/release/tasks/copyright.rst
new file mode 100644
index 0000000..64314af
--- /dev/null
+++ b/howto/release/tasks/copyright.rst
@@ -0,0 +1,15 @@
+.. _Release Task Copyright:
+
+Copyright Notice
+================
+
+Update copyright notice ending date on sources.
+
+.. code-block:: shell-session
+ :caption: Update copyrigth notice ending date.
+
+ # Clone copyright repository
+ % git clone git@github.com:joey-onf/copyright.git /tmp/copyright
+
+ % cd myrepo
+ % /tmp/copyright/gather.sh
diff --git a/howto/release/tasks/golang_gofmt_syntax.rst b/howto/release/tasks/golang_gofmt_syntax.rst
new file mode 100644
index 0000000..0f6bb1e
--- /dev/null
+++ b/howto/release/tasks/golang_gofmt_syntax.rst
@@ -0,0 +1,14 @@
+.. _Release Task Golang Syntax:
+
+GOLANG: Syntax formatting with gofmt
+====================================
+
+Use the gofmt command to reformat golang sources gathered outside the vendor/ directory.
+
+.. code-block:: shell-session
+ :caption:
+
+ % make golang-fmt
+
+ % cd mysandbox
+ % find . ! -path './vendor/\*' -name '*.go' -print | xargs -n1 gofmt -s -e -w
diff --git a/howto/release/tasks/index.rst b/howto/release/tasks/index.rst
new file mode 100644
index 0000000..9507df2
--- /dev/null
+++ b/howto/release/tasks/index.rst
@@ -0,0 +1,28 @@
+Release Tasks
+=============
+
+BUILD[baseline]: detect pre-existing corruption
+-----------------------------------------------
+
+- Apply cosmetic edits to sorce: comments, formatting, nothing that changes logic flow.
+- Update copyright notice ending date (if December release).
+- gofmt - standard golang source formatting.
+- Else add/modify comments in all sources.
+- These edits are cosmetic and should be a NOP.
+- Failing jobs are a sign of pre-existing corruption. Open a jira ticket and fix.
+
+BUILD[pre-release]: dependency and module updates
+-------------------------------------------------
+
+- make go mod-update
+- Update copyright notices :ref:`Release Task Copyright`
+
+Standard syntax & formatting
+----------------------------
+
+- Golang syntax fomatting :ref:`Release Task Golang Syntax`
+
+Chart.yaml
+----------
+
+- Update version string(s) for voltha-lib-go.
diff --git a/overview/release_process.rst b/overview/release_process.rst
index e4e6a9f..3157f7c 100644
--- a/overview/release_process.rst
+++ b/overview/release_process.rst
@@ -74,22 +74,34 @@
ONOS Apps
^^^^^^^^^
+:ref:`_howto_release_components_onos_components`
+
The ONOS Apps need to be released in a different manner.
-There is a Jenkins job to release ONOS app: https://jenkins.opencord.org/job/onos-app-release.
-It requires to be triggered with specific parameters, as an example you can check the latest job in that pipeline.
+A dedicated Jenkins job is used to release ONOS app: https://jenkins.opencord.org/job/onos-app-release.
-1. Build with parameters: use the name of the repo (not of the app itself)
+The job will need to be initiated using specific parameters, for an example view the lateset pipeline job.
+
+1. `Build with parameters <https://jenkins.opencord.org/job/onos-app-release>`_: use the name of the repo (not of the app itself)
+ - appRepo: sadis
+ - appName: sadis
+ - apiVersion: `sadis:5.12.0-SNAPSHOT <https://gerrit.opencord.org/plugins/gitiles/sadis/+/refs/heads/master/api/pom.xml#22>`__
+ - nextApiVersion: version+1
+ - version: `sadis:5.12.0-SNAPSHOT <https://gerrit.opencord.org/plugins/gitiles/sadis/+/refs/heads/master/app/pom.xml#20>`__
+ - nextVersion: version+1
+ - branch: master
+ - jdkDistro: java-11-amazon-corretto
+
2. Wait for build to complete
-3. Merge the patches on gerrit https://gerrit.opencord.org/q/owner:do-not-reply%2540opennetworking.org
-
+3. Merge the component patches on gerrit
+ - `View <https://gerrit.opencord.org/q/owner:do-not-reply%2540opennetworking.org>`_
- Two pull requests are created modifying pom.xml.
- Approve patch one (-SNAPSHOT: no) to initiate a release build.
- Approve patch two (-SNAPSHOT: yes) to revert pom.xml to a non-release version.
-4. Approval and merge will trigger a `jenkins job <https://jenkins.opencord.org/job/maven-publish_sadis/>`_ that publish
- an artifact into the staging repo on `sonatype <https://oss.sonatype.org>`_. From there the artifact will need
- to be released into maven central.
+4. Approval and merge will trigger `jenkins::maven-publish_sadis <https://jenkins.opencord.org/job/maven-publish_sadis/>`_
+ that will publish an artifact into the staging repo on `sonatype <https://oss.sonatype.org>`_.
+ Once published to the staging server the artifact will need to be released to maven central.
- Login into the sonatype server (for username and password contact michelle@opennetworking.org)
- search for org.opencord
diff --git a/overview/troubleshooting.rst b/overview/troubleshooting.rst
index f61c1a4..12404b4 100644
--- a/overview/troubleshooting.rst
+++ b/overview/troubleshooting.rst
@@ -69,7 +69,7 @@
wget "https://wiki.wireshark.org/Contrib?action=AttachFile&do=get&target=omci.lua"
wget "https://wiki.wireshark.org/Contrib?action=AttachFile&do=get&target=BinDecHex.lua"
-- IMPORTANT - Apply `this <https://ask.wireshark.org/question/4557/bindechexlua-error-bad-argument-to-module-packageseeall/?answer=4573#post-id-4573>`_ fix to BinDecHex.lua.
+- IMPORTANT - Apply `this <http://ask.wireshark.org/question/4557/bindechexlua-error-bad-argument-to-module-packageseeall/?answer=4573#post-id-4573>`_ fix to BinDecHex.lua.
- TODO NOTE - The BinDecHex.lua thread is 4 years old, is the patch still
required or has it been incorporated into the code base ?
diff --git a/requirements.txt b/requirements.txt
index 83daea2..ba388d7 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -1,6 +1,6 @@
# -*- makefile -*-
-Sphinx~=4.1.2
+Sphinx~=4.1.2 # 2021-07-26
doc8~=0.9.0
docutils==0.16
recommonmark~=0.6.0
@@ -11,4 +11,10 @@
sphinx-reload
+## ----------------------------------------------------
+## Bogus imports
+## ----------------------------------------------------
+## Implicit unused dependency -- requires Sphinx v5.0.2
+# sphinxcontrib-applehelp==1.0.8
+
# [EOF]