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