Project

General

Profile

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

Lynn Garren, 02/27/2019 03:06 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 10 Lynn Garren
17 11 Lynn Garren
h2(count). Request a release
18 11 Lynn Garren
19 11 Lynn Garren
* Before starting any patch release, fill out a redmine issue requesting the release with all pertinent information.
20 10 Lynn Garren
21 10 Lynn Garren
22 2 Lynn Garren
h2(count). Tools
23 2 Lynn Garren
24 2 Lynn Garren
* Scripts used to build the patch release will be found in the larreltools product.  
25 2 Lynn Garren
* larreltools is not part of the standard distribution, but will be available from SciSoft and in cvmfs.
26 4 Lynn Garren
27 2 Lynn Garren
h2(count). Initial setup
28 1 Lynn Garren
29 10 Lynn Garren
*This step is done once for any patch release step and will be done by the LArSoft release manager.*
30 9 Lynn Garren
31 2 Lynn Garren
h3(count). Make branches for the release
32 2 Lynn Garren
33 2 Lynn Garren
* If a release is named vaa_bb_cc, branches will be created for the larsoft/larsoftobj suite with the name vaa_bb_cc_br.
34 2 Lynn Garren
<pre>
35 2 Lynn Garren
(setup the latest larreltools)
36 2 Lynn Garren
setup mrb
37 2 Lynn Garren
export MRB_PROJECT=larsoft
38 2 Lynn Garren
mrb newDev -v  vaa_bb_cc -q eN:prof 
39 2 Lynn Garren
source local*/setup
40 2 Lynn Garren
cd $MRB_SOURCE
41 2 Lynn Garren
mrb g -t LARSOFT_SUITE_vAA_BB_CC larsoft_suite
42 2 Lynn Garren
mrb g -t LARSOFT_SUITE_vAA_BB_CC larsoftobj_suite
43 2 Lynn Garren
dogit branch (check that you are on the head of the tag)
44 2 Lynn Garren
dogit "co -b vaa_bb_cc_br"
45 2 Lynn Garren
dogit "push -u origin vaa_bb_cc_br"
46 1 Lynn Garren
</pre>
47 8 Lynn Garren
** Note that some older patch releases may have used a slightly different branch naming scheme.
48 2 Lynn Garren
49 4 Lynn Garren
h3(count). Housecleaning
50 2 Lynn Garren
51 2 Lynn Garren
* cd $MRB_SOURCE/larsoft/releaseDB
52 2 Lynn Garren
* Make sure that larutils, larbatch, and mrb are removed from the cfg scripts.
53 2 Lynn Garren
** streamline this by creating a small "larsoft extras" distribution that can be optionally included.
54 2 Lynn Garren
* commit and push the change
55 2 Lynn Garren
56 4 Lynn Garren
h2(count). Making a patch release
57 2 Lynn Garren
58 2 Lynn Garren
* These notes presume that you do not have an existing directory
59 2 Lynn Garren
60 4 Lynn Garren
h3(count). MicroBooNE setup
61 2 Lynn Garren
62 2 Lynn Garren
* setup the latest release of larreltools
63 2 Lynn Garren
* startUboonePatchRel  <working_dir> <tag> <larsoft branch> [<uboone branch>]
64 2 Lynn Garren
** This script will create a directory named "tag" under the "working_dir".
65 2 Lynn Garren
** This script will clone the larsoft/larsoftobj on the named branch.
66 2 Lynn Garren
** The same branch name will be used when cloning the uboone_suite unless a second branch name is supplied.
67 2 Lynn Garren
** The directory structure will include a single source code directory with subdirectories for e17 and c2 debug and prof builds.
68 2 Lynn Garren
** Use "dogit branch" to double check that you are on the expected branch.
69 2 Lynn Garren
70 4 Lynn Garren
h3(count). Setup for other experiments
71 2 Lynn Garren
72 2 Lynn Garren
* Appropriate scripts will be supplied when necessary.
73 2 Lynn Garren
74 4 Lynn Garren
h3(count). Local development
75 2 Lynn Garren
76 2 Lynn Garren
* Before integrating any feature branches, make sure that the release builds as is and that the unit tests work.
77 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.
78 2 Lynn Garren
<pre>
79 2 Lynn Garren
source local*/setup
80 2 Lynn Garren
cd $MRB_BUILDDIR
81 2 Lynn Garren
mrb t -jN
82 2 Lynn Garren
</pre>
83 2 Lynn Garren
* Next make changes and integrate feature branches
84 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.
85 2 Lynn Garren
86 4 Lynn Garren
h3(count). Update the package versions
87 2 Lynn Garren
88 2 Lynn Garren
* Do this once all changes have been made.
89 2 Lynn Garren
* ONLY update the version if there is a change.
90 2 Lynn Garren
* cd to each directory separately
91 2 Lynn Garren
* git diff LARSOFT_SUITE_vaa_bb_cc[_dd]
92 2 Lynn Garren
** You are comparing against the previous patch release in this set.
93 2 Lynn Garren
** If this is the first patch release in the set, compare against the original release.
94 2 Lynn Garren
** If there are no changes, move this package out of the way.
95 2 Lynn Garren
<pre>
96 2 Lynn Garren
cd $MRB_SOURCE
97 2 Lynn Garren
mkdir ../notag
98 2 Lynn Garren
mv xxx ../notag
99 2 Lynn Garren
mrb uc
100 2 Lynn Garren
</pre>
101 2 Lynn Garren
** Move all experiment code out of the way.  (_mv ub* ../notag/_ for MicroBooNE)
102 2 Lynn Garren
** Use "mrb uv" to update the version by one in the patch field.
103 2 Lynn Garren
*** There should be a script for this...
104 2 Lynn Garren
* You must update larsoftobj/bundle/CMakeLists.txt and larsoft/releaseDB/CMakeLists.txt by hand with the new versions.
105 2 Lynn Garren
** commit and push these changes
106 2 Lynn Garren
* DO NOT commit the changes to ups/product_deps
107 2 Lynn Garren
108 2 Lynn Garren
109 4 Lynn Garren
h3(count).  Tagging the release
110 2 Lynn Garren
111 2 Lynn Garren
* Do a final build and test with just the packages you expect to tag.  
112 2 Lynn Garren
** This step will also create the necessary build cfg files.
113 2 Lynn Garren
** If there are changes in both larsoft and larsoftobj, double check for consistency.
114 2 Lynn Garren
<pre>
115 2 Lynn Garren
cd $MRB_BUILDDIR/larsoft
116 2 Lynn Garren
diff releaseDB ../larsoftobj/bundle | grep diff
117 2 Lynn Garren
diff releaseDB ../larsoftobj/bundle | grep Only
118 2 Lynn Garren
</pre>
119 2 Lynn Garren
** If all is good, copy the cfg scripts to SciSoft
120 2 Lynn Garren
<pre>
121 2 Lynn Garren
cd $MRB_BUILDDIR/larsoft/releaseDB
122 2 Lynn Garren
copyToSciSoft lar*
123 2 Lynn Garren
</pre>
124 2 Lynn Garren
* Now tag
125 2 Lynn Garren
** tagPatchRel <existing branch> <new master tag>
126 2 Lynn Garren
** tagPatchRel will commit ups/product_deps with an appropriate message, make the tag, and push both tag and branch to origin.
127 2 Lynn Garren
** Use "dogit status" to doublecheck.
128 2 Lynn Garren
** *IMPORTANT*:  patch release tags are never merged with the master branch
129 2 Lynn Garren
130 4 Lynn Garren
h3(count).  Official build
131 2 Lynn Garren
132 2 Lynn Garren
* build on Jenkins
133 2 Lynn Garren
* Use special patch release build jobs.
134 2 Lynn Garren
** This avoids possible conflict with normal release builds.
135 1 Lynn Garren
* use copyFromJenkins to download the tarballs and release manifests from Jenkins
136 1 Lynn Garren
* use copyToSciSoft to upload the tarballs and release manifests to SciSoft
137 1 Lynn Garren
** This step requires extra privileges.
138 5 Lynn Garren
139 5 Lynn Garren
h3(count).  Release Notes and Cross Package Tag
140 5 Lynn Garren
141 2 Lynn Garren
* Once the build is complete for ALL variants (SLF and macOS), make the cross package tag.
142 5 Lynn Garren
** We wait because sometimes a problem is not found until building and we need to move a tag.
143 2 Lynn Garren
** This step requires redmine manager persmission for larsoft
144 2 Lynn Garren
<pre>
145 2 Lynn Garren
cp-lar-tag <larsoft tag> <larsoftobj tag>
146 2 Lynn Garren
</pre>
147 2 Lynn Garren
*** It would be nice to fix cp-lar-tag so it deduces the larsoftobj tag
148 2 Lynn Garren
* Make the release notes
149 2 Lynn Garren
** make-release-notes <working_directory> <tag> <previous tag>
150 2 Lynn Garren
*** This script will create a subdirectory named tag under the working_directory
151 2 Lynn Garren
** cd into the newly created tag directory
152 2 Lynn Garren
** cat ReleaseNotes-vaa_bb_cc_dd
153 2 Lynn Garren
*** The first line of this output is the entry in the [[LArSoft_release_list|release list]]
154 2 Lynn Garren
*** The remainder of the output is used to create the release note itself.
155 1 Lynn Garren
**** copy and edit the top part if appropriate.
156 1 Lynn Garren
**** Do not edit anything under the "Change List" section.
157 1 Lynn Garren
**** It is important to use cat so that there are no unexpected line breaks.
158 5 Lynn Garren
159 5 Lynn Garren
h3(count). Upload to cvmfs
160 5 Lynn Garren
161 5 Lynn Garren
* This step requires login privileges.
162 5 Lynn Garren
* ssh cvmfslarsoft@oasiscfs.fnal.gov
163 5 Lynn Garren
* The README provides an overview of the necessary steps.
164 5 Lynn Garren
** start a transaction
165 5 Lynn Garren
** install using installBundle.sh
166 5 Lynn Garren
** publish
167 5 Lynn Garren
* installBundle.sh larsoft vaa_bb_cc_zz sNN-eY
168 5 Lynn Garren
** Note that if you call installBundle.sh with sNN-e17, it will install both e17 and c2 variants.
169 5 Lynn Garren
** The script will attempt to install the release for all supported platforms and clean up after itself.
170 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.