[VOL-5016] - Build and deploy VOLTHA dep ONOS:sadis
howto/release/checklist.rst
howto/release/ci-management/clone_testing.rst
howto/release/components/onos_components.rst
howto/release/components/sadis
howto/release/voltha-docs/create_lts_view.rst
---------------------------------------------
o Update component dep build docs from the latest attempt to build
o and publish sadis v5.11.0 out into Maven Central.
Change-Id: I16a8855e01560dbadc60cd43a851306b1685e01e
diff --git a/howto/release/checklist.rst b/howto/release/checklist.rst
new file mode 100644
index 0000000..1ad638a
--- /dev/null
+++ b/howto/release/checklist.rst
@@ -0,0 +1,42 @@
+Release: Checklist
+==================
+
+docs.voltha.org (repo: voltha-docs)
+-----------------------------------
+
+- Create release notes
+- Review core contributors
+
+VOLTHA Repositories
+-------------------
+
+- Create release branch voltha-X.YY in each repository.
+- Update .gitreview, assign `defaultbranch=voltha-2.12 <https://gerrit.opencord.org/c/pod-configs/+/33941/2/.gitreview>`_.
+
+Release Builds
+--------------
+
+- components/onos_components
+- Build and record version for all external VOLTHA dependencies.
+- `VOL-4925 <https://jira.opencord.org/browse/VOL-4925>`_.
+- Upgrade Maven Plugins listed in pom.xml
+
+Packages
+--------
+- Package `aaa <https://gerrit.opencord.org/c/aaa/+/33599>`_
+ - Versions
+ - New
+ - Old
+ - DEPS: sadis
+
+- Package `sadis <https://gerrit.opencord.org/plugins/gitiles/sadis/>`_
+ - Versions
+ - `New: 5.11.0-SNAPSHOT <https://gerrit.opencord.org/plugins/gitiles/sadis/+/refs/heads/master/pom.xml#30>`_
+ - `Old: (5.10.0) <https://central.sonatype.com/artifact/org.opencord/sadis/5.10.0?smo=true>`_
+ - DEPS:
+
+
+Release Notes
+-------------
+
+- Capture version information and packages for all builds.
diff --git a/howto/release/ci-management/clone_testing.rst b/howto/release/ci-management/clone_testing.rst
new file mode 100644
index 0000000..74e9a86
--- /dev/null
+++ b/howto/release/ci-management/clone_testing.rst
@@ -0,0 +1,24 @@
+Jenkins jobs: Unit testing
+==========================
+
+Intent
+------
+
+With each new VOLTHA LTS release (v2.11, v2.8) jenkins unit testing and
+sandbox tooling must be branched for release to protect testing from
+future enhancements on master branch.
+
+JJB configs are maintained in a central repository and are not maintained
+on a seprate branch within revision control. Instead versioning is
+implemented using naming conventions within the job configs.
+
+WIP:
+----
+- Clone the ci-management repository
+
+ - git clone ssh://gerrit.opencord.org:29418/ci-management.git
+
+
+TODO
+----
+- Document the current testing setup.
diff --git a/howto/release/components/onos_components.rst b/howto/release/components/onos_components.rst
index 19775a6..cc2af3c 100644
--- a/howto/release/components/onos_components.rst
+++ b/howto/release/components/onos_components.rst
@@ -12,14 +12,51 @@
- `Jenkins Release Job <https://jenkins.opencord.org/job/onos-app-release/>`_
+ - `MVN Plugin Upgrade <https://gerrit.opencord.org/c/sadis/+/34230>`_
+ - `5.11.0 (deploy) <https://gerrit.opencord.org/c/sadis/+/34231>`_
+ - `5.12.0-SNAPSHOT (dev) <https://gerrit.opencord.org/c/sadis/+/34232>`_
+
- Initiate a build with parameters for the target component.
- Use repository name not name of the app itself.
- Specify appVersion and apiVersion stored in the pom.xml file.
- - Job will modify pom.xml and create pull requests based on version strings.
+ - Files modified by jenkins: pom.xml, app/pom.xml, api/pom.xml
+
+.. list-table:: Job paramters
+ :widths: 10, 40
+ :header-rows: 1
+
+ * - Field
+ - Value
+ * - appRepo
+ - sadis
+ * - appName
+ - sadis
+ * - apiVersion
+ - 5.11.0 (pom.xml: 5.11.0-SNAPSHOT)
+ * - nextApiVersion
+ - 5.12.0
+ * - version
+ - 5.11.0
+ * - nextVersion
+ - 5.12.0
+ * - branch
+ - master (?)
+
+
+ - Jenkins jobs from `release matrix: v2.12 <https://wiki.opennetworking.org/display/VOLTHA/v2.12+-+Jenkins+jobs+and+failures>`_
+ - `changeset approval for job merge<https://gerrit.opencord.org/q/owner:do-not-reply%2540opennetworking.org>`_
+ - pom.xml non-SNAPSHOT (first approved changeset)
+ - `licensed <https://jenkins.opencord.org/job/verify_sadis_licensed/>`_
+ - `verify <https://jenkins.opencord.org/job/verify_sadis_maven-test/>`_
+ - pom.xml non-SNAPSHOT (second approved changeset)
+ - `publish <https://jenkins.opencord.org/job/maven-publish_sadis/>`_
+
+ - Job will modify pom.xml and create pull requests based on version strings.
- NOTE: Two pull requests are created to modify pom.xml
+
- One for release (x.y.z)
- The second to revert to non-release version (x.(y+1).z-SNAPSHOT)
- Approve and merge the release version while performing the release.
@@ -34,14 +71,21 @@
- Wait for build to complete
- Merge the patches here https://gerrit.opencord.org/q/owner:do-not-reply%2540opennetworking.org
-- Publish sonatype staging to maven central:
+- Artifact staging on sonatype, published to maven central:
- Visit `https://oss.sonatype.org <https://oss.sonatype.org>`_
- Login with ONF credentials
- - Search for org.opencord
+ - In the Artifact Search box
+
+ - Search for org.opencord
+ - Find the package of interest (pkg, app, api)
+ - Click 'Show All Versions'
+ - Verify the released version exists
+
- Click on "Staging repositories" (in the left side navigation)
- In the top right search for last part of the app name (eg: olt)
+ - Enable checkbox for the versioned package (status: closed).
- Click release (top left bar, small button)
- `Wait until artifacts are published <https://search.maven.org/search?q=g:org.opencord>`_
diff --git a/howto/release/components/sadis b/howto/release/components/sadis
new file mode 100644
index 0000000..a916270
--- /dev/null
+++ b/howto/release/components/sadis
@@ -0,0 +1,13 @@
+package: aaa
+ dep: sadis
+
+package: sadis
+
+
+Inventory pom.xml
+Update MVN Plugin versions in use.
+For Relase remove -SNAPSHOT and build.
+
+# Document component dependency page
+
+https://wiki.opennetworking.org/display/VOLTHA/component-sadis
diff --git a/howto/release/voltha-docs/create_lts_view.rst b/howto/release/voltha-docs/create_lts_view.rst
index 0eedd5e..f7b3cce 100644
--- a/howto/release/voltha-docs/create_lts_view.rst
+++ b/howto/release/voltha-docs/create_lts_view.rst
@@ -35,7 +35,7 @@
- Name view for the current release VOLTHA-XXX
- Select type "List View"
- Accept basic values to begin configuring
-- Add an appropraite job Description.
+- Add an appropriate job Description.
- Scroll down to "Job Filters"
- Selelect individual jobs
@@ -54,11 +54,21 @@
- Add view name: VOLTHA-2.11
- Select "Include a global view"
- Click the "create" button
-- Type in an appropraite Description.
+- Type in an appropriate Description.
- View name should contain the global view name VOLTHA-2.11
- Click "Apply"
- Click "OK"
+Create job folder voltha-2.12 on the dashboard (not a view)
+-----------------------------------------------------------
+
+- Visit `jenkins::Dashboard <https://jenkins.opencord.org>`_
+- Click "New View" in the left margin.
+- Copy entry 'voltha-master'
+- New name: voltha-2.12
+- Click the "create" button
+- Dashboard Folder `voltha-2.12 <https://jenkins.opencord.org/job/voltha-2.12/>`_
+
Access LTS jobs
---------------
- Visit the `VOLTHA-LTS job folder <https://jenkins.opencord.org/job/VOLTHA-LTS/>`__