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