doc/guide/localhost/ReleaseChecklist

   1 <!DOCTYPE html>
   2 <html lang="en">
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <meta name="generator" content="AsciiDoc 8.6.9">
   6 <title>ReleaseChecklist</title>
   7 <link rel="stylesheet" href="./asciidoc.css" type="text/css">
   8 <link rel="stylesheet" href="./pygments.css" type="text/css">
   9
  10
  11 <script type="text/javascript" src="./asciidoc.js"></script>
  12 <script type="text/javascript">
  13 /*<![CDATA[*/
  14 asciidoc.install();
  15 /*]]>*/
  16 </script>
  17 <link rel="stylesheet" href="./mlton.css" type="text/css">
  18 </head>
  19 <body class="article">
  20 <div id="banner">
  21 <div id="banner-home">
  22 <a href="./Home">MLton 20180207</a>
  23 </div>
  24 </div>
  25 <div id="header">
  26 <h1>ReleaseChecklist</h1>
  27 </div>
  28 <div id="content">
  29 <div class="sect1">
  30 <h2 id="_advance_preparation_for_release">Advance preparation for release</h2>
  31 <div class="sectionbody">
  32 <div class="ulist"><ul>
  33 <li>
  34 <p>
  35 Update <span class="monospaced">./CHANGELOG.adoc</span>.
  36 </p>
  37 <div class="ulist"><ul>
  38 <li>
  39 <p>
  40 Write entries for missing notable commits.
  41 </p>
  42 </li>
  43 <li>
  44 <p>
  45 Write summary of changes from previous release.
  46 </p>
  47 </li>
  48 <li>
  49 <p>
  50 Update with estimated release date.
  51 </p>
  52 </li>
  53 </ul></div>
  54 </li>
  55 <li>
  56 <p>
  57 Update <span class="monospaced">./README.adoc</span>.
  58 </p>
  59 <div class="ulist"><ul>
  60 <li>
  61 <p>
  62 Check features and description.
  63 </p>
  64 </li>
  65 </ul></div>
  66 </li>
  67 <li>
  68 <p>
  69 Update <span class="monospaced">man/{mlton,mlprof}.1</span>.
  70 </p>
  71 <div class="ulist"><ul>
  72 <li>
  73 <p>
  74 Check compile-time and run-time options in <span class="monospaced">man/mlton.1</span>.
  75 </p>
  76 </li>
  77 <li>
  78 <p>
  79 Check options in <span class="monospaced">man/mlprof.1</span>.
  80 </p>
  81 </li>
  82 <li>
  83 <p>
  84 Update with estimated release date.
  85 </p>
  86 </li>
  87 </ul></div>
  88 </li>
  89 <li>
  90 <p>
  91 Update <span class="monospaced">doc/guide</span>.
  92 </p>
  93 <div class="ulist"><ul>
  94 <li>
  95 <p>
  96 Synchronize <a href="Features">Features</a> page with <span class="monospaced">./README.adoc</span>.
  97 </p>
  98 </li>
  99 <li>
 100 <p>
 101 Update <a href="Credits">Credits</a> page with acknowledgements.
 102 </p>
 103 </li>
 104 <li>
 105 <p>
 106 Create <strong>ReleaseYYYYMM??</strong> page (i.e., forthcoming release) based on <strong>ReleaseXXXXLLCC</strong> (i.e., previous release).
 107 </p>
 108 <div class="ulist"><ul>
 109 <li>
 110 <p>
 111 Update summary from <span class="monospaced">./CHANGELOG.adoc</span>.
 112 </p>
 113 </li>
 114 <li>
 115 <p>
 116 Update links to estimated release date.
 117 </p>
 118 </li>
 119 </ul></div>
 120 </li>
 121 <li>
 122 <p>
 123 Create <strong>BugsYYYYMM??</strong> page based on <strong>BugsXXXXLLCC</strong>.
 124 </p>
 125 <div class="ulist"><ul>
 126 <li>
 127 <p>
 128 Update links to estimated release date.
 129 </p>
 130 </li>
 131 </ul></div>
 132 </li>
 133 <li>
 134 <p>
 135 Spell check pages.
 136 </p>
 137 </li>
 138 </ul></div>
 139 </li>
 140 <li>
 141 <p>
 142 Ensure that all updates are pushed to <span class="monospaced">master</span> branch of <a href="https://github.com/MLton/mlton"><span class="monospaced">mlton</span></a>.
 143 </p>
 144 </li>
 145 </ul></div>
 146 </div>
 147 </div>
 148 <div class="sect1">
 149 <h2 id="_prepare_sources_for_tagging">Prepare sources for tagging</h2>
 150 <div class="sectionbody">
 151 <div class="ulist"><ul>
 152 <li>
 153 <p>
 154 Update <span class="monospaced">./CHANGELOG.adoc</span>.
 155 </p>
 156 <div class="ulist"><ul>
 157 <li>
 158 <p>
 159 Update with proper release date.
 160 </p>
 161 </li>
 162 </ul></div>
 163 </li>
 164 <li>
 165 <p>
 166 Update <span class="monospaced">man/{mlton,mlprof}.1</span>.
 167 </p>
 168 <div class="ulist"><ul>
 169 <li>
 170 <p>
 171 Update with proper release date.
 172 </p>
 173 </li>
 174 </ul></div>
 175 </li>
 176 <li>
 177 <p>
 178 Update <span class="monospaced">doc/guide</span>.
 179 </p>
 180 <div class="ulist"><ul>
 181 <li>
 182 <p>
 183 Rename <strong>ReleaseYYYYMM??</strong> to <strong>ReleaseYYYYMMDD</strong> with proper release date.
 184 </p>
 185 <div class="ulist"><ul>
 186 <li>
 187 <p>
 188 Update links with proper release date.
 189 </p>
 190 </li>
 191 </ul></div>
 192 </li>
 193 <li>
 194 <p>
 195 Rename <strong>BugsYYYYMM??</strong> to <strong>BugsYYYYMMDD</strong> with proper release date.
 196 </p>
 197 <div class="ulist"><ul>
 198 <li>
 199 <p>
 200 Update links with proper release date.
 201 </p>
 202 </li>
 203 </ul></div>
 204 </li>
 205 <li>
 206 <p>
 207 Update <strong>ReleaseXXXXLLCC</strong>.
 208 </p>
 209 <div class="ulist"><ul>
 210 <li>
 211 <p>
 212 Change intro to "<span class="monospaced">This is an archived public release of MLton, version XXXXLLCC.</span>"
 213 </p>
 214 </li>
 215 </ul></div>
 216 </li>
 217 <li>
 218 <p>
 219 Update <a href="Home">Home</a> with note of new release.
 220 </p>
 221 <div class="ulist"><ul>
 222 <li>
 223 <p>
 224 Change <span class="monospaced">What's new?</span> text to <span class="monospaced">Please try out our new release, &lt;:ReleaseYYYYMMDD:MLton YYYYMMDD&gt;</span>.
 225 </p>
 226 </li>
 227 <li>
 228 <p>
 229 Update <span class="monospaced">Download</span> link with proper release date.
 230 </p>
 231 </li>
 232 </ul></div>
 233 </li>
 234 <li>
 235 <p>
 236 Update <a href="Releases">Releases</a> with new release.
 237 </p>
 238 </li>
 239 </ul></div>
 240 </li>
 241 <li>
 242 <p>
 243 Ensure that all updates are pushed to <span class="monospaced">master</span> branch of <a href="https://github.com/MLton/mlton"><span class="monospaced">mlton</span></a>.
 244 </p>
 245 </li>
 246 </ul></div>
 247 </div>
 248 </div>
 249 <div class="sect1">
 250 <h2 id="_tag_sources">Tag sources</h2>
 251 <div class="sectionbody">
 252 <div class="ulist"><ul>
 253 <li>
 254 <p>
 255 Shell commands:
 256 </p>
 257 <div class="listingblock">
 258 <div class="content monospaced">
 259 <pre>git clone http://github.com/MLton/mlton mlton.git
 260 cd mlton.git
 261 git checkout master
 262 git tag -a -m "Tagging YYYYMMDD release" on-YYYYMMDD-release master
 263 git push origin on-YYYYMMDD-release</pre>
 264 </div></div>
 265 </li>
 266 </ul></div>
 267 </div>
 268 </div>
 269 <div class="sect1">
 270 <h2 id="_packaging">Packaging</h2>
 271 <div class="sectionbody">
 272 <div class="sect2">
 273 <h3 id="_sourceforge_frs">SourceForge FRS</h3>
 274 <div class="ulist"><ul>
 275 <li>
 276 <p>
 277 Create <strong>YYYYMMDD</strong> directory:
 278 </p>
 279 <div class="listingblock">
 280 <div class="content monospaced">
 281 <pre>sftp user@frs.sourceforge.net:/home/frs/project/mlton/mlton
 282 sftp&gt; mkdir YYYYMMDD
 283 sftp&gt; quit</pre>
 284 </div></div>
 285 </li>
 286 </ul></div>
 287 </div>
 288 <div class="sect2">
 289 <h3 id="_source_release">Source release</h3>
 290 <div class="ulist"><ul>
 291 <li>
 292 <p>
 293 Create <span class="monospaced">mlton-YYYYMMDD.src.tgz</span>:
 294 </p>
 295 <div class="listingblock">
 296 <div class="content monospaced">
 297 <pre>git clone http://github.com/MLton/mlton mlton
 298 cd mlton
 299 git checkout on-YYYYMMDD-release
 300 make MLTON_VERSION=YYYYMMDD source-release
 301 cd ..</pre>
 302 </div></div>
 303 <div class="paragraph"><p>or</p></div>
 304 <div class="listingblock">
 305 <div class="content monospaced">
 306 <pre>wget https://github.com/MLton/mlton/archive/on-YYYYMMDD-release.tar.gz
 307 tar xzvf on-YYYYMMDD-release.tar.gz
 308 cd mlton-on-YYYYMMDD-release
 309 make MLTON_VERSION=YYYYMMDD source-release
 310 cd ..</pre>
 311 </div></div>
 312 </li>
 313 <li>
 314 <p>
 315 Upload <span class="monospaced">mlton-YYYYMMDD.src.tgz</span>:
 316 </p>
 317 <div class="listingblock">
 318 <div class="content monospaced">
 319 <pre>scp mlton-YYYYMMDD.src.tgz user@frs.sourceforge.net:/home/frs/project/mlton/mlton/YYYYMMDD/</pre>
 320 </div></div>
 321 </li>
 322 <li>
 323 <p>
 324 Update <strong>ReleaseYYYYMMDD</strong> with <span class="monospaced">mlton-YYYYMMDD.src.tgz</span> link.
 325 </p>
 326 </li>
 327 </ul></div>
 328 </div>
 329 <div class="sect2">
 330 <h3 id="_binary_releases">Binary releases</h3>
 331 <div class="ulist"><ul>
 332 <li>
 333 <p>
 334 Build and create <span class="monospaced">mlton-YYYYMMDD-1.ARCH-OS.tgz</span>:
 335 </p>
 336 <div class="listingblock">
 337 <div class="content monospaced">
 338 <pre>wget http://sourceforge.net/projects/mlton/files/mlton/YYYYMMDD/mlton-YYYYMMDD.src.tgz
 339 tar xzvf mlton-YYYYMMDD.src.tgz
 340 cd mlton-YYYYMMDD
 341 make binary-release
 342 cd ..</pre>
 343 </div></div>
 344 </li>
 345 <li>
 346 <p>
 347 Upload <span class="monospaced">mlton-YYYYMMDD-1.ARCH-OS.tgz</span>:
 348 </p>
 349 <div class="listingblock">
 350 <div class="content monospaced">
 351 <pre>scp mlton-YYYYMMDD-1.ARCH-OS.tgz user@frs.sourceforge.net:/home/frs/project/mlton/mlton/YYYYMMDD/</pre>
 352 </div></div>
 353 </li>
 354 <li>
 355 <p>
 356 Update <strong>ReleaseYYYYMMDD</strong> with <span class="monospaced">mlton-YYYYMMDD-1.ARCH-OS.tgz</span> link.
 357 </p>
 358 </li>
 359 </ul></div>
 360 </div>
 361 </div>
 362 </div>
 363 <div class="sect1">
 364 <h2 id="_website">Website</h2>
 365 <div class="sectionbody">
 366 <div class="ulist"><ul>
 367 <li>
 368 <p>
 369 <span class="monospaced">guide/YYYYMMDD</span> gets a copy of <span class="monospaced">doc/guide/localhost</span>.
 370 </p>
 371 </li>
 372 <li>
 373 <p>
 374 Shell commands:
 375 </p>
 376 <div class="listingblock">
 377 <div class="content monospaced">
 378 <pre>wget http://sourceforge.net/projects/mlton/files/mlton/YYYYMMDD/mlton-YYYYMMDD.src.tgz
 379 tar xzvf mlton-YYYYMMDD.src.tgz
 380 cd mlton-YYYYMMDD
 381 cd doc/guide
 382 cp -prf localhost YYYYMMDD
 383 tar czvf guide-YYYYMMDD.tgz YYYYMMDD
 384 rsync -avzP --delete -e ssh YYYYMMDD user@web.sourceforge.net:/home/project-web/mlton/htdocs/guide/
 385 rsync -avzP --delete -e ssh guide-YYYYMMDD.tgz user@web.sourceforge.net:/home/project-web/mlton/htdocs/guide/</pre>
 386 </div></div>
 387 </li>
 388 </ul></div>
 389 </div>
 390 </div>
 391 <div class="sect1">
 392 <h2 id="_announce_release">Announce release</h2>
 393 <div class="sectionbody">
 394 <div class="ulist"><ul>
 395 <li>
 396 <p>
 397 Mail announcement to:
 398 </p>
 399 <div class="ulist"><ul>
 400 <li>
 401 <p>
 402 <a href="mailto:MLton-devel@mlton.org"><span class="monospaced">MLton-devel@mlton.org</span></a>
 403 </p>
 404 </li>
 405 <li>
 406 <p>
 407 <a href="mailto:MLton-user@mlton.org"><span class="monospaced">MLton-user@mlton.org</span></a>
 408 </p>
 409 </li>
 410 </ul></div>
 411 </li>
 412 </ul></div>
 413 </div>
 414 </div>
 415 <div class="sect1">
 416 <h2 id="_misc">Misc.</h2>
 417 <div class="sectionbody">
 418 <div class="ulist"><ul>
 419 <li>
 420 <p>
 421 Generate new <a href="Performance">Performance</a> numbers.
 422 </p>
 423 </li>
 424 </ul></div>
 425 </div>
 426 </div>
 427 </div>
 428 <div id="footnotes"><hr></div>
 429 <div id="footer">
 430 <div id="footer-text">
 431 </div>
 432 <div id="footer-badges">
 433 </div>
 434 </div>
 435 </body>
 436 </html>