| 1 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
|---|
| 2 | <html> |
|---|
| 3 | |
|---|
| 4 | <head> |
|---|
| 5 | <meta http-equiv="Content-Language" content="en-us"> |
|---|
| 6 | <meta name="GENERATOR" content="Microsoft FrontPage 5.0"> |
|---|
| 7 | <meta name="ProgId" content="FrontPage.Editor.Document"> |
|---|
| 8 | <meta http-equiv="Content-Type" content="text/html; charset=windows-1252"> |
|---|
| 9 | <title>Release Manager's Checklist</title> |
|---|
| 10 | </head> |
|---|
| 11 | |
|---|
| 12 | <body bgcolor="#FFFFFF"> |
|---|
| 13 | |
|---|
| 14 | <table border="1" bgcolor="#007F7F" cellpadding="2"> |
|---|
| 15 | <tr> |
|---|
| 16 | <td bgcolor="#FFFFFF"> |
|---|
| 17 | <img src="../boost.png" alt="boost.png (6897 bytes)" width="277" height="86"></td> |
|---|
| 18 | <td><a href="../index.htm"><font face="Arial,Helvetica" color="#FFFFFF"><big>Home</big></font></a></td> |
|---|
| 19 | <td><a href="../libs/libraries.htm"><font face="Arial,Helvetica" color="#FFFFFF"><big>Libraries</big></font></a></td> |
|---|
| 20 | <td><a href="../people/people.htm"><font face="Arial,Helvetica" color="#FFFFFF"><big>People</big></font></a></td> |
|---|
| 21 | <td><a href="../more/faq.htm"><font face="Arial,Helvetica" color="#FFFFFF"><big>FAQ</big></font></a></td> |
|---|
| 22 | <td><a href="../more/index.htm"><font face="Arial,Helvetica" color="#FFFFFF"><big>More</big></font></a></td> |
|---|
| 23 | </tr> |
|---|
| 24 | </table> |
|---|
| 25 | |
|---|
| 26 | |
|---|
| 27 | <h1>Release Manager's Checklist</h1> |
|---|
| 28 | |
|---|
| 29 | <p><a href="#Introduction">Introduction</a><br> |
|---|
| 30 | <a href="#Pre-release">Pre-release activities</a><br> |
|---|
| 31 | <a href="#Branch-for-release">CVS Branch for release</a><br> |
|---|
| 32 | <a href="#CVS-release">CVS Release</a><br> |
|---|
| 33 | <a href="#Distribution">Distribution</a></p> |
|---|
| 34 | |
|---|
| 35 | <h2><a name="Introduction">Introduction</a></h2> |
|---|
| 36 | <p>Historically, items on this checklist were accomplished by scripts written |
|---|
| 37 | in Perl, Python, Bash, C++, and as Windows command files, or by point-and-click |
|---|
| 38 | on a FrontPage or other GUI based program. Long term the plan is to move as much |
|---|
| 39 | as possible of these to C++, as |
|---|
| 40 | the one language all Boost developers are comfortable with. </p> |
|---|
| 41 | <h2><a name="Pre-release">Pre-release</a> activities</h2> |
|---|
| 42 | <ul> |
|---|
| 43 | <li>After discussion on the main list, post the release schedule.<br> |
|---|
| 44 | </li> |
|---|
| 45 | <li>Verify the <i><b>root/index.htm</b></i>, <i><b>root/boost/version.hpp</b></i>, <i><b>root/Jamfile.v2</b></i> and |
|---|
| 46 | <i><b>root/Jamrules</b></i> |
|---|
| 47 | release numbers are correct and agree. <br> |
|---|
| 48 | </li> |
|---|
| 49 | <li>Verify via <a href="mailto:jamboost@yahoogroups.com">jamboost@yahoogroups.com</a> |
|---|
| 50 | that bjam pre-built executables up-to-date.<br> |
|---|
| 51 | </li> |
|---|
| 52 | <li>Remove the oldest "Latest News" from root/index.htm.<br> |
|---|
| 53 | </li> |
|---|
| 54 | <li>For each new library added this release:</li> |
|---|
| 55 | </ul> |
|---|
| 56 | <blockquote> |
|---|
| 57 | <ul> |
|---|
| 58 | <li>Verify root/index.htm Latest News entry has been made and reads well.<br> |
|---|
| 59 | </li> |
|---|
| 60 | <li>Verify root/libs/libraries.htm entry has been made, both in the |
|---|
| 61 | alphabetic list and in the category lists.<br> |
|---|
| 62 | </li> |
|---|
| 63 | <li>Verify the root/libs/xxx directory contains an index.htm or index.html |
|---|
| 64 | file; either the main docs or a redirection to the main docs. <b><i>To do: |
|---|
| 65 | automate this.</i></b><br> |
|---|
| 66 | </li> |
|---|
| 67 | <li>Skim read the primary docs pages to make sure they meet Boost |
|---|
| 68 | requirements and guidelines. <b><i>Don't leave this until too late; it has |
|---|
| 69 | turned up lots of issues in the past.<br> |
|---|
| 70 | </i></b></li> |
|---|
| 71 | <li>Generate the header dependency table and update the CVS.<b><i> To do: |
|---|
| 72 | coordinate with John Maddock's new dependency tools.</i></b></li> |
|---|
| 73 | </ul> |
|---|
| 74 | </blockquote> |
|---|
| 75 | <ul> |
|---|
| 76 | <li>Monitor |
|---|
| 77 | <a href="http://boost.sourceforge.net/regression-logs/inspection_report.html"> |
|---|
| 78 | http://boost.sourceforge.net/regression-logs/inspection_report.html</a> to |
|---|
| 79 | verify problems are actively being reduced. Make sure none of the problems are |
|---|
| 80 | in files the release manager is responsible for.<br> |
|---|
| 81 | </li> |
|---|
| 82 | <li>Monitor regression tests (<a href="http://boost.sourceforge.net/regression-logs/inspection_report.html">http://boost.sourceforge.net/regression-logs</a>) |
|---|
| 83 | to verify that errors are actively being reduced or accounted for on key |
|---|
| 84 | platforms and compilers.<br> |
|---|
| 85 | <ul> |
|---|
| 86 | <li>Boost errors are being actively worked on by library maintainers.</li> |
|---|
| 87 | <li>Compiler or standard library errors are at least identified, and |
|---|
| 88 | preferably reported to the supplier.</li> |
|---|
| 89 | <li>No errors remain uninvestigated or unclassified.<br> |
|---|
| 90 | </li> |
|---|
| 91 | </ul> |
|---|
| 92 | </li> |
|---|
| 93 | <li>Monitor the developer and user mailing lists to verify that all posted |
|---|
| 94 | patches are being applied, rejected, or otherwise dealt with.<br> |
|---|
| 95 | </li> |
|---|
| 96 | <li>Monitor the developer and user mailing lists, and the SourceForge bug |
|---|
| 97 | tracker, to verify that all posted bug reports are being investigated, fixed, |
|---|
| 98 | rejected, or otherwise dealt with.<br> |
|---|
| 99 | </li> |
|---|
| 100 | <li>Monitor CVS commits to verify that all the expected and/or promised |
|---|
| 101 | content actually gets committed. Try to get developers to avoid last minute |
|---|
| 102 | commits of major changes.</li> |
|---|
| 103 | </ul> |
|---|
| 104 | <h2><a name="Branch-for-release">CVS Branch for release</a></h2> |
|---|
| 105 | <ul> |
|---|
| 106 | <li>Pre-release activities complete enough to justify branch-for-release?<br> |
|---|
| 107 | </li> |
|---|
| 108 | <li>Everybody happy?<br> |
|---|
| 109 | </li> |
|---|
| 110 | <li>Branch for release:<ul> |
|---|
| 111 | <li>Tag the main trunk <code>merged_to_RC_n_n_n</code>.</li> |
|---|
| 112 | <li>Branch the main trunk with the tag <code>RC_n_n_n</code>.<br> |
|---|
| 113 | </li> |
|---|
| 114 | </ul> |
|---|
| 115 | </li> |
|---|
| 116 | <li>Post notice on main list. Remind developers that fixes which apply |
|---|
| 117 | to both Main Trunk and Branch have to be committed separately to both.</li> |
|---|
| 118 | </ul> |
|---|
| 119 | <h2><a name="CVS-release">CVS Release</a></h2> |
|---|
| 120 | <ul> |
|---|
| 121 | <li>Pre-release activities all complete?<br> |
|---|
| 122 | </li> |
|---|
| 123 | <li>Post notice to make sure all developers ready.<br> |
|---|
| 124 | </li> |
|---|
| 125 | <li>Tag: WinCVS: Select site, then tag (Modify|Create tag..., toolbar T on doc). New |
|---|
| 126 | tag name: Version_1_21_2 (or whatever). If prior release failed, select |
|---|
| 127 | "overwrite existing tags with the same name".</li> |
|---|
| 128 | </ul> |
|---|
| 129 | <h2><a name="Distribution">Distribution</a></h2> |
|---|
| 130 | <p>These procedures are given for a particular release manager's machine. The |
|---|
| 131 | plan is to replace them with more generic procedures over time.</p> |
|---|
| 132 | <ul> |
|---|
| 133 | <li>Create folders for export:<br> |
|---|
| 134 | <br> |
|---|
| 135 | c:\boost\boost_1_28_0<br> |
|---|
| 136 | c:\boost\temp\boost_1_28_0<br> |
|---|
| 137 | <br> |
|---|
| 138 | Note that several batch files assume these locations and naming schemes.<br> |
|---|
| 139 | </li> |
|---|
| 140 | <li>Export Win32 distribution: WinCVS | Remote | Checkout Module<br> |
|---|
| 141 | <br> |
|---|
| 142 | Checkout settings: module name and path on the server: boost, local folder to |
|---|
| 143 | checkout to: c:\boost\boost_1_28_0<br> |
|---|
| 144 | <b><i>[for 1.29.0 export, put everything in a boost_1_29_0/boost subdirectory. |
|---|
| 145 | Experiments with 1.30.0 tried boost/boost as the path on server, but that just |
|---|
| 146 | resulted in getting the boost header subdirectory only.]</i></b><br> |
|---|
| 147 | <br> |
|---|
| 148 | Checkout options: (check) By revision/tab/branch: Version_1_28_0, (check) Do |
|---|
| 149 | not create CVS directories (export)<br> |
|---|
| 150 | <br> |
|---|
| 151 | This results in the follow command: cvs -z9 export -r Version_1_28_0 boost (in |
|---|
| 152 | directory C:\boost\boost_1_28_0)<br> |
|---|
| 153 | <br> |
|---|
| 154 | (takes about ten minutes)<br> |
|---|
| 155 | <br> |
|---|
| 156 | (rename boost-root if needed !!!!!!!!!!!!!!!!!!!)<br> |
|---|
| 157 | </li> |
|---|
| 158 | <li>Export Unix distribution: similar to above, except target is c:\boost\temp\boost_1_28_0 |
|---|
| 159 | and set global for UNIX nl.<br> |
|---|
| 160 | </li> |
|---|
| 161 | <li>!!!!!! VERY IMPORTANT: WinCVS | Set Preferences | Global back to non-UNIX nl. |
|---|
| 162 | !!!!!!!!!!!!!!!<br> |
|---|
| 163 | </li> |
|---|
| 164 | <li>Add regression results web pages into package (new in 1.33 so this is just a shot at the process - jeff)<br> |
|---|
| 165 | download all the regression results from website (may need meta-comm help on this)<br> |
|---|
| 166 | unpack the regression results into tools/regression/latest_release<br> |
|---|
| 167 | <br> |
|---|
| 168 | |
|---|
| 169 | </li> |
|---|
| 170 | <li>General ZIP and TAR.GZ files<br> |
|---|
| 171 | <br> |
|---|
| 172 | n_n_n is 1_28_0 or whatever<br> |
|---|
| 173 | <br> |
|---|
| 174 | cd \boost<br> |
|---|
| 175 | boost_zip 1_21_2 (creates zip.log) <br> |
|---|
| 176 | boost_tar_gz 1_21_2<br> |
|---|
| 177 | bash<br> |
|---|
| 178 | |
|---|
| 179 | gunzip -c boost_1_21_2.tar.gz | bzip2 > boost_1_21_2.tar.bz2<br> |
|---|
| 180 | exit<br> |
|---|
| 181 | </li> |
|---|
| 182 | <li>Upload and unpack the .zip release candidate to a SourceForge web services |
|---|
| 183 | sub-directory. Post a message to the main list asking developers to check |
|---|
| 184 | contents. (Daniel Frey has volunteered to help check).<br> |
|---|
| 185 | </li> |
|---|
| 186 | <li>Upload files for SourceForge release incoming directory using <b>WS_FTP Pro</b><ul> |
|---|
| 187 | <li>Start keep_isdn_awake</li> |
|---|
| 188 | <li>Connection: SourceForge Release Upload | connect</li> |
|---|
| 189 | <li>Select Local system: c:\boost</li> |
|---|
| 190 | <li>Select Remote system: /incoming</li> |
|---|
| 191 | <li>Drag-and-drop the three release files from Local system to Remote system</li> |
|---|
| 192 | <li>Disconnect</li> |
|---|
| 193 | <li>Stop keep_isdn_awake<br> |
|---|
| 194 | </li> |
|---|
| 195 | </ul> |
|---|
| 196 | </li> |
|---|
| 197 | <li>Complete the SourceForge |
|---|
| 198 | <a href="http://sourceforge.net/docman/display_doc.php?docid=6445&group_id=1#createrelease"> |
|---|
| 199 | release procedure</a>.<ul> |
|---|
| 200 | <li>Admin | File Releases | Add Release for package name boost</li> |
|---|
| 201 | <li>New release name: 1.21.2 | create this release</li> |
|---|
| 202 | <li>Step 1: paste in release notes (in HTML). <b>Be sure to note difference |
|---|
| 203 | between .zip and .gz/bz2 files.</b> Submit/Refresh</li> |
|---|
| 204 | <li>Step 2: Check appropriate files. Add Files and/or Refresh View</li> |
|---|
| 205 | <li>Step 3: For each file, select Processor and File Type, Update/Refresh</li> |
|---|
| 206 | <li>Setp 4: Email Release Notice: I'm sure. Send Notice.</li> |
|---|
| 207 | <li>Wait up to 30 minutes.</li> |
|---|
| 208 | <li>Check SourceForge release page and release notes with web browser.<br> |
|---|
| 209 | </li> |
|---|
| 210 | </ul> |
|---|
| 211 | </li> |
|---|
| 212 | <li><i><b>Consider putting up a temporary "Update in progress" root/index.html |
|---|
| 213 | during site update<br> |
|---|
| 214 | </b></i></li> |
|---|
| 215 | <li>Update the web site:<pre>cd ...\boost_1_28_0 |
|---|
| 216 | tar -cf site.tar * |
|---|
| 217 | bzip2 -k site.tar |
|---|
| 218 | |
|---|
| 219 | dir site.tar.bz2 |
|---|
| 220 | pscp site.tar.bz2 beman_dawes@shell1.sourceforge.net:/home/groups/b/bo/boost/htdocs/ |
|---|
| 221 | |
|---|
| 222 | keep_idsn_awake in another window. |
|---|
| 223 | |
|---|
| 224 | c:\bgd\util\putty\plink.exe beman_dawes@shell.sourceforge.net |
|---|
| 225 | cd /home/groups/b/bo/boost/htdocs |
|---|
| 226 | pwd |
|---|
| 227 | ls -l site.tar.bz2 |
|---|
| 228 | |
|---|
| 229 | rm -fr boost |
|---|
| 230 | rm -fr doc |
|---|
| 231 | rm -fr libs |
|---|
| 232 | rm -fr more |
|---|
| 233 | rm -fr people |
|---|
| 234 | rm -fr status |
|---|
| 235 | rm -fr tools |
|---|
| 236 | bunzip2 -kc site.tar.bz2 | tar -x |
|---|
| 237 | ls |
|---|
| 238 | exit |
|---|
| 239 | |
|---|
| 240 | stop keep_isdn_awake</pre> |
|---|
| 241 | </li> |
|---|
| 242 | <li>Check actual <a href="http://www.boost.org">www.boost.org</a> site with |
|---|
| 243 | browser. Look at a bunch of files that should have been updated to make sure |
|---|
| 244 | the updates actually "took".<br> |
|---|
| 245 | </li> |
|---|
| 246 | <li>Post a message announcing the release and recapping "Latest News". |
|---|
| 247 | Post as separate messages to: boost, boost-announce, boost-users, |
|---|
| 248 | comp.lang.c++.moderated, |
|---|
| 249 | <a href="mailto:c++std-news@research.att.com">c++std-news@research.att.com</a><br> |
|---|
| 250 | </li> |
|---|
| 251 | <li>Using the SourceForge shell services (sf_shell_svc.bat), cd /home/groups/b/bo/boost/htdocs, |
|---|
| 252 | and rename regression tests as necessary.<br> |
|---|
| 253 | </li> |
|---|
| 254 | <li>Burn "Key Directories" CD for off-site backup.<br> |
|---|
| 255 | </li> |
|---|
| 256 | <li>Make sure CVS working copy is updated to main branch!<br> |
|---|
| 257 | </li> |
|---|
| 258 | <li>Ready <i><b>root/index.htm</b></i>, <i><b>root/boost/version.hpp</b></i>, <b>root/Jamfile.v2</b> and |
|---|
| 259 | <i><b>root/Jamrules</b></i> for the |
|---|
| 260 | next release and commit to CVS so developers have a place to add "Latest news" |
|---|
| 261 | blurbs.<br> |
|---|
| 262 | </li> |
|---|
| 263 | <li>Delete obsolete files from yahoogroups files section.</li> |
|---|
| 264 | </ul> |
|---|
| 265 | <hr> |
|---|
| 266 | <p>Revised: |
|---|
| 267 | <!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->21 November, 2005<!--webbot bot="Timestamp" endspan i-checksum="40405" --></p> |
|---|
| 268 | <p>© Copyright Beman Dawes 2001</p> |
|---|
| 269 | |
|---|
| 270 | <p>Distributed under the Boost Software License, Version 1.0. (See accompanying |
|---|
| 271 | file <a href="../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or copy at |
|---|
| 272 | <a href="http://www.boost.org/LICENSE_1_0.txt">http://www.boost.org/LICENSE_1_0.txt</a>)</p> |
|---|
| 273 | |
|---|
| 274 | </body> |
|---|
| 275 | |
|---|
| 276 | </html> |
|---|
