Project

General

Profile

How to tag and build a LArSoft patch release » History » Version 27

Lynn Garren, 07/01/2019 02:11 PM

1 1 Lynn Garren
h1. How to tag and build a LArSoft patch release
2 1 Lynn Garren
3 3 Lynn Garren
{{>TOC}}
4 3 Lynn Garren
5 10 Lynn Garren
[[Policy for development from a tagged release]]
6 1 Lynn Garren
Experiments will build patch releases themselves with help from the LArSoft release manager.
7 2 Lynn Garren
There will be a very limited set of people with privileges to do this.  
8 7 Lynn Garren
We ask that the experiment release managers to whom these privileges have been granted do not grant privileges to anyone else.  Instead request permissions from LArSoft.
9 6 Lynn Garren
Permissions will be removed when someone ceases to have this responsibility.
10 2 Lynn Garren
11 10 Lynn Garren
* Permissions include:
12 10 Lynn Garren
** larsoft redmine manager role
13 10 Lynn Garren
** ability to login to larsoft cvmfs
14 10 Lynn Garren
** ability to upload to SciSoft with the larsoft role
15 12 Lynn Garren
** developer status for larreltools
16 22 Lynn Garren
** abiltiy to run Jenkins jobs
17 10 Lynn Garren
18 13 Lynn Garren
[[LArSoft responsiblities for patch releases]]
19 13 Lynn Garren
20 11 Lynn Garren
h2(count). Request a release
21 11 Lynn Garren
22 11 Lynn Garren
* Before starting any patch release, fill out a redmine issue requesting the release with all pertinent information.
23 10 Lynn Garren
24 10 Lynn Garren
25 2 Lynn Garren
h2(count). Tools
26 2 Lynn Garren
27 2 Lynn Garren
* Scripts used to build the patch release will be found in the larreltools product.  
28 19 Lynn Garren
* *larreltools* is not part of the standard distribution, but will be available from SciSoft and in cvmfs.
29 16 Lynn Garren
** Always use the latest release, which will be declared current.
30 20 Lynn Garren
** More [[larreltools:|information]]
31 4 Lynn Garren
32 2 Lynn Garren
h2(count). Initial setup
33 1 Lynn Garren
34 15 Lynn Garren
*This step is done once for any patch release set and will be done by the LArSoft release manager.*
35 9 Lynn Garren
36 4 Lynn Garren
h2(count). Making a patch release
37 2 Lynn Garren
38 2 Lynn Garren
* These notes presume that you do not have an existing directory
39 2 Lynn Garren
40 24 Lynn Garren
h3(count). Setup the working area
41 2 Lynn Garren
42 1 Lynn Garren
* setup the latest release of larreltools
43 24 Lynn Garren
* startPatchRel <working_dir> <experiment> <new patch tag> <larsoft branch> [<experiment branch>]
44 24 Lynn Garren
** Recognized experiment names are argoneut, dune, lariat, icarus, sbnd, and uboone.
45 2 Lynn Garren
** This script will create a directory named "tag" under the "working_dir".
46 24 Lynn Garren
** This script will clone the larsoft and larsoftobj suites using the named branch.
47 24 Lynn Garren
** The same branch name will be used when cloning the experiment code unless a second branch name is supplied.
48 2 Lynn Garren
** The directory structure will include a single source code directory with subdirectories for e17 and c2 debug and prof builds.
49 24 Lynn Garren
** Use "dogit branch" to double check that you are on the expected branch of all packages.
50 2 Lynn Garren
51 4 Lynn Garren
h3(count). Local development
52 2 Lynn Garren
53 2 Lynn Garren
* Before integrating any feature branches, make sure that the release builds as is and that the unit tests work.
54 2 Lynn Garren
** Make sure to build and test both e17 and c2.   Usually the prof build is sufficient for testing.  prof is preferred over debug, which sometimes masks problems.
55 2 Lynn Garren
<pre>
56 2 Lynn Garren
source local*/setup
57 2 Lynn Garren
cd $MRB_BUILDDIR
58 2 Lynn Garren
mrb t -jN
59 2 Lynn Garren
</pre>
60 2 Lynn Garren
* Next make changes and integrate feature branches
61 2 Lynn Garren
** Because feature branches may conflict or not have been thoroughly tested, we recommend merging one feature branch set at a time.  Build and test after each set.
62 2 Lynn Garren
63 4 Lynn Garren
h3(count). Update the package versions
64 2 Lynn Garren
65 2 Lynn Garren
* Do this once all changes have been made.
66 25 Lynn Garren
67 25 Lynn Garren
* Use the *updatePatchVersion* script from larreltools.
68 25 Lynn Garren
** This script takes no arguments.
69 25 Lynn Garren
** This script will call "mrb uv" to update each patch release by one.
70 25 Lynn Garren
** If there was no previous patch release, the version will be vaa_bb_cc_01
71 25 Lynn Garren
72 2 Lynn Garren
* ONLY update the version if there is a change.
73 2 Lynn Garren
* cd to each directory separately
74 2 Lynn Garren
* git diff LARSOFT_SUITE_vaa_bb_cc[_dd]
75 2 Lynn Garren
** You are comparing against the previous patch release in this set.
76 1 Lynn Garren
** If this is the first patch release in the set, compare against the original release.
77 25 Lynn Garren
** Sometimes the only change is an updated dependency.
78 25 Lynn Garren
** If there are no changes, use mrb uv to restore the previous release version and then move this package out of the way.
79 1 Lynn Garren
<pre>
80 1 Lynn Garren
cd $MRB_SOURCE
81 1 Lynn Garren
mkdir ../notag
82 16 Lynn Garren
mv xxx ../notag
83 17 Lynn Garren
mrb uc
84 16 Lynn Garren
</pre>
85 16 Lynn Garren
** Move all experiment code out of the way.  (_mv ub* ../notag/_ for MicroBooNE)
86 1 Lynn Garren
87 26 Lynn Garren
* As of mrb v3_02_01, the "mrb uv" command will update larsoftobj/bundle/CMakeLists.txt, larsoft/releaseDB/CMakeLists, and <my experiment>/releaseDB/CMakeLists.txt as well as ups/product_deps.
88 25 Lynn Garren
** commit changes in the releaseDB or bundle subdirectoies, but do not commit changes in ups/product_deps.
89 25 Lynn Garren
* DO NOT commit the changes to ups/product_deps.  tagPatchRel will commit ups/product_deps.
90 2 Lynn Garren
91 27 Lynn Garren
h3(count).  Dependency order
92 2 Lynn Garren
93 27 Lynn Garren
* Within the larsoftobj suite
94 27 Lynn Garren
** larcoreobj
95 27 Lynn Garren
** larcorealg
96 27 Lynn Garren
** lardataobj
97 27 Lynn Garren
** lardataalg
98 27 Lynn Garren
** larsoftobj
99 27 Lynn Garren
100 27 Lynn Garren
* All larsoft packages
101 27 Lynn Garren
** larcoreobj
102 27 Lynn Garren
** larcorealg
103 27 Lynn Garren
** larcore
104 27 Lynn Garren
** lardataobj
105 27 Lynn Garren
** lardataalg
106 27 Lynn Garren
** larsoftobj
107 27 Lynn Garren
** lardata
108 27 Lynn Garren
** larevt
109 27 Lynn Garren
** larwirecell
110 27 Lynn Garren
** larg4
111 27 Lynn Garren
** larsim
112 27 Lynn Garren
** larreco
113 27 Lynn Garren
** larana
114 27 Lynn Garren
** larpandora
115 27 Lynn Garren
** lareventdisplay
116 27 Lynn Garren
** larexamples
117 27 Lynn Garren
** larsoft
118 27 Lynn Garren
119 27 Lynn Garren
120 27 Lynn Garren
121 27 Lynn Garren
122 27 Lynn Garren
123 4 Lynn Garren
h3(count).  Tagging the release
124 2 Lynn Garren
125 2 Lynn Garren
* Do a final build and test with just the packages you expect to tag.  
126 25 Lynn Garren
** This step will also create the necessary build config files.
127 2 Lynn Garren
** If there are changes in both larsoft and larsoftobj, double check for consistency.
128 2 Lynn Garren
<pre>
129 1 Lynn Garren
cd $MRB_BUILDDIR/larsoft
130 2 Lynn Garren
diff releaseDB ../larsoftobj/bundle | grep diff
131 2 Lynn Garren
diff releaseDB ../larsoftobj/bundle | grep Only
132 2 Lynn Garren
</pre>
133 2 Lynn Garren
** If all is good, copy the cfg scripts to SciSoft
134 2 Lynn Garren
<pre>
135 2 Lynn Garren
cd $MRB_BUILDDIR/larsoft/releaseDB
136 2 Lynn Garren
copyToSciSoft lar*
137 25 Lynn Garren
</pre>
138 2 Lynn Garren
* Now tag
139 2 Lynn Garren
** tagPatchRel <existing branch> <new larsoft tag>
140 2 Lynn Garren
** tagPatchRel will commit ups/product_deps with an appropriate message, make the tag, and push both tag and branch to origin.
141 4 Lynn Garren
** Use "dogit status" to doublecheck.
142 2 Lynn Garren
** *IMPORTANT*:  patch release tags are never merged with the master branch
143 2 Lynn Garren
144 2 Lynn Garren
h3(count).  Official build
145 2 Lynn Garren
146 21 Lynn Garren
* build on Jenkins
147 21 Lynn Garren
* Use special patch release build jobs.
148 1 Lynn Garren
** This avoids possible conflict with normal release builds.
149 1 Lynn Garren
** "larpatch-slf":https://buildmaster.fnal.gov/buildmaster/view/LArSoft/job/larpatch-slf/
150 1 Lynn Garren
** "larpatch-mac":https://buildmaster.fnal.gov/buildmaster/view/LArSoft/job/larpatch-mac/
151 5 Lynn Garren
* use copyFromJenkins to download the tarballs and release manifests from Jenkins
152 5 Lynn Garren
* use copyToSciSoft to upload the tarballs and release manifests to SciSoft
153 5 Lynn Garren
** This step requires extra privileges.
154 2 Lynn Garren
155 5 Lynn Garren
h3(count).  Release Notes and Cross Package Tag
156 2 Lynn Garren
157 2 Lynn Garren
* Once the build is complete for ALL variants (SLF and macOS), make the cross package tag.
158 18 Lynn Garren
** We wait because sometimes a problem is not found until building and we need to move a tag.
159 2 Lynn Garren
** This step requires redmine manager persmission for larsoft
160 18 Lynn Garren
<pre>
161 2 Lynn Garren
cp-patch-tag <larsoft tag> <larsoftobj tag>
162 23 Lynn Garren
</pre>
163 2 Lynn Garren
*** It would be nice to fix cp-patch-tag so it deduces the larsoftobj tag
164 2 Lynn Garren
* Make the release notes
165 1 Lynn Garren
** makePatchRelNotes <working_directory> <tag> <previous tag>
166 27 Lynn Garren
*** This script will create a subdirectory named tag under the working_directory and generate a text file.
167 1 Lynn Garren
** cd into the newly created tag directory
168 1 Lynn Garren
** cat ReleaseNotes-vaa_bb_cc_dd
169 27 Lynn Garren
*** The first line of this output is a table file entry.  Cut and paste into the top of the [[LArSoft_release_list|release list]] 
170 2 Lynn Garren
*** The remainder of the output is used to create the release note itself.
171 27 Lynn Garren
**** Cut and past everything from "h1. LArSoft ..." to the bottom of the file into the empty release note entry.
172 27 Lynn Garren
**** Edit the information in part as appropriate.
173 1 Lynn Garren
**** Do not edit anything under the "Change List" section.
174 1 Lynn Garren
**** It is important to use cat so that there are no unexpected line breaks.
175 5 Lynn Garren
176 5 Lynn Garren
h3(count). Upload to cvmfs
177 5 Lynn Garren
178 5 Lynn Garren
* This step requires login privileges.
179 5 Lynn Garren
* ssh cvmfslarsoft@oasiscfs.fnal.gov
180 5 Lynn Garren
* The README provides an overview of the necessary steps.
181 5 Lynn Garren
** start a transaction
182 5 Lynn Garren
** install using installBundle.sh
183 5 Lynn Garren
** publish
184 5 Lynn Garren
* installBundle.sh larsoft vaa_bb_cc_zz sNN-eY
185 1 Lynn Garren
** Note that if you call installBundle.sh with sNN-e17, it will install both e17 and c2 variants.
186 5 Lynn Garren
** The script will attempt to install the release for all supported platforms and clean up after itself.
187 5 Lynn Garren
** *If some expected distributions are not available, then manifests will be left in the .working subdirectory. Check and remove them if necessary.*
188 27 Lynn Garren
* installBundleSLF.sh is the same as installBundle.sh, but only installs for SLF6 and SLF7.