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/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. Do this in a _clean_ directory; don't depend on my usual
  92    source dir.
  93     + Make sure to run mkfiles.pl _after_ this checkout, just in
  94       case.
  95
  96  - Build the source archives now, while the directory is still
  97    pristine.
  98     + run ./mksrcarc.sh to build the Windows source zip.
  99     + run `./mkunxarc.sh X.YZ' to build the Unix tarball.
 100
 101  - Build the Windows/x86 release binaries. Don't forget to supply
 102    VER=/DRELEASE=<ver>. Run them, or at least one or two of them, to
 103    ensure that they really do report their version number correctly.
 104     + Save the release link maps. Currently I keep these on ixion,
 105       in src/putty/local/maps-<version>.
 106
 107  - Acquire the Windows/alpha release binaries from Owen.
 108     + Verify the signatures on these, to ensure they're really the
 109       ones he built. If I'm going to sign a zip file I make out of
 110       these, I'm damn well going to make sure the binaries that go
 111       _into_ it are signed themselves.
 112     + Make sure Owen has kept the Alpha release link maps somewhere
 113       useful.
 114
 115  - Run Halibut to build the docs.
 116
 117  - Build the binary archives putty.zip (one for each architecture):
 118    each one just contains all the .exe files except PuTTYtel, and
 119    the .hlp and .cnt files.
 120     + zip -k putty.zip `ls *.exe | grep -v puttytel` putty.hlp putty.cnt
 121     + same again for Alpha.
 122
 123  - Build the docs archive puttydoc.zip: it contains all the HTML
 124    files output from Halibut.
 125     + zip puttydoc.zip *.html
 126
 127  - Build the installer.
 128
 129  - Sign the release (gpg --detach-sign).
 130     + Sign the locally built x86 binaries, the locally built x86
 131       binary zipfile, and the locally built x86 installer, with the
 132       release keys.
 133     + The Alpha binaries should already have been signed with the
 134       release keys. Having checked that, sign the Alpha binary
 135       zipfile with the release keys too.
 136     + The source archive should be signed with the release keys.
 137     + Don't forget to sign with both DSA and RSA keys for absolutely
 138       everything.
 139
 140  - Begin to pull together the release directory structure.
 141     + subdir `x86' containing the x86 binaries, x86 binary zip, x86
 142       installer, and all signatures on the above.
 143     + subdir `alpha' containing the Alpha binaries, Alpha binary
 144       zip, and all signatures on the above.
 145     + top-level dir contains the Windows source zip (plus
 146       signatures), the Unix source tarball (plus signatures),
 147       puttydoc.txt, the .hlp and .cnt files, and puttydoc.zip.
 148
 149  - Create and sign md5sums files: one in the x86 subdir, one in the
 150    alpha subdir, and one in the parent dir of both of those.
 151     + The md5sums files need not list the .DSA and .RSA signatures,
 152       and the top-level md5sums need not list the other two.
 153     + Sign the md5sums files (gpg --clearsign).
 154
 155  - Now double-check by verifying all the signatures on all the
 156    files, and running md5sum -c on all the md5sums files.
 157
 158  - Create subdir `htmldoc' in the release directory, which should
 159    contain exactly the same set of HTML files that went into
 160    puttydoc.zip.
 161     + It also needs a copy of sitestyle.css, because the online
 162       versions of the HTML docs will link to this (although the
 163       zipped form should be self-contained).
 164
 165  - Now the whole release directory should be present and correct.
 166    Upload to ixion:www/putty/<ver>, upload to
 167    chiark:ftp/putty-<ver>, and upload to the:www/putty/<ver>.
 168
 169  - Check the permissions! Actually try downloading from the, to make
 170    sure it really works.
 171
 172  - Update the HTTP redirects.
 173     + Update the one at the:www/putty/htaccess which points the
 174       virtual subdir `latest' at the actual latest release dir. TEST
 175       THIS ONE - it's quite important.
 176     + ixion:www/putty/.htaccess has an individual redirect for each
 177       version number. Add a new one.
 178
 179  - Update the FTP symlink (chiark:ftp/putty-latest -> putty-<ver>).
 180
 181  - Update web site.
 182    + Adjust front page (`the latest version is <ver>').
 183    + Adjust Download page similarly.
 184    + Adjust filenames of installer and Unix tarball on links in
 185      Download page.
 186    + Adjust header text on Changelog page. (That includes changing
 187      `are new' in previous version to `were new'!)
 188
 189  - Update the wishlist. This can be done without touching individual
 190    items by editing the @releases array in control/bugs2html.
 191
 192  - Check the Docs page links correctly to the release docs. (It
 193    should do this automatically, owing to the `latest' HTTP
 194    redirect.)
 195
 196  - Check that the web server attaches the right content type to .HLP
 197    and .CNT files.
 198
 199  - Run webupdate, so that all the changes on ixion propagate to
 200    chiark. Important to do this _before_ announcing that the release
 201    is available.
 202
 203  - After running webupdate, run update-rsync on chiark and verify
 204    that the rsync mirror package correctly identifies the new
 205    version.
 206
 207  - Announce the release!
 208     + Mail the announcement to putty-announce.
 209     + Post it to comp.security.ssh.
 210     + Mention it in <TDHTT> on mono.
 211
 212  - All done.