2002-01-29 03:22:09 +08:00
|
|
|
<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="../c++boost.gif" alt="c++boost.gif (8819 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="#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>
|
2003-03-07 02:04:22 +08:00
|
|
|
<li>Release manager performs release candidate branch, and also tags the
|
|
|
|
|
branch point in main trunk.<br>
|
2002-01-29 03:22:09 +08:00
|
|
|
</li>
|
2003-03-07 02:04:22 +08:00
|
|
|
<li>Regression tests run on release candidate branch.<br>
|
2002-01-29 03:22:09 +08:00
|
|
|
</li>
|
2003-03-07 02:04:22 +08:00
|
|
|
<li>Developers fix problems, test, and commit fixes. See below for details.<br>
|
2002-01-29 03:22:09 +08:00
|
|
|
</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>
|
2003-03-07 02:04:22 +08:00
|
|
|
<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. <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>
|
2002-01-29 03:22:09 +08:00
|
|
|
</ul>
|
|
|
|
|
<blockquote>
|
|
|
|
|
<ul>
|
2002-01-29 03:26:14 +08:00
|
|
|
<li>Command Line CVS:</li>
|
2002-01-29 03:22:09 +08:00
|
|
|
</ul>
|
|
|
|
|
<blockquote>
|
2003-03-07 02:04:22 +08:00
|
|
|
<pre>[After fixed code is committed to main branch]
|
|
|
|
|
cvs update -r RC_1_26_2 [switch to the release candidate branch]
|
2003-03-07 02:45:03 +08:00
|
|
|
cvs update -jmerged_to_1_26_2 -jHEAD buggycode.hpp [merge changes from the trunk to the branch]
|
2003-03-07 02:04:22 +08:00
|
|
|
--> 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
|
2002-01-29 03:22:09 +08:00
|
|
|
|
2003-03-07 02:04:22 +08:00
|
|
|
cvs commit -m "Merged fix for problem xyz from trunk to branch" buggycode.hpp
|
2003-03-07 02:45:03 +08:00
|
|
|
cvs update -A [go back to main trunk]
|
|
|
|
|
cvs tag -F -c merged_to_RC_1_28_2 buggycode.hpp [tag new merged point]
|
2002-01-29 03:22:09 +08:00
|
|
|
|
2003-03-07 02:04:22 +08:00
|
|
|
[Repeat as needed]</pre>
|
2002-01-29 03:22:09 +08:00
|
|
|
</blockquote>
|
|
|
|
|
<ul>
|
|
|
|
|
<li>WinCVS:</li>
|
|
|
|
|
</ul>
|
|
|
|
|
<blockquote>
|
2003-03-07 02:45:03 +08:00
|
|
|
<p>After fixed code is committed to main branch, switch to the release
|
|
|
|
|
candidate branch:</p>
|
2003-03-07 02:25:31 +08:00
|
|
|
<blockquote>
|
|
|
|
|
<p>Select file(s) if not already selected.</p>
|
|
|
|
|
</blockquote>
|
2003-03-07 02:04:22 +08:00
|
|
|
<blockquote>
|
|
|
|
|
<p>Modify | Update selection... |
|
2003-03-07 02:25:31 +08:00
|
|
|
Update settings | Sticky options | Retrieve rev/tag/branch: <code>RC_1_26_2</code> | OK</p>
|
2003-03-07 02:04:22 +08:00
|
|
|
</blockquote>
|
|
|
|
|
<p>Merge changes from main trunk into the release candidate branch:</p>
|
2002-01-29 03:22:09 +08:00
|
|
|
<blockquote>
|
2003-03-07 02:04:22 +08:00
|
|
|
<p>Modify | Update selection... |
|
2003-03-07 02:45:03 +08:00
|
|
|
Update settings | Merge options | Only this rev/tag: <code>merged_to_1_26_2</code>
|
|
|
|
|
| Plus with this rev/tag: <code>HEAD</code> | OK</p>
|
2002-01-29 03:22:09 +08:00
|
|
|
</blockquote>
|
2003-03-07 02:04:22 +08:00
|
|
|
<p>Commit merge results:</p>
|
2002-01-29 03:22:09 +08:00
|
|
|
<blockquote>
|
2003-03-07 02:04:22 +08:00
|
|
|
<p>Modify | Commit... | Enter log message: ... | OK</p>
|
2002-01-29 03:22:09 +08:00
|
|
|
</blockquote>
|
2003-03-07 02:45:03 +08:00
|
|
|
<p>Go back to main trunk:</p>
|
|
|
|
|
<blockquote>
|
|
|
|
|
<p>Modify | Update selection... | Update settings | Reset any sticky
|
|
|
|
|
date/tag/-k options | OK</p>
|
|
|
|
|
</blockquote>
|
|
|
|
|
<p>Tag as new merge point:</p>
|
|
|
|
|
<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>
|
2002-01-29 03:22:09 +08:00
|
|
|
</blockquote>
|
|
|
|
|
</blockquote>
|
|
|
|
|
<h2>Release Procedures for the Release <a name="Manager">Manager</a></h2>
|
2003-03-07 02:04:22 +08:00
|
|
|
<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>
|
2002-01-29 03:22:09 +08:00
|
|
|
<h2><a name="Acknowledgements">Acknowledgements</a></h2>
|
|
|
|
|
<p>This web page was written by Beman Dawes, with helpful suggestions from Dave
|
2003-03-07 02:04:22 +08:00
|
|
|
Abrahams and Steve Robbins. Jim Hyslop contributed the original CVS procedures.
|
|
|
|
|
Updated by Jeff Garland after 1.29 release based on list discussions.</p>
|
2002-01-29 03:22:09 +08:00
|
|
|
<hr>
|
|
|
|
|
<p>Revised:
|
2003-03-07 02:04:22 +08:00
|
|
|
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->06 March, 2003<!--webbot bot="Timestamp" i-checksum="28840" endspan --></p>
|
2002-01-29 03:22:09 +08:00
|
|
|
|
|
|
|
|
</body>
|
|
|
|
|
|
|
|
|
|
</html>
|
