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/unix/gtkdlg.c
  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
  33 The documentation (both the preamble blurb and the licence appendix):
  34
  35  - putty/doc/blurb.but
  36  - putty/doc/licence.but
  37
  38 The website:
  39
  40  - putty-website/licence.html
  41
  42 Before tagging a release
  43 ------------------------
  44
  45  - First of all, go through the source (including the documentation),
  46    and the website, and review anything tagged with a comment
  47    containing the word XXX-REVIEW-BEFORE-RELEASE.
  48    (Any such comments should state clearly what needs to be done.)
  49
  50  - Also, do some testing of the Windows version with Minefield, and
  51    of the Unix version with valgrind or efence or both. In
  52    particular, any headline features for the release should get a
  53    workout with memory checking enabled!
  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 It might also be worth going through the documentation looking for
  75 version numbers - we have a couple of transcripts showing the help
  76 text from the command-line tools, and it would be nice to ensure the
  77 whole transcripts (certainly including the version numbers) are up
  78 to date. Sometimes these are marked in between releases as `0.XX', so
  79 it's worth grepping for that too.
  80
  81  - putty/doc/pscp.but
  82  - putty/doc/plink.but
  83  - putty/doc/psftp.but (in case it ever acquires a similar thing)
  84
  85 Finally, reset the epoch used for the $(Days) value computed in
  86 Buildscr for the Windows binary version resource. It's probably not a
  87 good idea to set it to _today_ (since it might clash with the
  88 zero-valued field used in actual releases), so perhaps we should start
  89 it 1000 days before the release date so as to have a largish number
  90 recognisable as being the right kind of thing by its order of
  91 magnitude. So, do this:
  92
  93   perl -e 'printf "%d\n", time/86400 - 1000'
  94
  95 and then substitute the resulting value into the definition of 'Epoch'
  96 in Buildscr.
  97
  98 The actual release procedure
  99 ----------------------------
 100
 101 This is the procedure I (SGT) currently follow (or _should_ follow
 102 :-) when actually making a release, once I'm happy with the position
 103 of the tag.
 104
 105  - Double-check that we have removed anything tagged with a comment
 106    containing the words XXX-REMOVE-BEFORE-RELEASE or
 107    XXX-REVIEW-BEFORE-RELEASE.
 108
 109  - Write a release announcement (basically a summary of the changes
 110    since the last release). Squirrel it away in
 111    atreus:src/putty/local/announce-<ver> in case it's needed again
 112    within days of the release going out.
 113
 114  - Build the release: `bob putty-0.XX RELEASE=0.XX'. This should
 115    generate a basically valid release directory as
 116    `build.out/putty', and provide link maps and sign.sh alongside
 117    that in build.out.
 118
 119  - Do a bit of checking that the release binaries basically work,
 120    report their version numbers accurately, and so on. Test the
 121    installer and the Unix source tarball.
 122
 123  - Save the link maps. Currently I keep these on atreus, in
 124    src/putty/local/maps-<version>.
 125
 126  - Sign the release: in the `build.out' directory, type `./sign.sh
 127    putty Releases', and enter the passphrases a lot of times.
 128
 129  - Now the whole release directory should be present and correct.
 130    Upload it to atreus:www/putty/<ver>.
 131
 132  - Do final checks on the release directory:
 133     + verify all the signatures:
 134       for i in `find . -name '*.*SA'`; do case $i in *sums*) gpg --verify $i;; *) gpg --verify $i ${i%%.?SA};; esac; done
 135     + check the checksum files:
 136       md5sum -c md5sums
 137       sha1sum -c sha1sums
 138       sha256sum -c sha256sums
 139       sha512sum -c sha512sums
 140
 141  - Having double-checked the release, copy it from atreus to
 142    chiark:ftp/putty-<ver> and to the:www/putty/<ver>.
 143
 144  - Check the permissions! Actually try downloading from the, to make
 145    sure it really works.
 146
 147  - Update the HTTP redirects.
 148     + Update the one at the:www/putty/htaccess which points the
 149       virtual subdir `latest' at the actual latest release dir. TEST
 150       THIS ONE - it's quite important.
 151     + atreus:www/putty/.htaccess has an individual redirect for each
 152       version number. Add a new one.
 153
 154  - Update the FTP symlink (chiark:ftp/putty-latest -> putty-<ver>).
 155
 156  - Update web site.
 157    + Adjust front page to say 'The latest version is <ver>'.
 158    + Adjust front page to add a news item.
 159    + Adjust Download page to say 'The latest release version (<ver>)'.
 160    + Adjust Download page to update filenames of installer and Unix
 161      tarball (both in the hrefs themselves and the link text).
 162    + Check over the Download page and remove any mention of
 163      pre-releases, if there were any before this release. Comment out
 164      the big pre-release section at the top, and also adjust the
 165      sections about source archives at the bottom.
 166    + Adjust header text on Changelog page. (That includes changing
 167      `are new' in previous version to `were new'!)
 168
 169  - Update the wishlist. This can be done without touching individual
 170    items by editing the @releases array in control/bugs2html.
 171
 172  - Check the Docs page links correctly to the release docs. (It
 173    should do this automatically, owing to the `latest' HTTP
 174    redirect.)
 175
 176  - Check that the web server attaches the right content type to .HLP
 177    and .CNT files.
 178
 179  - Run webupdate, so that all the changes on atreus propagate to
 180    chiark. Important to do this _before_ announcing that the release
 181    is available.
 182
 183  - After running webupdate, run update-rsync on chiark and verify that
 184    the rsync mirror package (~/ftp/putty-website-mirror) contains a
 185    subdirectory for the new version and mentions it in its .htaccess.
 186
 187  - Announce the release!
 188     + Construct a release announcement email whose message body is the
 189       announcement written above, and which includes the following
 190       headers:
 191        * Reply-To: <putty@projects.tartarus.org>
 192        * Subject: PuTTY X.YZ is released
 193     + Mail that release announcement to
 194       <putty-announce@lists.tartarus.org>.
 195     + Post it to comp.security.ssh.
 196     + Mention it in <TDHTT> on mono.
 197
 198  - Relax (slightly).
 199
 200 After the release
 201 -----------------
 202
 203 The following want doing some time soon after a release has been made:
 204
 205  - If the release was made from a branch, make sure the version number
 206    on the _trunk_ is up to date in all the locations listed above, so
 207    that (e.g.) Unix snapshots come out right.