Enhance Submitting Code section
overview/contributing.rst
overview/contributing/code_review.rst
overview/contributing/copyright.rst
overview/contributing/jira_tickets.rst
howto/code/commit-message.rst
howto/code/pull_request.rst
--------------------------------------
- Document a few items that surfaced in code reviews this morning.
- Add more links to existing documentation.
howto/release/repositories/pod-configs/
howto/release/repositories/voltha-onos/release.rst
howto/release/repositories/voltha-onos/todo.rst
--------------------------------------------------
- Create skeleton directories for documenting release items needed.
- Submitted as part of an earlier patch but included here for good measure.
Change-Id: Ibe118570bdf19ced1d06d6e9efb10fd1419f82ef
diff --git a/howto/release/repositories/index.rst b/howto/release/repositories/index.rst
index 1b9ac3e..3a9a91e 100644
--- a/howto/release/repositories/index.rst
+++ b/howto/release/repositories/index.rst
@@ -11,3 +11,10 @@
voltha-lib-go/index
voltha-onos/index
voltha-protos/index
+ voltha-openolt-adapter/index
+ voltha-helm-charts/index
+ voltctl/index
+ bbsim/index
+ openolt/index
+ pod-configs/index
+ pod-cofnigs/index
diff --git a/howto/release/repositories/pod-configs/index.rst b/howto/release/repositories/pod-configs/index.rst
new file mode 100644
index 0000000..952183a
--- /dev/null
+++ b/howto/release/repositories/pod-configs/index.rst
@@ -0,0 +1,7 @@
+Repository: pod-configs
+=======================
+
+.. toctree::
+ :maxdepth: 1
+
+ release
diff --git a/howto/release/repositories/pod-configs/release.rst b/howto/release/repositories/pod-configs/release.rst
new file mode 100644
index 0000000..0b0d4ad
--- /dev/null
+++ b/howto/release/repositories/pod-configs/release.rst
@@ -0,0 +1,82 @@
+Repository: pod-configs
+=======================
+
+- NO VERSION FILE
+- Tag and branch repositories (order is important)
+- Update .gitreview, set defaultbranch=voltha-2.12-beta for commits
+- Update VERSION file to prevent future conflicts.
+
+
+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
+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
+
+ # ------------------------------------------------------------
+ # 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"
+
+See Also
+--------
+https://docs.voltha.org/master/release_notes/release_process.html
+
+
+.gitreview
+----------
+
+.. code-block:: shell-session
+ :caption: Create a release branch attached to the release tag
+
+ grep -v 'defaultbranch' .gitreview > .gitreview.tmp
+ echo "defaultbranch=voltha-2.12-beta" >> .gitreview.tmp
+ mv -f .gitreview.tmp .gitreview
+
+
+VERSION File
+^^^^^^^^^^^^
+
+Minor release version number must be incremented to prevent future conflicts
+with the patch branch.
+
+- branch=main VERSION=1.2.3
+
+ - Update VERSION to contain 1.2.4 or 1.3.0
+ - commit and merge
+
+ - Update VERSION file/patch branch to contain 1.2.3.1
+ - Update defaultbranch= in .gitreview
+ - commit and merge
+
diff --git a/howto/release/repositories/voltha-onos/index.rst b/howto/release/repositories/voltha-onos/index.rst
index 73d3db8..0553034 100644
--- a/howto/release/repositories/voltha-onos/index.rst
+++ b/howto/release/repositories/voltha-onos/index.rst
@@ -1,12 +1,9 @@
Repository: voltha-onos
=======================
-- make sterile distclean
-- find . ! -path './vendor/*' -name '*.go' -print0 | xargs -0 gofmt -s -w
-- make mod-update
-- make lint
-- make help
+.. toctree::
+ :maxdepth: 1
-Charts
-------
- o voltha-helm-charts/voltha-infra/values.yaml
+ release
+ dependencies
+ todo
diff --git a/howto/release/repositories/voltha-onos/release.rst b/howto/release/repositories/voltha-onos/release.rst
new file mode 100644
index 0000000..2ee8af6
--- /dev/null
+++ b/howto/release/repositories/voltha-onos/release.rst
@@ -0,0 +1,92 @@
+Release: voltha-onos
+====================
+
+- Tag and branch repositories (order is important)
+- Update .gitreview, set defaultbranch=voltha-2.12-beta for commits
+- Update VERSION file to prevent future conflicts.
+
+
+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
+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
+
+ # ------------------------------------------------------------
+ # 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"
+
+See Also
+--------
+https://docs.voltha.org/master/release_notes/release_process.html
+
+
+.gitreview
+----------
+
+.. code-block:: shell-session
+ :caption: .gitreview for release branch=voltha-2.12
+
+ grep -v 'defaultbranch=' .gitreview > .gitreview.tmp
+ echo "defaultbranch=voltha-2.12" >> .gitreview.tmp
+ mv -f .gitreview.tmp .gitreview
+
+
+.gitreview
+----------
+
+.. code-block:: shell-session
+ :caption: .gitreview for release branch=master
+
+ grep -v 'defaultbranch' .gitreview > .gitreview.tmp
+ echo "defaultbranch=master" >> .gitreview.tmp
+ mv -f .gitreview.tmp .gitreview
+
+
+VERSION File
+^^^^^^^^^^^^
+
+Minor release version number must be incremented to prevent future conflicts
+with the patch branch. When version file contains either 1.2.1 or 1.2.1-dev:
+
+- branch=main VERSION=1.2.3-dev
+
+ - Update VERSION to contain 1.2.4 or 1.3.0
+ - commit and merge
+
+- branch=voltha-2.12 VERSION=1.2.2
+
+ - Update release / bug fix branch
+ - commit and merge
diff --git a/howto/release/repositories/voltha-onos/todo.rst b/howto/release/repositories/voltha-onos/todo.rst
new file mode 100644
index 0000000..73d3db8
--- /dev/null
+++ b/howto/release/repositories/voltha-onos/todo.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