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