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