Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: downloads/boost_1_33_1/more/release_procedures.htm @ 18

Last change on this file since 18 was 12, checked in by landauf, 17 years ago

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