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 For a long time we got away with never checking the current version
  45 number into CVS at all - all version numbers were passed into the
  46 build system on the compiler command line, and the _only_ place
  47 version numbers showed up in CVS was in the tag information.
  48
  49 Unfortunately, those halcyon days are gone, and we do need the
  50 version number in CVS in a couple of places. These must be updated
  51 _before_ tagging a new release.
  52
  53 The file used to generate the Unix snapshot version numbers (which
  54 are <previousrelease>-<date> so that the Debian versioning system
  55 orders them correctly with respect to releases):
  56
  57  - putty/LATEST.VER
  58
  59 The Windows installer script:
  60
  61  - putty/putty.iss
  62
  63 The Mac resource file (used to generate the binary bit of the 'vers'
  64 resources -- the strings are supplied by the usual means):
  65
  66  - putty/mac/version.r
  67
  68 It might also be worth going through the documentation looking for
  69 version numbers - we have a couple of transcripts showing the help
  70 text from the command-line tools, and it would be nice to ensure the
  71 whole transcripts (certainly including the version numbers) are up
  72 to date.
  73
  74  - putty/doc/pscp.but
  75  - putty/doc/plink.but
  76  - putty/doc/psftp.but (in case it ever acquires a similar thing)
  77
  78 The actual release procedure
  79 ----------------------------
  80
  81 This is the procedure I (SGT) currently follow (or _should_ follow
  82 :-) when actually making a release, once I'm happy with the position
  83 of the tag.
  84
  85  - Write a release announcement (basically a summary of the changes
  86    since the last release). Squirrel it away in
  87    ixion:src/putty/local/announce-<ver> in case it's needed again
  88    within days of the release going out.
  89
  90  - On my local machines, check out the release-tagged version of the
  91    sources.
  92     + Make sure to run mkfiles.pl _after_ this checkout, just in
  93       case.
  94
  95  - Build the Windows/x86 release binaries. Don't forget to supply
  96    VER=/DRELEASE=<ver>. Run them, or at least one or two of them, to
  97    ensure that they really do report their version number correctly.
  98     + Save the release link maps. Currently I keep these on ixion,
  99       in src/putty/local/maps-<version>.
 100
 101  - Acquire the Windows/alpha release binaries from Owen.
 102     + Verify the snapshot-key signatures on these, to ensure they're
 103       really the ones he built. If I'm going to snapshot-sign a zip
 104       file I make out of these, I'm damn well going to make sure the
 105       binaries that go _into_ it were snapshot-signed themselves.
 106     + Make sure Owen has kept the Alpha release link maps somewhere
 107       useful.
 108
 109  - Run Halibut to build the docs.
 110
 111  - Build the .zip files.
 112     + The binary archive putty.zip just contains all the .exe files
 113       except PuTTYtel, and the .hlp and .cnt files.
 114     + The source archive putty-src.zip is built by puttysnap.sh (my
 115       cron script that also builds the nightly snapshot source
 116       archive).
 117     + The docs archive puttydoc.zip contains all the HTML files
 118       output from Halibut.
 119
 120  - Build the installer.
 121
 122  - Sign the release (gpg --detach-sign).
 123     + Sign the locally built x86 binaries, the locally built x86
 124       binary zipfile, and the locally built x86 installer, with the
 125       release keys.
 126     + The Alpha binaries should already have been signed with the
 127       snapshot keys. Having checked that, sign the Alpha binary
 128       zipfile with the snapshot keys too.
 129     + The source archive should be signed with the release keys.
 130       This was the most fiddly bit of the last release I did: the
 131       script that built the source archive was on ixion, so I had to
 132       bring the archive back to my local machine, check everything
 133       in it was untampered-with, and _then_ sign it. Perhaps next
 134       time I should arrange that puttysnap.sh can run on my local
 135       box; it'd be a lot easier.
 136     + Don't forget to sign with both DSA and RSA keys for absolutely
 137       everything.
 138
 139  - Begin to pull together the release directory structure.
 140     + subdir `x86' containing the x86 binaries, x86 binary zip, x86
 141       installer, and all signatures on the above.
 142     + subdir `alpha' containing the Alpha binaries, Alpha binary
 143       zip, and all signatures on the above.
 144     + top-level dir contains the source zip (plus signatures),
 145       puttydoc.txt, the .hlp and .cnt files, and puttydoc.zip.
 146
 147  - Create and sign md5sums files: one in the x86 subdir, one in the
 148    alpha subdir, and one in the parent dir of both of those.
 149     + The md5sums files need not list the .DSA and .RSA signatures,
 150       and the top-level md5sums need not list the other two.
 151     + Sign the md5sums files (gpg --clearsign). The Alpha md5sums
 152       should be signed with the snapshot keys, but the other two
 153       with the release keys (yes, the top-level one includes some
 154       Alpha files, but I think people will understand).
 155
 156  - Now double-check by verifying all the signatures on all the
 157    files.
 158
 159  - Create subdir `htmldoc' in the release directory, which should
 160    contain exactly the same set of HTML files that went into
 161    puttydoc.zip.
 162     + It also needs a copy of sitestyle.css, because the online
 163       versions of the HTML docs will link to this (although the
 164       zipped form should be self-contained).
 165
 166  - Now the whole release directory should be present and correct.
 167    Upload to ixion:www/putty/<ver>, upload to
 168    chiark:ftp/putty-<ver>, and upload to the:www/putty/<ver>.
 169
 170  - Update the HTTP redirects.
 171     + Update the one at the:www/putty/htaccess which points the
 172       virtual subdir `latest' at the actual latest release dir. TEST
 173       THIS ONE - it's quite important.
 174     + ixion:www/putty/.htaccess has an individual redirect for each
 175       version number. Add a new one.
 176
 177  - Update the FTP symlink (chiark:ftp/putty-latest -> putty-<ver>).
 178
 179  - Update web site.
 180    + Adjust front page (`the latest version is <ver>').
 181    + Adjust Download page similarly.
 182    + Adjust filename of installer on links in Download page.
 183    + Adjust header text on Changelog page. (That includes changing
 184      `are new' in previous version to `were new'!)
 185
 186  - Check the Docs page links correctly to the release docs. (It
 187    should do this automatically, owing to the `latest' HTTP
 188    redirect.)
 189
 190  - Check that the web server attaches the right content type to .HLP
 191    and .CNT files.
 192
 193  - Run webupdate, so that all the changes on ixion propagate to
 194    chiark. Important to do this _before_ announcing that the release
 195    is available.
 196
 197  - Announce the release!
 198     + Mail the announcement to putty-announce.
 199     + Post it to comp.security.ssh.
 200     + Mention it in <TDHIS> on mono.
 201
 202  - All done. Probably best to run `cvs up -A' now, or I'll only
 203    forget in a few days' time and get confused...