[VOL-5009] - Create release notes for the v2.12 page.
Change-Id: Iafbc6b683cae034f7cbaf6b0a90c90120bc89506
diff --git a/VERSION b/VERSION
index b0c818e..ccc99d0 100644
--- a/VERSION
+++ b/VERSION
@@ -1 +1 @@
-2.12.3-dev
+2.12.3
diff --git a/conf.py b/conf.py
index 654136c..cfd7dd4 100644
--- a/conf.py
+++ b/conf.py
@@ -325,6 +325,7 @@
r'../release_notes/voltha_2.9.html',
r'../release_notes/voltha_2.10.html',
r'../release_notes/voltha_2.11.html',
+ r'../release_notes/voltha_2.12.html',
#
r'../voltha-helm-charts/README.html',
]
diff --git a/howto/release/index.rst b/howto/release/index.rst
index f68d6b7..29e1002 100644
--- a/howto/release/index.rst
+++ b/howto/release/index.rst
@@ -1,8 +1,11 @@
Release
=======
+
.. toctree::
:maxdepth: 1
+ release-notes
+
ci-management/index
components/index
hierarchy/index
diff --git a/howto/release/release-notes.rst b/howto/release/release-notes.rst
new file mode 100644
index 0000000..6e762dc
--- /dev/null
+++ b/howto/release/release-notes.rst
@@ -0,0 +1,83 @@
+Release Notes
+=============
+
+Intent
+------
+This page details howto create a release notes page on the docs.voltha.org website.
+
+
+Cookbook: Patch #1
+------------------
+- `VOL-5009 <https://jira.opencord.org/browse/VOL-5009>`_ - For tracking, create a jira ticket to create a release notes page.
+- Clone repository `repo:voltha-docs <https://gerrit.opencord.org/plugins/gitiles/voltha-docs>`_
+- Modify `VERSION <https://gerrit.opencord.org/plugins/gitiles/voltha-docs/+/refs/heads/master/VERSION>`_ file to prevent publishing.
+
+ - Specify a version string with a -dev suffix (2.11.55-dev)
+ - The ``*-dev`` suffix will inhibit publishing release notes to https://docs.voltha.org.
+ - Helpful but not required, avoid specifying the new release version until they are finalized.
+
+ - This will help retain a logical initial version string like
+ voltha-2.12.0 VS voltha-2.12.22 in case several edits are needed to
+ finalize documentation.
+
+- Copy the release notes template to create an empty release notes file:
+
+ - Source: `release_notes/template.rst <https://gerrit.opencord.org/plugins/gitiles/voltha-docs/+/refs/heads/master/release_notes>`__.
+ - Examine the last release notes file and transfer any relevant generic text into template.rst.
+ - % cp `release_notes/template.rst <https://gerrit.opencord.org/plugins/gitiles/voltha-docs/+/refs/heads/master/release_notes>`__ `release_notes/voltha_2.12.rst <https://gerrit.opencord.org/plugins/gitiles/voltha-docs/+/refs/heads/master/release_notes/voltha_2.11.rst>`_
+
+- Add `release_notes/voltha_2.12.rst <https://gerrit.opencord.org/plugins/gitiles/voltha-docs/+/refs/heads/master/release_notes/voltha_2.11.rst>`_ in the index file `release_notes/index.rst <https://gerrit.opencord.org/plugins/gitiles/voltha-docs/+/refs/heads/master/release_notes/index.rst>`_
+
+- Modify `config.py <https://gerrit.opencord.org/plugins/gitiles/voltha-docs/+/refs/heads/master/conf.py#308>`_ so ``make linkcheck`` will not fail on yet-to-be-generated html release notes file.
+
+- Release notes: content and hilights:
+
+ - Ask `VOLTHA TST(s) <https://opennetworking.org/voltha/>`_ to write up the release notes documentation.
+ - ONF will work on filling in the grid of dependent components and apps
+ at the bottom as they are built during a release cycle.
+
+- Pre-screen your patch for potential problems, ``make test`` failures will cause patch acceptance to fail.
+
+.. code-block:: bash
+
+ # pre-screen for checkin test problems
+ % make sterile
+ % make test
+
+ # Summarize make test
+ % make test-errors
+
+ # Optional
+ % make lint
+
+- Create a patch, request code reviews and merge.
+- Wait for the jenkins voltha-docs sync job to complete before continuing on.
+
+
+Cookbook: Patch #2
+------------------
+- Once release notes are ready to publish update the version string.
+- Modify `VERSION <https://gerrit.opencord.org/plugins/gitiles/voltha-docs/+/refs/heads/master/VERSION>`_ file.
+- Remove any vresion suffix decorations such as -dev.
+- Increment version string for the upcomign release:
+
+.. code-block:: bash
+
+ # For exmaple increment version string
+ 2.11.5-dev
+
+ # To the new release version: voltha-2.12
+ 2.12
+
+- After a code merge and jenkins job has run to generate documentation.
+- `https://docs.voltha.org <https://docs.voltha.org/master/index.html>`_ will contain the new release documentation if your version string appears in the top left navigation box on the site.
+
+
+Release independent changes
+---------------------------
+- Update `copyright notice dates <https://github.com/joey-onf/copyright/blob/origin/master/notice>`_
+
+ - VALID: Copyright 2017-2023 Open Networking Foundation (ONF) and the ONF Contributors
+ - Copyright notice must be inclusive of the date sources were last modified.
+ - Use of strings like 2017-present are not valid syntax and can have legal implications.
+
diff --git a/makefiles/targets/test-errors.mk b/makefiles/targets/test-errors.mk
index 548da7f..8b8a614 100644
--- a/makefiles/targets/test-errors.mk
+++ b/makefiles/targets/test-errors.mk
@@ -33,7 +33,7 @@
@echo "** Running $(MAKE) lint"
-$(HIDE) ( $(MAKE) lint 3>&1 2>&1 ) > $(test-errors-lint)
- @echo '** Screen log for errors: $(test-errors-lint)'
+ @echo '** Examining log for errors: $(test-errors-lint)'
$(HIDE)! grep \
-e 'make: ***' \
$(test-errors-lint)
@@ -42,10 +42,10 @@
@echo "** Running $(MAKE) linkcheck"
-$(HIDE) ( $(MAKE) linkcheck 3>&1 2>&1 ) > $(test-errors-link)
- @echo '** Screen log for errors: $(test-errors-link)'
+ @echo '** Examining log for errors: $(test-errors-link)'
$(HIDE)! grep \
-e 'make: ***' \
- -e 'broken' \
+ -e ') broken' \
$(test-errors-link)
## -----------------------------------------------------------------------
diff --git a/overview/releases.rst b/overview/releases.rst
index 31ac0b2..5970216 100644
--- a/overview/releases.rst
+++ b/overview/releases.rst
@@ -126,7 +126,7 @@
- December 30, 2022
-
-
- * - `VOLTHA 2.12-FIXME <../release_notes/voltha_2.11.html>`_
+ * - `VOLTHA 2.12 <../release_notes/voltha_2.12.html>`_
- December 30, 2022
- June 30, 2023
-
diff --git a/release_notes/template.rst b/release_notes/template.rst
new file mode 100644
index 0000000..cd114ae
--- /dev/null
+++ b/release_notes/template.rst
@@ -0,0 +1,123 @@
+.. figure:: images/voltha.svg
+ :alt: voltha- Release Notes
+ :width: 40%
+ :align: center
+
+
+VOLTHA 2.XX Release Notes
+=========================
+
+Highlights
+----------
+
+Features & Improvements
+-----------------------
+
+Bug Fixes
+---------
+
+Test
+----
+
+Documentation
+-------------
+
+As usual documentation is published on https://docs.voltha.org
+
+
+Known Issues
+------------
+.. list-table:: Known Issues
+ :widths: 10, 40
+ :header-rows: 1
+
+ * - Jira
+ - Description
+ * - Placeholder
+ - Placeholder
+
+Certification Program
+---------------------
+
+Thanks to the Continuous Certification program at ONF we can also ensure
+that the following ONF member products are compatible with the VOLTHA 2.xx
+release:
+
+- Edgecore ASGVolt64 GPON OLT
+- Radisys 3200G GPON OLT
+- Radisys 1600G GPON OLT
+- Zyxel SDA3016SS Combo OLT
+
+
+Jira stories
+------------
+A full list of stories and bugs completed can be found under the
+`VOLTHA 2.xx <https://jira.opencord.org/projects/VOL/versions/12600>`_ (`formatted <https://jira.opencord.org/secure/ReleaseNote.jspa?projectId=10106&version=12600>`_) release page in Jira.
+
+|
+
+Component Versions in VOLTHA 2.12 release
+-----------------------------------------
+
+Helm Chart Versions
++++++++++++++++++++
+This section refers to the macro charts to deploy the required infrastructure and a (or many) VOLTHA stacks:
+
+BAL Version
++++++++++++
+
+|
+
+Get Involved
+------------
+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:
+
+
+Index/Entry points
+++++++++++++++++++
+
+ - `https://docs.voltha.org <https://docs.voltha.org/master/index.html>`_
+ - `Getting Started <https://docs.voltha.org/master/overview/contributing.html>`_
+
+HOWTO
++++++
+
+ - `Code, Documentation, Makefiles <https://docs.voltha.org/master/howto/index.html>`_
+ - `Setup a test pod <https://docs.voltha.org/master/overview/lab_setup.html>`_
+ - `Troubleshooting <https://docs.voltha.org/master/overview/troubleshooting.html>`_
+
+Testing
++++++++
+
+ - `Automation <https://docs.voltha.org/master/testing/voltha_test_automation.html>`_
+ - `Robot testing harness <https://docs.voltha.org/master/testing/index.html>`_
+ - `voltha-system-tests <https://docs.voltha.org/master/voltha-system-tests/README.html>`_
+
+CLI Tools
++++++++++
+
+ - `BBSIM <https://docs.voltha.org/master/bbsim/docs/source/index.html>`__
+ - `voltctl <https://docs.voltha.org/master/voltctl/README.html?highlight=voltctl>`__
+
+Slack
++++++
+ - `voltha-dev <https://app.slack.com/client/T095Z193Q/C01D229FP2A>`_
+ - `community <https://app.slack.com/client/T095Z193Q/C0184DT7116>`_
+ - `general <https://app.slack.com/client/T095Z193Q/C095YQBLL>`_
+
+Mailing List
+++++++++++++
+ - `voltha-discuss@opennetworking.org <https://groups.google.com/a/opennetworking.org/g/voltha-discuss>`_.
+
+Weekly TST Meetings
++++++++++++++++++++
+- `Zoom Meeting <https://www.google.com/url?q=https://onf.zoom.us/j/978447356?pwd%3DdS9WajNLam9ZeFExOHV3SXB2Nk1VZz09&sa=D&source=calendar&ust=1686087684256971&usg=AOvVaw3dMQpIMYLlyjTTmkvW_edp>`_.
+- `Rolling Agenda <https://www.google.com/url?q=https://docs.google.com/document/d/1mNqronCip_-tDjFI-ZoudNteC3AnOcVONPHz7HuW8Eg/edit?usp%3Dsharing&sa=D&source=calendar&ust=1686087684256971&usg=AOvVaw3km2VVU2j1qa6JCGI0iSBx>`_.
+
+Website
+- `onf/VOLTHA <https://opennetworking.org/voltha/>`_
+- `docs.voltha.org <https://docs.voltha.org>`_
+
+|
diff --git a/release_notes/voltha_2.12.rst b/release_notes/voltha_2.12.rst
index 0d473f0..1657f18 100644
--- a/release_notes/voltha_2.12.rst
+++ b/release_notes/voltha_2.12.rst
@@ -116,4 +116,9 @@
- `Zoom Meeting <https://www.google.com/url?q=https://onf.zoom.us/j/978447356?pwd%3DdS9WajNLam9ZeFExOHV3SXB2Nk1VZz09&sa=D&source=calendar&ust=1686087684256971&usg=AOvVaw3dMQpIMYLlyjTTmkvW_edp>`_.
- `Rolling Agenda <https://www.google.com/url?q=https://docs.google.com/document/d/1mNqronCip_-tDjFI-ZoudNteC3AnOcVONPHz7HuW8Eg/edit?usp%3Dsharing&sa=D&source=calendar&ust=1686087684256971&usg=AOvVaw3km2VVU2j1qa6JCGI0iSBx>`_.
+Website
++++++++
+- `onf/VOLTHA <https://opennetworking.org/voltha/>`_
+- `docs.voltha.org <https://docs.voltha.org>`_
+
|