release_procedures.htm 8.5 KB

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