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 Preparing to make a release
  43 ---------------------------
  44
  45 Now that PuTTY is in git, a lot of the release preparation can be done
  46 in advance, in local checkouts, and not pushed until the actual
  47 process of _releasing_ it.
  48
  49 To begin with, before dropping the tag, make sure everything is ready
  50 for it:
  51
  52  - First of all, go through the source (including the documentation),
  53    and the website, and review anything tagged with a comment
  54    containing the word XXX-REVIEW-BEFORE-RELEASE.
  55    (Any such comments should state clearly what needs to be done.)
  56
  57  - Also, do some testing of the Windows version with Minefield, and
  58    of the Unix version with valgrind or efence or both. In
  59    particular, any headline features for the release should get a
  60    workout with memory checking enabled!
  61
  62  - Double-check that we have removed anything tagged with a comment
  63    containing the words XXX-REMOVE-BEFORE-RELEASE or
  64    XXX-REVIEW-BEFORE-RELEASE. ('git grep XXX-RE' should only show up
  65    hits in this file itself.)
  66
  67  - Now update version numbers in
  68     * putty/LATEST.VER
  69     * putty/windows/putty.iss (four times, on consecutive lines)
  70     * putty/doc/pscp.but (and make sure the rest of the transcript is
  71       up to date)
  72     * putty/doc/plink.but (likewise)
  73
  74  - Reset the epoch used for the $(Days) value computed in Buildscr for
  75    the Windows binary version resource. It's probably not a good idea
  76    to set it to _today_ (since it might clash with the zero-valued
  77    field used in actual releases), so perhaps we should start it 1000
  78    days before the release date so as to have a largish number
  79    recognisable as being the right kind of thing by its order of
  80    magnitude. So, do this:
  81
  82      perl -e 'printf "%d\n", time/86400 - 1000'
  83
  84    and then substitute the resulting value into the definition of
  85    'Epoch' in Buildscr.
  86
  87  - Commit those version number and epoch changes (on the appropriate
  88    branch, of course!), and then make the release tag pointing at the
  89    resulting commit.
  90
  91  - If the release is on a branch (which I expect it generally will
  92    be), merge that branch to master.
  93
  94  - Write a release announcement (basically a summary of the changes
  95    since the last release). Squirrel it away in
  96    atreus:src/putty-local/announce-<ver> in case it's needed again
  97    within days of the release going out.
  98
  99  - Update the web site, in a local checkout.
 100    + Adjust front page to say 'The latest version is <ver>'.
 101    + Adjust front page to add a news item.
 102    + Adjust Download page to say 'The latest release version (<ver>)'.
 103    + Adjust Download page to update filenames of installer and Unix
 104      tarball (both in the hrefs themselves and the link text).
 105    + Check over the Download page and remove any mention of
 106      pre-releases, if there were any before this release. Comment out
 107      the big pre-release section at the top, and also adjust the
 108      sections about source archives at the bottom.
 109    + Do the same on the Docs page.
 110    + Adjust header text on Changelog page. (That includes changing
 111      `are new' in previous version to `were new'!)
 112    + .htaccess has an individual redirect for each version number. Add
 113      a new one.
 114
 115  - If there are any last-minute wishlist entries (e.g. security
 116    vulnerabilities fixed in the new release), write entries for them
 117    in a local checkout of putty-wishlist.
 118
 119  - Update the wishlist mechanism for the new release. This can be done
 120    without touching individual items by editing the @releases array in
 121    control/bugs2html.
 122
 123  - Build the release, by checking out the release tag:
 124      git checkout 0.XX
 125      bob . RELEASE=0.XX
 126    This should generate a basically valid release directory as
 127    `build.out/putty', and provide link maps and sign.sh alongside that
 128    in build.out.
 129
 130  - Double-check in build.log that the release was built from the right
 131    git commit.
 132
 133  - Do a bit of checking that the release binaries basically work,
 134    report their version numbers accurately, and so on. Test the
 135    installer and the Unix source tarball.
 136
 137  - Sign the release: in the `build.out' directory, type
 138      sh sign.sh -r putty
 139    and enter the passphrases a lot of times.
 140
 141 The actual release procedure
 142 ----------------------------
 143
 144 Once all the above preparation is done and the release has been built
 145 locally, this is the procedure for putting it up on the web.
 146
 147  - Save the link maps. Currently I keep these on atreus, in
 148    src/putty-local/maps-<version>.
 149
 150  - Upload the entire release directory to atreus:www/putty/<version>.
 151
 152  - Do final checks on the release directory in its new location:
 153     + verify all the signatures:
 154       for i in `find . -name '*.gpg'`; do case $i in *sums*) gpg --verify $i;; *) gpg --verify $i ${i%%.gpg};; esac; done
 155     + check the checksum files:
 156       md5sum -c md5sums
 157       sha1sum -c sha1sums
 158       sha256sum -c sha256sums
 159       sha512sum -c sha512sums
 160
 161  - Having double-checked the release, copy it from atreus to
 162    chiark:ftp/putty-<ver> and to the:www/putty/<ver>.
 163
 164  - Check the permissions! Actually try downloading from the, to make
 165    sure it really works.
 166
 167  - Update the HTTP redirect at the:www/putty/htaccess which points the
 168    virtual subdir `latest' at the actual latest release dir. TEST THIS
 169    ONE - it's quite important.
 170
 171  - Update the FTP symlink (chiark:ftp/putty-latest -> putty-<ver>).
 172
 173  - Check the Docs page links correctly to the release docs. (It
 174    should do this automatically, owing to the `latest' HTTP
 175    redirect.)
 176
 177  - Check that the web server attaches the right content type to .HLP
 178    and .CNT files.
 179
 180  - Run 'git push' in the website checkout, and then 'git pull' in
 181    ~/www/putty on atreus to fetch the website updates.
 182
 183  - Push the changes to PuTTY itself. Something like:
 184      git push origin master        # update the master branch
 185      git push origin --tags        # should push the new release tag
 186      git push origin :pre-0.XX     # delete the pre-release branch
 187
 188  - Run 'git push' in the putty-wishlist checkout. Then run 'git pull'
 189    in ~/pub/putty-wishlist on atreus, and update the wishlist web
 190    pages with the commands
 191      cd ~/pub/putty-wishlist/control
 192      perl bugs2html
 193
 194  - Check over the web site to make sure all the changes to wishlist
 195    and main web pages are present and correct.
 196
 197  - Run webupdate, so that all the changes on atreus propagate to
 198    chiark. Important to do this _before_ announcing that the release
 199    is available.
 200
 201  - After running webupdate, run update-rsync on chiark and verify that
 202    the rsync mirror package (~/ftp/putty-website-mirror) contains a
 203    subdirectory for the new version and mentions it in its .htaccess.
 204
 205  - Announce the release!
 206     + Construct a release announcement email whose message body is the
 207       announcement written above, and which includes the following
 208       headers:
 209        * Reply-To: <putty@projects.tartarus.org>
 210        * Subject: PuTTY X.YZ is released
 211     + Mail that release announcement to
 212       <putty-announce@lists.tartarus.org>.
 213     + Post it to comp.security.ssh.
 214     + Mention it in <TDHTT> on mono.
 215
 216  - Edit ~/adm/puttysnap.sh to disable pre-release builds, if they were
 217    previously enabled.
 218
 219  - Relax (slightly).