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 words XXX-REMOVE-BEFORE-RELEASE or
 105    XXX-REVIEW-BEFORE-RELEASE.
 106
 107  - Write a release announcement (basically a summary of the changes
 108    since the last release). Squirrel it away in
 109    ixion:src/putty/local/announce-<ver> in case it's needed again
 110    within days of the release going out.
 111
 112  - On my local machines, check out the release-tagged version of the
 113    sources. Do this in a _clean_ directory; don't depend on my usual
 114    source dir.
 115     + Make sure to run mkfiles.pl _after_ this checkout, just in
 116       case.
 117
 118  - Build the source archives now, while the directory is still
 119    pristine.
 120     + run ./mksrcarc.sh to build the Windows source zip.
 121     + run `./mkunxarc.sh X.YZ' to build the Unix tarball.
 122
 123  - Build the Windows/x86 release binaries. Don't forget to supply
 124    VER=/DRELEASE=<ver>. Run them, or at least one or two of them, to
 125    ensure that they really do report their version number correctly,
 126    and sanity-check the version info reported on the files by Windows.
 127     + Save the release link maps. Currently I keep these on ixion,
 128       in src/putty/local/maps-<version>.
 129
 130  - Run Halibut to build the docs. Define VERSION on the make command
 131    line to override the version strings, since Subversion revision
 132    numbers are less meaningful on a tag.
 133     + change into the doc subdir
 134     + run `make VERSION="PuTTY release 0.XX" chm', then run `hhc
 135       putty.hhp' to build the .CHM
 136     + then run `make mostlyclean' (destroys the hhc input files but
 137       _not_ the .CHM)
 138     + then `make VERSION="PuTTY release 0.XX"'
 139
 140  - Build the binary archive putty.zip: all the .exe files except
 141    PuTTYtel, and the .hlp, .cnt and .chm files.
 142     + zip -k putty.zip `ls *.exe | grep -v puttytel` putty.hlp putty.cnt putty.chm
 143
 144  - Build the docs archive puttydoc.zip: it contains all the HTML
 145    files output from Halibut.
 146     + zip puttydoc.zip *.html
 147
 148  - Build the installer.
 149
 150  - Sign the release (gpg --detach-sign).
 151     + Sign the locally built x86 binaries, the locally built x86
 152       binary zipfile, and the locally built x86 installer, with the
 153       release keys.
 154     + The source archive should be signed with the release keys.
 155     + Don't forget to sign with both DSA and RSA keys for absolutely
 156       everything.
 157       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
 158
 159  - Begin to pull together the release directory structure.
 160     + subdir `x86' containing the x86 binaries, x86 binary zip, x86
 161       installer, and all signatures on the above.
 162     + top-level dir contains the Windows source zip (plus
 163       signatures), the Unix source tarball (plus signatures),
 164       puttydoc.txt, the .hlp, .cnt and .chm files, and puttydoc.zip.
 165
 166  - Create subdir `htmldoc' in the release directory, which should
 167    contain exactly the same set of HTML files that went into
 168    puttydoc.zip.
 169     + It also needs a copy of sitestyle.css, because the online
 170       versions of the HTML docs will link to this (although the
 171       zipped form should be self-contained).
 172
 173  - Create and sign an md5sums file in the top-level directory.
 174     + The md5sums files need not list the .DSA and .RSA signatures.
 175       Easiest thing is to run this command:
 176       md5sum `\find * -name '*SA' -o -type f -print` > md5sums
 177     + Sign the md5sums file (gpg --clearsign).
 178       for t in DSA RSA; do gpg --load-extension=idea --clearsign -u "Releases ($t)" -o md5sums.$t md5sums; done
 179
 180  - Now double-check by verifying all the signatures on all the
 181    files, and running md5sum -c on the md5sums file.
 182
 183  - Now the whole release directory should be present and correct.
 184    Upload to ixion:www/putty/<ver>.
 185
 186  - Do final checks on the release directory:
 187     + verify all the signatures. In each directory:
 188       for i in *.*SA; do case $i in md5sums*) gpg --verify $i;; *) gpg --verify $i `echo $i | sed 's/\..SA$//'`;; esac; done
 189     + check the md5sums:
 190       md5sum -c md5sums
 191
 192  - Having double-checked the release, copy it from ixion to
 193    chiark:ftp/putty-<ver> and to the:www/putty/<ver>.
 194
 195  - Check the permissions! Actually try downloading from the, to make
 196    sure it really works.
 197
 198  - Update the HTTP redirects.
 199     + Update the one at the:www/putty/htaccess which points the
 200       virtual subdir `latest' at the actual latest release dir. TEST
 201       THIS ONE - it's quite important.
 202     + ixion:www/putty/.htaccess has an individual redirect for each
 203       version number. Add a new one.
 204
 205  - Update the FTP symlink (chiark:ftp/putty-latest -> putty-<ver>).
 206
 207  - Update web site.
 208    + Adjust front page (`the latest version is <ver>').
 209    + Adjust Download page similarly.
 210    + Adjust filenames of installer and Unix tarball on links in
 211      Download page.
 212    + Adjust header text on Changelog page. (That includes changing
 213      `are new' in previous version to `were new'!)
 214
 215  - Update the wishlist. This can be done without touching individual
 216    items by editing the @releases array in control/bugs2html.
 217
 218  - Check the Docs page links correctly to the release docs. (It
 219    should do this automatically, owing to the `latest' HTTP
 220    redirect.)
 221
 222  - Check that the web server attaches the right content type to .HLP
 223    and .CNT files.
 224
 225  - Run webupdate, so that all the changes on ixion propagate to
 226    chiark. Important to do this _before_ announcing that the release
 227    is available.
 228
 229  - After running webupdate, run update-rsync on chiark and verify
 230    that the rsync mirror package correctly identifies the new
 231    version.
 232
 233  - Announce the release!
 234     + Mail the announcement to putty-announce.
 235        * Set a Reply-To on the mail so that people don't keep
 236          replying to my personal address.
 237     + Post it to comp.security.ssh.
 238     + Mention it in <TDHTT> on mono.
 239
 240  - Relax (slightly).
 241
 242 After the release
 243 -----------------
 244
 245 The following want doing some time soon after a release has been made:
 246
 247  - If the release was made from a branch, make sure the version number
 248    on the _trunk_ is up to date in all the locations listed above, so
 249    that (e.g.) Unix snapshots come out right.