VOL-4840 - Tracking ticket for release documentation
conf.py
-------
o Define more external link macros to shorten URLs.
Misc
----
o Re-create patch Ifa5009e78f85944c9b6ce2991bed86ae852fcd4b
to re-sync with master -vs- resovle server merge conflicts.
o Bulk copyright update.
o Update more released version strings in the component dependency grid.
Change-Id: I71b7cfbaa3f52191d28e1d2164784e6ffaad86a1
diff --git a/howto/edit_voltha_docs.rst b/howto/edit_voltha_docs.rst
index fcbf98e..540b734 100644
--- a/howto/edit_voltha_docs.rst
+++ b/howto/edit_voltha_docs.rst
@@ -42,7 +42,7 @@
Guides for RST:
- https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html
-- http://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html
+- https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html
RST has multiple heading formats possible, the ones we're using are in the
order for the HTML h1-h5: ``=``, ``-`` ``"``, ``'``, ``^``.
diff --git a/howto/release/ci-management/index.rst b/howto/release/ci-management/index.rst
new file mode 100644
index 0000000..6a69d0f
--- /dev/null
+++ b/howto/release/ci-management/index.rst
@@ -0,0 +1,27 @@
+repo:ci-management
+==================
+
+General
+-------
+
+For an LTS release (v2.11, v2.8) tests on the master branch will need
+to be copied into a named voltha-version folder and updated to checkout
+and exercise tests and source on that branch.
+
+`Jenkins Views <https://jenkins.opencord.org/>`_
+------------------------------------------------
+Begin by creating voltha-{LST} views for the new pipeline jobs.
+
+jjb/software-upgrades.yaml
+--------------------------
+
+- Create a new software-upgrades-test-0211 branch from the old.
+- Update released component versions mentioned in the configs.
+- Update master branch released versions as well.
+- Tricky part, SNAPSHOT versions are not visible to navigation browsing:
+
+ - `org/opencord <https://oss.sonatype.org/content/groups/public/org/opencord>`_
+
+- Instead obtain snapshot version from pom.xml and type in the explicit URL path:
+
+ - `aaa-app/2.9.0-SNAPSHOT <https://oss.sonatype.org/content/groups/public/org/opencord/aaa-app/2.9.0-SNAPSHOT/>`_
diff --git a/howto/release/components/voltha-go.rst b/howto/release/components/voltha-go.rst
new file mode 100644
index 0000000..257faf2
--- /dev/null
+++ b/howto/release/components/voltha-go.rst
@@ -0,0 +1,46 @@
+VOLTHA Components: voltha-go
+============================
+
+Dependencies
+------------
+
+- update go.mod
+
+ - grep '/opencord/' go.mod
+ - omci-lib-go
+ - voltha-protos
+ - voltha-lib-go
+
+
+Validate
+--------
+
+Versioning
+----------
+
+- Based on VERSION file contents in root directory of the repository.
+
+Release
+-------
+
+- Update project copyright notice ending date.
+- Bump /opencord/ component version(s) in go.mod
+- make distclean
+- make lint
+ - if go.mod and go.sum are the only deltas
+ - git commit -F {commit_message_file}
+- make mod-update
+ - git add --all
+ - avoid running 'make lint' prior to git commit --amend
+ - vendor/ files modified, git status reports delta w/o content (file touch?)
+- Review and commit changes.
+- make lint lint-mod
+- If docker is configured
+ - make build test
+- When ready to release a new component version of voltha-openolt-adapter
+
+ - Bump VERSION file to a non-dev semantic version.
+
+- Commit changes and create a pull request.
+- Once approved a jenkins job will launch.
+
diff --git a/howto/release/components/voltha-lib-go.rst b/howto/release/components/voltha-lib-go.rst
index da1b057..8785b06 100644
--- a/howto/release/components/voltha-lib-go.rst
+++ b/howto/release/components/voltha-lib-go.rst
@@ -20,6 +20,27 @@
Release
-------
+<<<<<<< HEAD
- Bump VERSION file to a non-dev semantic version.
- See Validate above
- Commit and approve to trigger a build
+=======
+<<<<<<< HEAD
+- Bump VERSION file to a non-dev semantic version.
+- See Validate above
+- Commit and approve to trigger a build
+=======
+- Bump /opencord/ component versions in go.mod
+- make distclean
+- make mod-update
+- Review and commit changes.
+- make lint-mod
+- When ready to release a new component version of voltha-lib-go
+
+ - Bump VERSION file to a non-dev semantic version.
+
+- Commit changes and create a pull request.
+- Once approved a jenkins job will launch.
+
+>>>>>>> cb4f2e0 (VOL-4840 - Tracking ticket for release documentation.)
+>>>>>>> f854950 (VOL-4840 - Tracking ticket for release documentation.)
diff --git a/howto/release/components/voltha-onos.rst b/howto/release/components/voltha-onos.rst
new file mode 100644
index 0000000..6e84479
--- /dev/null
+++ b/howto/release/components/voltha-onos.rst
@@ -0,0 +1,24 @@
+VOLTHA Components: votlha-onos
+==============================
+
+voltha-onos is the last onos dependency to be released.
+
+Release Steps
+-------------
+
+- After all ONOS component dependencies have been released.
+- Clone the :vol-ger:`voltha-onos` repository.
+- Modify `dependencies.xml <https://gerrit.opencord.org/plugins/gitiles/voltha-onos/+/refs/heads/master/dependencies.xml>`_
+
+ - Update copyright notice.
+ - Update released version for each component.
+
+- Bump the VERSION file string
+
+ - :vol-ger:`voltha-onos/+/refs/heads/master/VERSION`
+ - This will release a new ONOS docker image.
+
+- `release_notes <https://docs.voltha.org/master/release_notes/index.html>`_
+
+ - Update all released component version strings in the grid.
+
diff --git a/howto/release/components/voltha-openolt-adapter.rst b/howto/release/components/voltha-openolt-adapter.rst
new file mode 100644
index 0000000..89ff693
--- /dev/null
+++ b/howto/release/components/voltha-openolt-adapter.rst
@@ -0,0 +1,45 @@
+VOLTHA Components: voltha-openolt-adapter
+=========================================
+
+Dependencies
+------------
+
+- update go.mod
+
+ - grep '/opencord/' go.mod
+ - voltha-protos
+ - voltha-lib-go
+
+
+Validate
+--------
+
+Versioning
+----------
+
+- Based on VERSION file contents in root directory of the repository.
+
+Release
+-------
+
+- Update project copyright notice ending date.
+- Bump /opencord/ component version(s) in go.mod
+- make distclean
+- make lint
+ - if go.mod and go.sum are the only deltas
+ - git commit -F {commit_message_file}
+- make mod-update
+ - git add vendor/ modified files.
+ - avoid running 'make lint' prior to git commit --amend
+ - vendor/ files modified, git status reports delta w/o content (file touch?)
+- Review and commit changes.
+- make lint lint-mod
+- If docker is configured
+ - make build test
+- When ready to release a new component version of voltha-openolt-adapter
+
+ - Bump VERSION file to a non-dev semantic version.
+
+- Commit changes and create a pull request.
+- Once approved a jenkins job will launch.
+
diff --git a/howto/release/components/voltha-openonu-adapter-go.rst b/howto/release/components/voltha-openonu-adapter-go.rst
new file mode 100644
index 0000000..65ff6dc
--- /dev/null
+++ b/howto/release/components/voltha-openonu-adapter-go.rst
@@ -0,0 +1,46 @@
+VOLTHA Components: voltha-openonu-adapter-go
+============================================
+
+Dependencies
+------------
+
+- update go.mod
+
+ - grep '/opencord/' go.mod
+ - omci-lib-go
+ - voltha-protos
+ - voltha-lib-go
+
+
+Validate
+--------
+
+Versioning
+----------
+
+- Based on VERSION file contents in root directory of the repository.
+
+Release
+-------
+
+- Update project copyright notice ending date.
+- Bump /opencord/ component version(s) in go.mod
+- make distclean
+- make lint
+ - if go.mod and go.sum are the only deltas
+ - git commit -F {commit_message_file}
+- make mod-update
+ - git add --all
+ - avoid running 'make lint' prior to git commit --amend
+ - vendor/ files modified, git status reports delta w/o content (file touch?)
+- Review and commit changes.
+- make lint lint-mod
+- If docker is configured
+ - make build test
+- When ready to release a new component version of voltha-openolt-adapter
+
+ - Bump VERSION file to a non-dev semantic version.
+
+- Commit changes and create a pull request.
+- Once approved a jenkins job will launch.
+
diff --git a/howto/release/index.rst b/howto/release/index.rst
index db164b3..e253cb2 100644
--- a/howto/release/index.rst
+++ b/howto/release/index.rst
@@ -3,6 +3,7 @@
.. toctree::
:maxdepth: 2
+ ci-management/index
components/index
hierarchy/index