blob: 59b624704e56d7d2ea15ed0dfa35cca186f4fc11 [file] [log] [blame]
Joey Armstrongf6dde7a2024-02-01 10:09:20 -05001Misc Todo Items
2===============
3
4- Baseline build
5
6 - Update copyright notices :ref:`Release Task Copyright`
7
8- Pre-branch build
9 - make help
10 - make lint
11
12- Build
13
14 - make help
15 - make sterile
16 - make lint
17 - make build
18 - make test
19
20## Post editing on the release branch:
21
22- Update VERSION file to contain X.Y.{1+Z}
23- Update .gitreview, defaultbranch=votlha-X.Y
24
25- `bbsim-tests.groovy <https://gerrit.opencord.org/plugins/gitiles/ci-management/+/refs/heads/master/jjb/pipeline/voltha/bbsim-tests.groovy#35>`_
26
27.. code:: groovy
28
29 // -----------------------------------------------------------------------
30 // Intent: Return branch name for the script. A hardcoded value is used
31 // as a guarantee release jobs are running in an expected sandbox.
32 // -----------------------------------------------------------------------
33 String branchName()
34 {
35 String br = 'master' // <<----** Change to release branch
36
37 // "${branch}" is assigned by jenkins
38 if (br != branch)
39 {
40 String err = [
41 'ERROR: Detected invalid branch',
42 "(expected=[${br}] != found=[${branch}])"
43 ].join(' ')
44 throw new Exception(err) // groovylint-disable-line ThrowException
45 }
46 return (br)
47 }
48
49## TODO
50
51- Tools bbsim and voltctl are versioned for release.
52- Track down which test scripts contain hardcoded versions for checkout.
53
54 - Command use is all over the place and not all are being frozen.
55 - Abstract this into makefile targets (~voltctl) or a central script
56 that simply returns version string for a package. A standalone entity
57 will simplify maintenance and can be generated/autoamtically frozen
58 on a branch at release time.
59
60- Consider tool versioning in general. Planning for tool upgrades helps
61 minimize unplanned breakage.
62