Project

General

Profile

Tagging » History » Version 18

Herbert Greenlee, 05/11/2015 01:29 PM

1 5 Herbert Greenlee
{{toc}}
2 2 Herbert Greenlee
3 14 Herbert Greenlee
h1. Preparing a release from the develop branch (git flow release method)
4 1 Herbert Greenlee
5 15 Herbert Greenlee
Make an mrb development area corresponding to the base release of larsoft you are using.
6 11 Herbert Greenlee
<pre>
7 11 Herbert Greenlee
export MRB_PROJECT=larsoft
8 11 Herbert Greenlee
mrb newDev -v v04_03_01 -q e7:prof ...
9 11 Herbert Greenlee
cd $MRB_TOP
10 11 Herbert Greenlee
source localProducts*/setup
11 11 Herbert Greenlee
</pre>
12 1 Herbert Greenlee
13 11 Herbert Greenlee
If necessary, check out uboonecode and dependent packages that are not part of larsoft (ubutil).
14 1 Herbert Greenlee
<pre>
15 11 Herbert Greenlee
cd $MRB_SOURCE
16 11 Herbert Greenlee
mrb g uboonecode
17 11 Herbert Greenlee
mrb g ubutil
18 11 Herbert Greenlee
</pre>
19 11 Herbert Greenlee
20 11 Herbert Greenlee
Make sure your local copies of develop and master branches up to date with the main repository.  Do this for each checked out package.
21 11 Herbert Greenlee
<pre>
22 2 Herbert Greenlee
cd $MRB_SOURCE/<package>
23 2 Herbert Greenlee
git checkout develop
24 2 Herbert Greenlee
git pull
25 1 Herbert Greenlee
git checkout master
26 1 Herbert Greenlee
git pull
27 2 Herbert Greenlee
</pre>
28 1 Herbert Greenlee
29 11 Herbert Greenlee
Use git flow to create a release branch in your local repository.  Git flow always creates the release branch from the head of develop.  
30 10 Herbert Greenlee
<pre>
31 15 Herbert Greenlee
git flow release start <version>
32 4 Herbert Greenlee
</pre>
33 4 Herbert Greenlee
34 16 Herbert Greenlee
This command creates a new branch off of the head of develop called @release/<version>@.  After this command, the newly created release branch will be the checked out branch.  At this point, you can make further changes to your release branch, including the version number of the package being tagged and version numbers of dependent products.  In particular, you may with to edit the following files.
35 2 Herbert Greenlee
36 2 Herbert Greenlee
* ups/product_deps
37 1 Herbert Greenlee
38 1 Herbert Greenlee
After making all updates, it is a good idea to do a full test build, including tests.
39 2 Herbert Greenlee
<pre>
40 1 Herbert Greenlee
cd $MRB_BUILDDIR
41 1 Herbert Greenlee
mrb i -j4
42 1 Herbert Greenlee
mrb t -j4
43 1 Herbert Greenlee
</pre>  
44 11 Herbert Greenlee
When you are done updating the release branch, commit updates to your local repository for each package.
45 1 Herbert Greenlee
<pre>
46 1 Herbert Greenlee
cd $MRB_SOURCE/<package>
47 11 Herbert Greenlee
git commit -a
48 1 Herbert Greenlee
</pre>
49 1 Herbert Greenlee
50 11 Herbert Greenlee
Use git flow to "finish" the release branch.
51 11 Herbert Greenlee
52 1 Herbert Greenlee
<pre>
53 14 Herbert Greenlee
git flow release finish
54 1 Herbert Greenlee
</pre>
55 13 Herbert Greenlee
This git flow command does the following actions.
56 1 Herbert Greenlee
57 11 Herbert Greenlee
* Merges release branch to master.
58 11 Herbert Greenlee
* Merges release branch to develop.
59 11 Herbert Greenlee
* Creates a tag on the master branch.
60 11 Herbert Greenlee
* Deletes the release branch.
61 11 Herbert Greenlee
* Checks out the develop branch.
62 11 Herbert Greenlee
63 12 Herbert Greenlee
Note that when you merge the release branch into master, you are also merging any updates originally from develop into master.
64 12 Herbert Greenlee
65 11 Herbert Greenlee
Now push everything up to main repository.
66 1 Herbert Greenlee
<pre>
67 1 Herbert Greenlee
git push origin develop master
68 15 Herbert Greenlee
git push --tags
69 1 Herbert Greenlee
</pre>
70 1 Herbert Greenlee
71 1 Herbert Greenlee
h1. Preparing a hotfix release (git flow hotfix method)
72 1 Herbert Greenlee
73 18 Herbert Greenlee
Prepare your development area as in the previous section, up to the "@git flow release start@" command.  If you are patching a release that corresponds to the current head of the master branch (i.e. the most recent tag), start your hotfix branch using the following command.
74 15 Herbert Greenlee
<pre>
75 1 Herbert Greenlee
git flow hotfix start <version>
76 18 Herbert Greenlee
</pre>
77 18 Herbert Greenlee
If you want to patch an older tag, you must first create a new branch off of that tag.
78 18 Herbert Greenlee
<pre>
79 18 Herbert Greenlee
git checkout -b <bug_fix_branch> <existing tag>
80 18 Herbert Greenlee
git flow hotfix start <version> <bug_fix_branch>
81 1 Herbert Greenlee
</pre>
82 16 Herbert Greenlee
83 16 Herbert Greenlee
This command creates a new branch off of the head of master called @hotfix/<version>@.  Make updates and test your hotfix branch as in the previous section.  When you are done, use the following command to finish the hotfix.
84 16 Herbert Greenlee
<pre>
85 16 Herbert Greenlee
git flow hotfix finish
86 16 Herbert Greenlee
</pre>
87 16 Herbert Greenlee
88 16 Herbert Greenlee
This command merges the hotfix branch to master and develop and creates a new tag on the master branch.  Then push your updates up to the main repository.
89 16 Herbert Greenlee
<pre>
90 16 Herbert Greenlee
git push origin develop master
91 16 Herbert Greenlee
git push --tags
92 16 Herbert Greenlee
</pre>
93 16 Herbert Greenlee
94 16 Herbert Greenlee
The main difference between "@git flow release@" and "@git flow hotfix@" is that the former works off of develop, and the latter works off of master.
95 1 Herbert Greenlee
96 11 Herbert Greenlee
h1. Tagging a branch for release (manual method)
97 1 Herbert Greenlee
98 11 Herbert Greenlee
Releases are built from the @master@ branch.  This recipe shows how to create a tag on the @master@ branch of a git repository.
99 11 Herbert Greenlee
100 11 Herbert Greenlee
Make a new mrb development area corresponding to the base release of larsoft you are using.
101 5 Herbert Greenlee
<pre>
102 11 Herbert Greenlee
export MRB_PROJECT=larsoft
103 11 Herbert Greenlee
mrb newDev -v v04_03_01 -q e7:prof ...
104 11 Herbert Greenlee
cd $MRB_TOP
105 11 Herbert Greenlee
source localProducts*/setup
106 11 Herbert Greenlee
</pre>
107 11 Herbert Greenlee
108 11 Herbert Greenlee
If necessary, check out uboonecode and dependent packages that are not part of larsoft (ubutil).
109 11 Herbert Greenlee
<pre>
110 11 Herbert Greenlee
cd $MRB_SOURCE
111 11 Herbert Greenlee
mrb g uboonecode
112 11 Herbert Greenlee
mrb g ubutil
113 11 Herbert Greenlee
</pre>
114 11 Herbert Greenlee
115 11 Herbert Greenlee
Get your local copies of develop and master branches up to date with the main repository.
116 11 Herbert Greenlee
<pre>
117 5 Herbert Greenlee
cd $MRB_SOURCE/<package>
118 1 Herbert Greenlee
git checkout develop
119 1 Herbert Greenlee
git pull
120 1 Herbert Greenlee
git checkout master
121 1 Herbert Greenlee
git pull
122 1 Herbert Greenlee
</pre>
123 1 Herbert Greenlee
124 17 Herbert Greenlee
If desired, update the master branch with changes from develop.
125 5 Herbert Greenlee
<pre>
126 11 Herbert Greenlee
git merge develop
127 5 Herbert Greenlee
</pre>
128 5 Herbert Greenlee
129 11 Herbert Greenlee
At this point, you can make further changes to your master branch, including the version number of the package being tagged and version numbers of dependent products.  In particular, you may with to edit the following files.
130 5 Herbert Greenlee
131 5 Herbert Greenlee
* ups/product_deps
132 5 Herbert Greenlee
133 5 Herbert Greenlee
After making all updates, it is a good idea to do a full test build, including tests.
134 5 Herbert Greenlee
<pre>
135 5 Herbert Greenlee
cd $MRB_BUILDDIR
136 5 Herbert Greenlee
mrb i -j4
137 5 Herbert Greenlee
mrb t -j4
138 5 Herbert Greenlee
</pre>  
139 11 Herbert Greenlee
When you are done updating master, commit and push your changes to the main repository.
140 6 Herbert Greenlee
<pre>
141 5 Herbert Greenlee
cd $MRB_SOURCE/<package>
142 11 Herbert Greenlee
git commit -a
143 11 Herbert Greenlee
git push origin master
144 1 Herbert Greenlee
</pre>
145 6 Herbert Greenlee
146 11 Herbert Greenlee
Now make the actual tag and push the tag to the main repository.
147 5 Herbert Greenlee
<pre>
148 11 Herbert Greenlee
git tag -a -m"v04_03_01" v04_03_01   # Annotated tag.
149 11 Herbert Greenlee
git push origin v04_03_01            # Or git push --tags
150 6 Herbert Greenlee
</pre>
151 11 Herbert Greenlee
If you want to move an existing tag, you need to add option @-f@ or @--force@ to the last two commands.
152 1 Herbert Greenlee
153 11 Herbert Greenlee
If you made changes directly on the master branch, like updating the version number in product_deps, you should merge these back into the develop branch.
154 1 Herbert Greenlee
<pre>
155 11 Herbert Greenlee
git checkout develop
156 11 Herbert Greenlee
git merge master
157 11 Herbert Greenlee
git push origin develop
158 1 Herbert Greenlee
</pre>