blob: 66cd0456de230195e8960447040d83b49dd8da4c [file] [log] [blame]
Joey Armstrong9a771062023-06-03 23:57:43 -04001Release: Checklist
2==================
3
4docs.voltha.org (repo: voltha-docs)
5-----------------------------------
6
7- Create release notes
8- Review core contributors
9
10VOLTHA Repositories
11-------------------
12
13- Create release branch voltha-X.YY in each repository.
14- Update .gitreview, assign `defaultbranch=voltha-2.12 <https://gerrit.opencord.org/c/pod-configs/+/33941/2/.gitreview>`_.
15
16Release Builds
17--------------
18
19- components/onos_components
20- Build and record version for all external VOLTHA dependencies.
21- `VOL-4925 <https://jira.opencord.org/browse/VOL-4925>`_.
22- Upgrade Maven Plugins listed in pom.xml
23
24Packages
25--------
Joey Armstrong4f93b762023-06-06 08:36:02 -040026
Joey Armstrong9a771062023-06-03 23:57:43 -040027- Package `aaa <https://gerrit.opencord.org/c/aaa/+/33599>`_
Joey Armstrong4f93b762023-06-06 08:36:02 -040028
Joey Armstrong9a771062023-06-03 23:57:43 -040029 - Versions
Joey Armstrong4f93b762023-06-06 08:36:02 -040030
Joey Armstrong83135fb2023-06-04 00:48:14 -040031 - New 2.10.3
32 - Old 2.9.0
Joey Armstrong4f93b762023-06-06 08:36:02 -040033
Joey Armstrong9a771062023-06-03 23:57:43 -040034 - DEPS: sadis
35
36- Package `sadis <https://gerrit.opencord.org/plugins/gitiles/sadis/>`_
Joey Armstrong4f93b762023-06-06 08:36:02 -040037
Joey Armstrong9a771062023-06-03 23:57:43 -040038 - Versions
Joey Armstrong4f93b762023-06-06 08:36:02 -040039
Joey Armstrong83135fb2023-06-04 00:48:14 -040040 - `New: 5.11.1-SNAPSHOT <https://gerrit.opencord.org/plugins/gitiles/sadis/+/refs/heads/master/pom.xml#30>`_
Joey Armstrong9a771062023-06-03 23:57:43 -040041 - `Old: (5.10.0) <https://central.sonatype.com/artifact/org.opencord/sadis/5.10.0?smo=true>`_
Joey Armstrong4f93b762023-06-06 08:36:02 -040042
Joey Armstrong83135fb2023-06-04 00:48:14 -040043 - VCS
44
45 - `gerrit <https://gerrit.opencord.org/plugins/gitiles/sadis/+/refs/tags/5.11.0>`_
46 - `github <https://github.com/opencord/sadis/tree/5.10.0>`_
47
Joey Armstrong9a771062023-06-03 23:57:43 -040048 - DEPS:
Joey Armstrong4f93b762023-06-06 08:36:02 -040049
Joey Armstrong9a771062023-06-03 23:57:43 -040050Release Notes
51-------------
52
53- Capture version information and packages for all builds.
Joey Armstrong83135fb2023-06-04 00:48:14 -040054
55Helm Charts
56-----------
57
58Once dependent packages are built update helm charts: charts/index
Joey Armstrongb1498d72023-06-13 10:46:57 -040059
60Voltha with golang source
61-------------------------
62
63Review all repositories that contain golang sources.
64Version(s) of external packages in the vendor/ directory may need to be updated.
65
66.. code-block: shell-session
67 :linenos:
68 :hilight: 2, 4
69
70 # Clone repo:voltha-go
71 git clone ssh://gerrit.opencord.org:29418/voltha-go.git
72
73 cd voltha-go
74 make help
75
76.. list-table:: make targets
77 :header-rows: 1
78 :widths: 20,50
79
80 * - Command
81 - Description
82 * - make lint
83 - syntax check sources
84 * - make lint-dockerfile
85 - syntax check docker config
86 * - make lint-mod
87 - syntax check golang dependencies
88
89.. list-table:: build & test targets
90 :header-rows: 1
91 :widths: 20,50
92
93 * - Command
94 - Description
95 * - make build
96 - Build core docker image
97 * - make test
98 - Requires docker, test local build
99 * - make sca
100 - Generate a static code analysis report
101
102.. list-table:: Developer targets
103 :header-rows: 1
104 :widths: 20,50
105
106 * - Command
107 - Description
108 * - make local-lib-go
109 - Create a local version of voltha-lib-go beneath vendor/
110 * - make local-protos
111 - Create a local version of voltha-protos beneath vendor/
112 * - make fmt
113 - Run gofmt on sources
114 * - make mod-update
115 - Update go mod files