blob: 2b005a6bc90b07c1b09e9fdd180640780d693df8 [file] [log] [blame]
Joey Armstrongbd6cc3d2023-01-09 19:52:12 -05001VOLTHA Components: ONOS Dependencies
2====================================
3
4ONOS components are maintained by a series of maven projects.
5Releasing individual components will require:
6
7- Build and release dependencies:
8
9 - Three jenkins jobs
10
11 - modify version in pom.xml for release (remove -SNAPSHOT)
12 - publish artifact to maven central.
13 - modify version in pom.xml for release (append -SNAPSHOT)
14
15 - Three manual operations:
16
17 - Review and approve pull request to create a pom.xml release version.
18 - Release artifact to maven central.
19 - Review and approve pull request to create a pom.xml non-release version.
20
21 - Long idle window(s)
22
23First submit nop jobs to verify the packages can build and test cleanly.
24Bulk update copyright notice dates or modify comments within sources and submit.
25
26Search pom.xml for package version string
27^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
28
29component sadis
30
31Package version strings should contain the suffix -SNAPSHOT.
32
33.. code:: bash
34
35 aaa/pom.xml
36 aaa/api/pom.xml
37 aaa/app/pom.xml
38
39.. code:: XML
40
41 <artifactId>sadis</artifactId>
42 <version>5.9.0-SNAPSHOT</version>
43 <packaging>pom</packaging>
44
45 <properties>
46 <sadis.api.version>5.9.0-SNAPSHOT</sadis.api.version>
47 </properties>
48
49
50Next search pom.xml for dependent packages
51^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
52
53component: aaa
54
55Dependent package version strings will be a released (non-SNAPSHOT) version.
56
57.. code:: XML
58
59 <properties>
60 <sadis.api.version>5.9.0</sadis.api.version>
61 <aaa.api.version>2.8.0-SNAPSHOT</aaa.api.version>
62 </properties>
63
64
65Dependency Hierarchy
66--------------------
67
68Components are built and released in version hiearchy order.
69
70sadis
71^^^^^
72
73- Verify -SNAPSHOT version string is present.
74- Dependent components: none
75- Scan pom.xml for version dependencies:
76
77.. code:: XML
78
79 <sadis.api.version>5.9.0-SNAPSHOT</sadis.api.version>
80
81
82aaa
83^^^
84
85- Verify -SNAPSHOT version string is present.
86- Dependent components: sadis
87- Modify pom.xml, update released version strings
88
89.. code:: XML
90
91 <sadis.api.version>5.9.0</sadis.api.version>
92
93
94igmpproxy
95^^^^^^^^^
96
97- Verify -SNAPSHOT version string is present.
98- Dependent components: aaa, bng, dhcpl2relay igmp, mcast, olt, sadis
99- Modify pom.xml, update released version strings
100
101.. code:: XML
102
103 <sadis.api.version>5.9.0</sadis.api.version>