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 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  - Also, do some testing of the Windows version with Minefield, and
  57    of the Unix version with valgrind or efence or both. In
  58    particular, any headline features for the release should get a
  59    workout with memory checking enabled!
  60
  61 For a long time we got away with never checking the current version
  62 number in at all - all version numbers were passed into the build
  63 system on the compiler command line, and the _only_ place version
  64 numbers showed up in the source files was in the tag information.
  65
  66 Unfortunately, those halcyon days are gone, and we do need the
  67 version number checked in in a couple of places. These must be updated
  68 _before_ tagging a new release.
  69
  70 The file used to generate the Unix snapshot version numbers (which
  71 are <previousrelease>-<date> so that the Debian versioning system
  72 orders them correctly with respect to releases):
  73
  74  - putty/LATEST.VER
  75
  76 The Windows installer script (_four_ times, on consecutive lines):
  77
  78  - putty/windows/putty.iss
  79
  80 The Windows resource file (used to generate the binary bit of the
  81 VERSIONINFO resources -- the strings are supplied by the usual means):
  82
  83  - putty/windows/version.rc2 (BASE_VERSION; NB, _comma_-separated)
  84
  85 The Mac resource file (used to generate the binary bit of the 'vers'
  86 resources):
  87
  88  - putty/mac/version.r
  89
  90 It might also be worth going through the documentation looking for
  91 version numbers - we have a couple of transcripts showing the help
  92 text from the command-line tools, and it would be nice to ensure the
  93 whole transcripts (certainly including the version numbers) are up
  94 to date. Sometimes these are marked in between releases as `0.XX', so
  95 it's worth grepping for that too.
  96
  97  - putty/doc/pscp.but
  98  - putty/doc/plink.but
  99  - putty/doc/psftp.but (in case it ever acquires a similar thing)
 100
 101 The actual release procedure
 102 ----------------------------
 103
 104 This is the procedure I (SGT) currently follow (or _should_ follow
 105 :-) when actually making a release, once I'm happy with the position
 106 of the tag.
 107
 108  - Double-check that we have removed anything tagged with a comment
 109    containing the words XXX-REMOVE-BEFORE-RELEASE or
 110    XXX-REVIEW-BEFORE-RELEASE.
 111
 112  - Write a release announcement (basically a summary of the changes
 113    since the last release). Squirrel it away in
 114    ixion:src/putty/local/announce-<ver> in case it's needed again
 115    within days of the release going out.
 116
 117  - Build the release: `bob putty-0.XX RELEASE=0.XX'. This should
 118    generate a basically valid release directory as `build.out'.
 119
 120  - Do a bit of checking that the release binaries basically work,
 121    report their version numbers accurately, and so on. Test the
 122    installer and the Unix source tarball.
 123
 124  - Move the release link maps out of the build directory and save
 125    them somewhere more useful. Currently I keep these on ixion, in
 126    src/putty/local/maps-<version>.
 127
 128  - Sign the release: type `./sign.sh build.out Releases', and enter
 129    the passphrases a lot of times.
 130
 131  - Now the whole release directory should be present and correct.
 132    Upload to ixion:www/putty/<ver>.
 133
 134  - Do final checks on the release directory:
 135     + verify all the signatures:
 136       for i in `find . -name '*.*SA'`; do case $i in *md5sums*) gpg --verify $i;; *) gpg --verify $i ${i%%.?SA};; esac; done
 137     + check the md5sums:
 138       md5sum -c md5sums
 139
 140  - Having double-checked the release, copy it from ixion to
 141    chiark:ftp/putty-<ver> and to the:www/putty/<ver>.
 142
 143  - Check the permissions! Actually try downloading from the, to make
 144    sure it really works.
 145
 146  - Update the HTTP redirects.
 147     + Update the one at the:www/putty/htaccess which points the
 148       virtual subdir `latest' at the actual latest release dir. TEST
 149       THIS ONE - it's quite important.
 150     + ixion:www/putty/.htaccess has an individual redirect for each
 151       version number. Add a new one.
 152
 153  - Update the FTP symlink (chiark:ftp/putty-latest -> putty-<ver>).
 154
 155  - Update web site.
 156    + Adjust front page (`the latest version is <ver>').
 157    + Adjust Download page similarly.
 158    + Adjust filenames of installer and Unix tarball on links in
 159      Download page.
 160    + Adjust header text on Changelog page. (That includes changing
 161      `are new' in previous version to `were new'!)
 162
 163  - Update the wishlist. This can be done without touching individual
 164    items by editing the @releases array in control/bugs2html.
 165
 166  - Check the Docs page links correctly to the release docs. (It
 167    should do this automatically, owing to the `latest' HTTP
 168    redirect.)
 169
 170  - Check that the web server attaches the right content type to .HLP
 171    and .CNT files.
 172
 173  - Run webupdate, so that all the changes on ixion propagate to
 174    chiark. Important to do this _before_ announcing that the release
 175    is available.
 176
 177  - After running webupdate, run update-rsync on chiark and verify
 178    that the rsync mirror package correctly identifies the new
 179    version.
 180
 181  - Announce the release!
 182     + Mail the announcement to putty-announce.
 183        * Set a Reply-To on the mail so that people don't keep
 184          replying to my personal address.
 185     + Post it to comp.security.ssh.
 186     + Mention it in <TDHTT> on mono.
 187
 188  - Relax (slightly).
 189
 190 After the release
 191 -----------------
 192
 193 The following want doing some time soon after a release has been made:
 194
 195  - If the release was made from a branch, make sure the version number
 196    on the _trunk_ is up to date in all the locations listed above, so
 197    that (e.g.) Unix snapshots come out right.