CHECKLST.txt

   1 Checklists for PuTTY administrative procedures
   2 ==============================================
   3
   4 Locations of the licence
   5 ------------------------
   6
   7 The PuTTY copyright notice and licence are stored in quite a few
   8 places. At the start of a new year, the copyright year needs
   9 updating in all of them; and when someone sends a massive patch,
  10 their name needs adding in all of them too.
  11
  12 The LICENCE file in the main source distribution:
  13
  14  - putty/LICENCE
  15
  16 The resource files:
  17
  18  - putty/windows/pageant.rc
  19     + the copyright date appears twice, once in the About box and
  20       once in the Licence box. Don't forget to change both!
  21  - putty/windows/puttygen.rc
  22     + the copyright date appears twice, once in the About box and
  23       once in the Licence box. Don't forget to change both!
  24  - putty/windows/win_res.rc2
  25     + the copyright date appears twice, once in the About box and
  26       once in the Licence box. Don't forget to change both!
  27  - putty/windows/version.rc2
  28     + the copyright date appears once only.
  29  - putty/mac/mac_res.r
  30     + the copyright date appears twice, once in the About box and
  31       once in the Licence box. Don't forget to change both!
  32  - putty/mac/macpgen.r
  33     + the copyright date appears twice, once in the About box and
  34       once in the Licence box. Don't forget to change both!
  35  - putty/unix/gtkdlg.c
  36     + the copyright date appears twice, once in the About box and
  37       once in the Licence box. Don't forget to change both!
  38
  39 The documentation (both the preamble blurb and the licence appendix):
  40
  41  - putty/doc/blurb.but
  42  - putty/doc/licence.but
  43
  44 The website:
  45
  46  - putty-website/licence.html
  47
  48 Before tagging a release
  49 ------------------------
  50
  51  - First of all, go through the source (including the documentation),
  52    and the website, and review anything tagged with a comment
  53    containing the word XXX-REVIEW-BEFORE-RELEASE.
  54    (Any such comments should state clearly what needs to be done.)
  55
  56 For a long time we got away with never checking the current version
  57 number in at all - all version numbers were passed into the build
  58 system on the compiler command line, and the _only_ place version
  59 numbers showed up in the source files was in the tag information.
  60
  61 Unfortunately, those halcyon days are gone, and we do need the
  62 version number checked in in a couple of places. These must be updated
  63 _before_ tagging a new release.
  64
  65 The file used to generate the Unix snapshot version numbers (which
  66 are <previousrelease>-<date> so that the Debian versioning system
  67 orders them correctly with respect to releases):
  68
  69  - putty/LATEST.VER
  70
  71 The Windows installer script (_four_ times, on consecutive lines):
  72
  73  - putty/windows/putty.iss
  74
  75 The Windows resource file (used to generate the binary bit of the
  76 VERSIONINFO resources -- the strings are supplied by the usual means):
  77
  78  - putty/windows/version.rc2 (BASE_VERSION; NB, _comma_-separated)
  79
  80 The Mac resource file (used to generate the binary bit of the 'vers'
  81 resources):
  82
  83  - putty/mac/version.r
  84
  85 It might also be worth going through the documentation looking for
  86 version numbers - we have a couple of transcripts showing the help
  87 text from the command-line tools, and it would be nice to ensure the
  88 whole transcripts (certainly including the version numbers) are up
  89 to date. Sometimes these are marked in between releases as `0.XX', so
  90 it's worth grepping for that too.
  91
  92  - putty/doc/pscp.but
  93  - putty/doc/plink.but
  94  - putty/doc/psftp.but (in case it ever acquires a similar thing)
  95
  96 The actual release procedure
  97 ----------------------------
  98
  99 This is the procedure I (SGT) currently follow (or _should_ follow
 100 :-) when actually making a release, once I'm happy with the position
 101 of the tag.
 102
 103  - Double-check that we have removed anything tagged with a comment
 104    containing the word XXX-REMOVE-BEFORE-RELEASE.
 105
 106  - Write a release announcement (basically a summary of the changes
 107    since the last release). Squirrel it away in
 108    ixion:src/putty/local/announce-<ver> in case it's needed again
 109    within days of the release going out.
 110
 111  - On my local machines, check out the release-tagged version of the
 112    sources. Do this in a _clean_ directory; don't depend on my usual
 113    source dir.
 114     + Make sure to run mkfiles.pl _after_ this checkout, just in
 115       case.
 116
 117  - Build the source archives now, while the directory is still
 118    pristine.
 119     + run ./mksrcarc.sh to build the Windows source zip.
 120     + run `./mkunxarc.sh X.YZ' to build the Unix tarball.
 121
 122  - Build the Windows/x86 release binaries. Don't forget to supply
 123    VER=/DRELEASE=<ver>. Run them, or at least one or two of them, to
 124    ensure that they really do report their version number correctly,
 125    and sanity-check the version info reported on the files by Windows.
 126     + Save the release link maps. Currently I keep these on ixion,
 127       in src/putty/local/maps-<version>.
 128
 129  - Acquire the Windows/alpha release binaries from Owen.
 130     + Verify the signatures on these, to ensure they're really the
 131       ones he built. If I'm going to sign a zip file I make out of
 132       these, I'm damn well going to make sure the binaries that go
 133       _into_ it are signed themselves.
 134     + Make sure Owen has kept the Alpha release link maps somewhere
 135       useful.
 136
 137  - Run Halibut to build the docs. Define VERSION on the make command
 138    line to override the version strings, since Subversion revision
 139    numbers are less meaningful on a tag.
 140     + make -C doc VERSION="PuTTY release 0.XX"
 141
 142  - Build the binary archives putty.zip (one for each architecture):
 143    each one just contains all the .exe files except PuTTYtel, and
 144    the .hlp and .cnt files.
 145     + zip -k putty.zip `ls *.exe | grep -v puttytel` putty.hlp putty.cnt
 146     + same again for Alpha.
 147
 148  - Build the docs archive puttydoc.zip: it contains all the HTML
 149    files output from Halibut.
 150     + zip puttydoc.zip *.html
 151
 152  - Build the installer.
 153
 154  - Sign the release (gpg --detach-sign).
 155     + Sign the locally built x86 binaries, the locally built x86
 156       binary zipfile, and the locally built x86 installer, with the
 157       release keys.
 158     + The Alpha binaries should already have been signed with the
 159       release keys. Having checked that, sign the Alpha binary
 160       zipfile with the release keys too.
 161     + The source archive should be signed with the release keys.
 162     + Don't forget to sign with both DSA and RSA keys for absolutely
 163       everything.
 164       for i in <filenames>; do for t in DSA RSA; do gpg --load-extension=idea --detach-sign -u "Releases ($t)" -o $i.$t $i; done; done
 165
 166  - Begin to pull together the release directory structure.
 167     + subdir `x86' containing the x86 binaries, x86 binary zip, x86
 168       installer, and all signatures on the above.
 169     + subdir `alpha' containing the Alpha binaries, Alpha binary
 170       zip, and all signatures on the above.
 171     + top-level dir contains the Windows source zip (plus
 172       signatures), the Unix source tarball (plus signatures),
 173       puttydoc.txt, the .hlp and .cnt files, and puttydoc.zip.
 174
 175  - Create subdir `htmldoc' in the release directory, which should
 176    contain exactly the same set of HTML files that went into
 177    puttydoc.zip.
 178     + It also needs a copy of sitestyle.css, because the online
 179       versions of the HTML docs will link to this (although the
 180       zipped form should be self-contained).
 181
 182  - Create and sign md5sums files: one in the x86 subdir, one in the
 183    alpha subdir, and one in the parent dir of both of those.
 184     + The md5sums files need not list the .DSA and .RSA signatures,
 185       and the top-level md5sums need not list the other two. Easiest
 186       thing is to run, in each directory, this command:
 187       md5sum `\find * -name '*SA' -o -type f -print` > md5sums
 188     + Sign the md5sums files (gpg --clearsign).
 189       for i in md5sums */md5sums; do for t in DSA RSA; do gpg --load-extension=idea --clearsign -u "Releases ($t)" -o $i.$t $i; done; done
 190
 191  - Now double-check by verifying all the signatures on all the
 192    files, and running md5sum -c on all the md5sums files.
 193
 194  - Now the whole release directory should be present and correct.
 195    Upload to ixion:www/putty/<ver>.
 196
 197  - Do final checks on the release directory:
 198     + verify all the signatures. In each directory:
 199       for i in *.*SA; do case $i in md5sums*) gpg --verify $i;; *) gpg --verify $i `echo $i | sed 's/\..SA$//'`;; esac; done
 200     + check the md5sums. In each directory:
 201       md5sum -c md5sums
 202
 203  - Having double-checked the release, copy it from ixion to
 204    chiark:ftp/putty-<ver> and to the:www/putty/<ver>.
 205
 206  - Check the permissions! Actually try downloading from the, to make
 207    sure it really works.
 208
 209  - Update the HTTP redirects.
 210     + Update the one at the:www/putty/htaccess which points the
 211       virtual subdir `latest' at the actual latest release dir. TEST
 212       THIS ONE - it's quite important.
 213     + ixion:www/putty/.htaccess has an individual redirect for each
 214       version number. Add a new one.
 215
 216  - Update the FTP symlink (chiark:ftp/putty-latest -> putty-<ver>).
 217
 218  - Update web site.
 219    + Adjust front page (`the latest version is <ver>').
 220    + Adjust Download page similarly.
 221    + Adjust filenames of installer and Unix tarball on links in
 222      Download page.
 223    + Adjust header text on Changelog page. (That includes changing
 224      `are new' in previous version to `were new'!)
 225
 226  - Update the wishlist. This can be done without touching individual
 227    items by editing the @releases array in control/bugs2html.
 228
 229  - Check the Docs page links correctly to the release docs. (It
 230    should do this automatically, owing to the `latest' HTTP
 231    redirect.)
 232
 233  - Check that the web server attaches the right content type to .HLP
 234    and .CNT files.
 235
 236  - Run webupdate, so that all the changes on ixion propagate to
 237    chiark. Important to do this _before_ announcing that the release
 238    is available.
 239     * Don't forget to create the new directories on chiark -
 240       ~/www/putty/<ver>{,/x86,/alpha,/htmldoc} - before running
 241       webupdate.
 242
 243  - After running webupdate, run update-rsync on chiark and verify
 244    that the rsync mirror package correctly identifies the new
 245    version.
 246
 247  - Announce the release!
 248     + Mail the announcement to putty-announce.
 249        * Set a Reply-To on the mail so that people don't keep
 250          replying to my personal address.
 251     + Post it to comp.security.ssh.
 252     + Mention it in <TDHTT> on mono.
 253
 254  - Relax (slightly).
 255
 256 After the release
 257 -----------------
 258
 259 The following want doing some time soon after a release has been made:
 260
 261  - If the release was made from a branch, make sure the version number
 262    on the _trunk_ is up to date in all the locations listed above, so
 263    that (e.g.) Unix snapshots come out right.