Joey Armstrong | bd6cc3d | 2023-01-09 19:52:12 -0500 | [diff] [blame] | 1 | VOLTHA Components: ONOS Dependencies |
| 2 | ==================================== |
| 3 | |
| 4 | ONOS components are maintained by a series of maven projects. |
| 5 | Releasing 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 | |
| 23 | First submit nop jobs to verify the packages can build and test cleanly. |
| 24 | Bulk update copyright notice dates or modify comments within sources and submit. |
| 25 | |
| 26 | Search pom.xml for package version string |
| 27 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 28 | |
| 29 | component sadis |
| 30 | |
| 31 | Package 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> |
Joey Armstrong | 399f276 | 2023-01-11 11:41:28 -0500 | [diff] [blame] | 42 | <version>5.10.0-SNAPSHOT</version> |
Joey Armstrong | bd6cc3d | 2023-01-09 19:52:12 -0500 | [diff] [blame] | 43 | <packaging>pom</packaging> |
| 44 | |
| 45 | <properties> |
Joey Armstrong | 399f276 | 2023-01-11 11:41:28 -0500 | [diff] [blame] | 46 | <sadis.api.version>5.10.0-SNAPSHOT</sadis.api.version> |
Joey Armstrong | bd6cc3d | 2023-01-09 19:52:12 -0500 | [diff] [blame] | 47 | </properties> |
| 48 | |
| 49 | |
| 50 | Next search pom.xml for dependent packages |
| 51 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 52 | |
| 53 | component: aaa |
| 54 | |
| 55 | Dependent package version strings will be a released (non-SNAPSHOT) version. |
| 56 | |
| 57 | .. code:: XML |
| 58 | |
| 59 | <properties> |
Joey Armstrong | 399f276 | 2023-01-11 11:41:28 -0500 | [diff] [blame] | 60 | <sadis.api.version>5.10.0</sadis.api.version> |
Joey Armstrong | bd6cc3d | 2023-01-09 19:52:12 -0500 | [diff] [blame] | 61 | <aaa.api.version>2.8.0-SNAPSHOT</aaa.api.version> |
| 62 | </properties> |
| 63 | |
| 64 | |
| 65 | Dependency Hierarchy |
| 66 | -------------------- |
| 67 | |
| 68 | Components are built and released in version hiearchy order. |
| 69 | |
| 70 | sadis |
| 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 | |
Joey Armstrong | 399f276 | 2023-01-11 11:41:28 -0500 | [diff] [blame] | 79 | <sadis.api.version>5.10.0-SNAPSHOT</sadis.api.version> |
Joey Armstrong | bd6cc3d | 2023-01-09 19:52:12 -0500 | [diff] [blame] | 80 | |
| 81 | |
| 82 | aaa |
| 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 | |
Joey Armstrong | 399f276 | 2023-01-11 11:41:28 -0500 | [diff] [blame] | 91 | <sadis.api.version>5.10.0</sadis.api.version> |
Joey Armstrong | bd6cc3d | 2023-01-09 19:52:12 -0500 | [diff] [blame] | 92 | |
| 93 | |
Joey Armstrong | 399f276 | 2023-01-11 11:41:28 -0500 | [diff] [blame] | 94 | dhcpl2relay |
| 95 | ^^^^^^^^^^^ |
| 96 | |
| 97 | - Verify -SNAPSHOT version string is present. |
| 98 | - Dependent components: sadis |
| 99 | - Modify pom.xml, update released version strings |
| 100 | |
| 101 | .. code:: XML |
| 102 | |
| 103 | <sadis.api.version>5.10.0</sadis.api.version> |
| 104 | |
Joey Armstrong | bd6cc3d | 2023-01-09 19:52:12 -0500 | [diff] [blame] | 105 | igmpproxy |
| 106 | ^^^^^^^^^ |
| 107 | |
| 108 | - Verify -SNAPSHOT version string is present. |
Joey Armstrong | 399f276 | 2023-01-11 11:41:28 -0500 | [diff] [blame] | 109 | - Dependent components: sadis |
Joey Armstrong | bd6cc3d | 2023-01-09 19:52:12 -0500 | [diff] [blame] | 110 | - Modify pom.xml, update released version strings |
| 111 | |
| 112 | .. code:: XML |
| 113 | |
Joey Armstrong | 399f276 | 2023-01-11 11:41:28 -0500 | [diff] [blame] | 114 | <sadis.api.version>5.10.0</sadis.api.version> |
| 115 | |
| 116 | kafka |
| 117 | ^^^^^ |
| 118 | |
| 119 | - Verify -SNAPSHOT version string is present. |
| 120 | - Dependent components: aaa, bng, dhcpl2relay, igmp, mcast, olt, sadis |
| 121 | - Modify pom.xml, update released version strings |
| 122 | |
| 123 | .. code:: XML |
| 124 | |
| 125 | <aaa.api.version>x.x.x</aaa.api.version> |
| 126 | <bng.api.version>x.x.x</bng.api.version> |
| 127 | <dhcpl2relay.api.version>x.x.x</dhcpl2relay.api.version> |
| 128 | <igmp.api.version>x.x.x</igmp.api.version> |
| 129 | <mcast.api.version>x.x.x</mcast.api.version> |
| 130 | <olt.api.version>x.x.x</olt.api.version> |
| 131 | <sadis.api.version>5.10.0</sadis.api.version> |
| 132 | |
| 133 | mcast |
| 134 | ^^^^^ |
| 135 | |
| 136 | - Verify -SNAPSHOT version string is present. |
| 137 | - Dependent components: sadis |
| 138 | - Modify pom.xml, update released version strings |
| 139 | |
| 140 | .. code:: XML |
| 141 | |
| 142 | <sadis.api.version>5.10.0</sadis.api.version> |
| 143 | |
| 144 | olt |
| 145 | ^^^ |
| 146 | |
| 147 | - Verify -SNAPSHOT version string is present. |
| 148 | - Dependent components: sadis |
| 149 | - Modify pom.xml, update released version strings |
| 150 | |
| 151 | .. code:: XML |
| 152 | |
| 153 | <sadis.api.version>5.10.0</sadis.api.version> |
Joey Armstrong | 56334fc | 2023-01-15 22:53:19 -0500 | [diff] [blame] | 154 | |
| 155 | maclearner |
| 156 | ^^^^^^^^^^ |
| 157 | |
| 158 | pppoeagent |
| 159 | ^^^^^^^^^^ |
| 160 | |
| 161 | segmentrouting |
| 162 | ^^^^^^^^^^^^^^ |