blob: bf4fb82c55b637829923b10e2aedfafebee93217 [file] [log] [blame]
Joey Armstrongc9614ce2023-01-25 16:21:27 -05001VOLTHA Components: ONOS
2=======================
3
4A few different processes exist for releasing the VOLTHA project and componets.
5Some are released through github using branches/tags/downloads.
6Others are released as packages on maven central.
7
8A jenkins job exists for releasing ONOS app
9
10- Maven central based release
11- Release process requires some manual steps.
12
13- `Jenkins Release Job <https://jenkins.opencord.org/job/onos-app-release/>`_
14
Joey Armstrong9a771062023-06-03 23:57:43 -040015 - `MVN Plugin Upgrade <https://gerrit.opencord.org/c/sadis/+/34230>`_
16 - `5.11.0 (deploy) <https://gerrit.opencord.org/c/sadis/+/34231>`_
17 - `5.12.0-SNAPSHOT (dev) <https://gerrit.opencord.org/c/sadis/+/34232>`_
18
Joey Armstrongc9614ce2023-01-25 16:21:27 -050019 - Initiate a build with parameters for the target component.
20
21 - Use repository name not name of the app itself.
22 - Specify appVersion and apiVersion stored in the pom.xml file.
23
Joey Armstrong9a771062023-06-03 23:57:43 -040024 - Files modified by jenkins: pom.xml, app/pom.xml, api/pom.xml
25
26.. list-table:: Job paramters
27 :widths: 10, 40
28 :header-rows: 1
29
30 * - Field
31 - Value
32 * - appRepo
33 - sadis
34 * - appName
35 - sadis
36 * - apiVersion
37 - 5.11.0 (pom.xml: 5.11.0-SNAPSHOT)
38 * - nextApiVersion
39 - 5.12.0
40 * - version
41 - 5.11.0
42 * - nextVersion
43 - 5.12.0
44 * - branch
45 - master (?)
46
47
Joey Armstrong4f93b762023-06-06 08:36:02 -040048Jenkins Jobs
49^^^^^^^^^^^^
50
51- Jenkins jobs from `release matrix: v2.12 <https://wiki.opennetworking.org/display/VOLTHA/v2.12+-+Jenkins+jobs+and+failures>`_
52
53 - `changeset approval for job merge <https://gerrit.opencord.org/q/owner:do-not-reply%2540opennetworking.org>`_
Joey Armstrong9a771062023-06-03 23:57:43 -040054 - pom.xml non-SNAPSHOT (first approved changeset)
Joey Armstrong4f93b762023-06-06 08:36:02 -040055
Joey Armstrong9a771062023-06-03 23:57:43 -040056 - `licensed <https://jenkins.opencord.org/job/verify_sadis_licensed/>`_
57 - `verify <https://jenkins.opencord.org/job/verify_sadis_maven-test/>`_
Joey Armstrong4f93b762023-06-06 08:36:02 -040058
Joey Armstrong9a771062023-06-03 23:57:43 -040059 - pom.xml non-SNAPSHOT (second approved changeset)
Joey Armstrong4f93b762023-06-06 08:36:02 -040060
Joey Armstrong9a771062023-06-03 23:57:43 -040061 - `publish <https://jenkins.opencord.org/job/maven-publish_sadis/>`_
62
63 - Job will modify pom.xml and create pull requests based on version strings.
Joey Armstrongc9614ce2023-01-25 16:21:27 -050064
65 - NOTE: Two pull requests are created to modify pom.xml
Joey Armstrong9a771062023-06-03 23:57:43 -040066
Joey Armstrongc9614ce2023-01-25 16:21:27 -050067 - One for release (x.y.z)
68 - The second to revert to non-release version (x.(y+1).z-SNAPSHOT)
69 - Approve and merge the release version while performing the release.
70 - Once published approve the 2nd version change to re-attach the -SNAPSHOT suffix.
71
72 - Version x.y.z-SNAPSHOT is the default non-release version.
73 - Jenkins job will morph x.y.z-SNAPSHOT into x.y.z for the release.
74 - A gerrit pull request will be created under the release requestor(s) name.
75
76 - Approve the pom.xml pull request and merge.
77 - Merge will trigger (https://jenkins.opencord.org/job/maven-publish_sadis/ for sadis app, similar link for olt and other apps) that publish the artifact in the staging repo on oss.sonatype.org, you need to release it.
78 - Wait for build to complete
79 - Merge the patches here https://gerrit.opencord.org/q/owner:do-not-reply%2540opennetworking.org
80
Joey Armstrong9a771062023-06-03 23:57:43 -040081- Artifact staging on sonatype, published to maven central:
Joey Armstrongc9614ce2023-01-25 16:21:27 -050082
83 - Visit `https://oss.sonatype.org <https://oss.sonatype.org>`_
84 - Login with ONF credentials
85
Joey Armstrong9a771062023-06-03 23:57:43 -040086 - In the Artifact Search box
87
88 - Search for org.opencord
89 - Find the package of interest (pkg, app, api)
90 - Click 'Show All Versions'
91 - Verify the released version exists
92
Joey Armstrongc9614ce2023-01-25 16:21:27 -050093 - Click on "Staging repositories" (in the left side navigation)
94 - In the top right search for last part of the app name (eg: olt)
Joey Armstrong9a771062023-06-03 23:57:43 -040095 - Enable checkbox for the versioned package (status: closed).
Joey Armstrongc9614ce2023-01-25 16:21:27 -050096 - Click release (top left bar, small button)
97 - `Wait until artifacts are published <https://search.maven.org/search?q=g:org.opencord>`_
98
99- Release all other apps/components (dependency hierarch):
100
101 - Iterate over individual components in order of increasing dependency volume.
102
103 - For ex olt depends on sadis
104 - Begin by releasing sadis first
105 - Once publishing has completed then olt can be released.
106
107 - Verify expected dependent version has been released.
108 - Modify pom.xml, update dep version(s) from x.z.y-SNAPSHOT to x.y.z
109 - Commit and submit.
110