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