1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Language" content="en-us">
<meta name="GENERATOR" content="Microsoft FrontPage 5.0">
<meta name="ProgId" content="FrontPage.Editor.Document">
<meta http-equiv="Content-Type" content="text/html; charset=windows-1252">
<title>Release Procedures</title>
</head>
<body bgcolor="#FFFFFF">
<table border="1" bgcolor="#007F7F" cellpadding="2">
<tr>
<td bgcolor="#FFFFFF">
<img src="../boost.png" alt="boost.png (6897 bytes)" width="277" height="86"></td>
<td><a href="../index.htm"><font face="Arial,Helvetica" color="#FFFFFF"><big>Home</big></font></a></td>
<td><a href="../libs/libraries.htm"><font face="Arial,Helvetica" color="#FFFFFF"><big>Libraries</big></font></a></td>
<td><a href="../people/people.htm"><font face="Arial,Helvetica" color="#FFFFFF"><big>People</big></font></a></td>
<td><a href="../more/faq.htm"><font face="Arial,Helvetica" color="#FFFFFF"><big>FAQ</big></font></a></td>
<td><a href="../more/index.htm"><font face="Arial,Helvetica" color="#FFFFFF"><big>More</big></font></a></td>
</tr>
</table>
<h1>Boost Release Procedures</h1>
<p><a href="#Introduction">Introduction</a><br>
<a href="#Overview">Procedure Overview</a><br>
<a href="#Developers">Procedures for Developers</a><br>
<a href="#Manager">Procedures for the Release Manager</a><br>
<a href="#FAQ">FAQ</a><br>
<a href="#Acknowledgements">Acknowledgements</a></p>
<h2><a name="Introduction">Introduction</a></h2>
<p>Each release of Boost software is overseen by a release manager, who
coordinates release activities via the Boost mailing list, as well as performing
the detailed procedures for the release.</p>
<p>Boost developers assist the release manager by reviewing regression test
logs, and committing fixes to CVS.</p>
<h2>Release Procedure <a name="Overview">Overview</a></h2>
<ul>
<li>Discussion on the main Boost mailing list to determine the target date for
release candidate branch and tag of the CVS main trunk.<br>
</li>
<li>Release manager performs release candidate branch, and also tags the
branch point in main trunk.<br>
</li>
<li>Regression tests run on release candidate branch.<br>
</li>
<li>Developers fix problems, test, and commit fixes. See below for details.<br>
</li>
<li>Repeat previous two steps until release manager is satisfied.<br>
</li>
<li>Release manager rolls out the actual release.</li>
</ul>
<h2>Release Procedures for <a name="Developers">Developers</a></h2>
<ul>
<li>As the release candidate branch date approaches (as announced on the main
mailing list), bring the main trunk CVS files you are responsible for into a
stable state.<br>
</li>
<li>If you know of changes in either your code or its dependencies, start
checking regression test results to ensure your tests still pass. Don't
necessarily wait for the initial release tagging.<br>
</li>
<li>After the release manager announces that the release candidate branch has
occurred, check the latest regression test results to be sure
your tests haven't broken.<br>
</li>
<li>Developers can continue working on main trunk code changes after
the release candidate branch has occurred. There is no need to wait until the release
itself.
Modified files committed to CVS on the main trunk will not be included in the release unless the
developer explicitly commits the changes to the release candidate branch.<br>
</li>
<li>If specific to the release candidate only, the fixes should be committed
directly to the release candidate branch. In the more common case of fixes
which apply to both the main trunk and the release branch, the fixes are best
made to the main trunk, and then merged into the release candidate branch. See
FAQ for <a href="#merged_to_RC_n_n_n">tag rationale</a>.<br>
<br>
After a fix has been committed to the main trunk, here is a
typical procedure (assuming the release candidate branch is named RC_1_26_2)
to merge the fixed main trunk into the release candidate branch:</li>
</ul>
<blockquote>
<ul>
<li>Command Line CVS:</li>
</ul>
<blockquote>
<ul>
<li>Fixed code is committed to main branch <br>
</li>
<li>Switch to the release candidate branch
<blockquote>
<code>cvs update -r RC_1_26_2</code></blockquote>
</li>
<li>Merge changes in a trunk since previous merge to branch
<blockquote>
<pre>cvs update -j<a href="#merged_to_RC_n_n_n">merged_to_RC_1_26_2</a> -jHEAD buggycode.hpp
--> RCS file: /cvsroot/boost/.../buggycode.hpp,v
--> retrieving revision 1.4
--> retrieving revision 1.6
--> Merging differences between 1.4 and 1.6 into buggycode.hpp</pre>
</blockquote>
</li>
<li>Commit merged branch
<blockquote>
<pre>cvs commit -m "Merged fix for problem xyz from trunk to branch" buggycode.hpp</pre>
</blockquote>
</li>
<li>Go back to main trunk
<blockquote>
<pre>cvs update -A</pre>
</blockquote>
</li>
<li>Move tag to a new merged point
<blockquote>
<pre>cvs tag -F -c merged_to_RC_1_28_2 buggycode.hpp</pre>
</blockquote>
</li>
<li>Repeat as needed
</li>
</ul>
</blockquote>
<ul>
<li>WinCVS:</li>
</ul>
<blockquote>
<ul>
<li>After fixed code is committed to main branch, switch to the release
candidate branch:</li>
</ul>
<blockquote>
<blockquote>
<p>Select file(s) if not already selected.</p>
<p>Modify | Update selection... |
Update settings | Sticky options | Retrieve rev/tag/branch: <code>RC_1_26_2</code> | OK</p>
</blockquote>
</blockquote>
<ul>
<li>Merge changes from main trunk into the release candidate branch:</li>
</ul>
<blockquote>
<blockquote>
<p>Modify | Update selection... |
Update settings | Merge options | Only this rev/tag: <code>
<a href="#merged_to_RC_n_n_n">merged_to_RC_1_26_2</a></code>
| Plus with this rev/tag: <code>HEAD</code> | OK</p>
</blockquote>
</blockquote>
<ul>
<li>Commit merge results:</li>
</ul>
<blockquote>
<blockquote>
<p>Modify | Commit... | Enter log message: ... | OK</p>
</blockquote>
</blockquote>
<ul>
<li>Go back to main trunk:</li>
</ul>
<blockquote>
<blockquote>
<p>Modify | Update selection... | Update settings | Reset any sticky
date/tag/-k options | OK</p>
</blockquote>
</blockquote>
<ul>
<li>Tag as new merge point:</li>
</ul>
<blockquote>
<blockquote>
<p>Modify | Create tag on selection... | Create tag settings | Enter the tag
name to create: <code>merged_to_RC_1_26_2</code>, Overwrite existing tags
with same name | OK.</p>
</blockquote>
</blockquote>
</blockquote>
</blockquote>
<h2>Release Procedures for the Release <a name="Manager">Manager</a></h2>
<p>At time of branch-for-release:</p>
<ul>
<li>Tag the main trunk <code>merged_to_RC_n_n_n</code>.</li>
<li>Branch the main trunk with the tag <code>RC_n_n_n</code>.</li>
</ul>
<p>See <a href="release_mgr_checklist.html">Release Manager's Checklist</a> for
full details.</p>
<h2><a name="FAQ">FAQ</a></h2>
<p><b>What is the purpose of the <i><a name="merged_to_RC_n_n_n">
merged_to_RC_n_n_n</a></i> tag?</b> This tag allows multiple merges from the
main trunk to the release candidate branch. Without it, merging an initial main
trunk fix into the release candidate branch would work, but merging a
second fix from main trunk to release candidate branch would result in a merge
conflict. Although this procedure seems convoluted, it works much better in
practice than several prior procedures we tried.</p>
<h2><a name="Acknowledgements">Acknowledgements</a></h2>
<p>This web page was written by Beman Dawes, with helpful suggestions from Dave
Abrahams and Steve Robbins. Jim Hyslop contributed the original CVS procedures.
Updated by Jeff Garland after 1.29 release based on list discussions.</p>
<hr>
<p>Revised:
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->02 October, 2003<!--webbot bot="Timestamp" i-checksum="38549" endspan --></p>
<p>© Copyright Beman Dawes 2002</p>
<p>Distributed under the Boost Software License, Version 1.0. (See
accompanying file <a href="../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or copy
at <a href="http://www.boost.org/LICENSE_1_0.txt">http://www.boost.org/LICENSE_1_0.txt</a>)</p>
</body>
</html>
|
