X-Git-Url: https://git.distorted.org.uk/u/mdw/putty/blobdiff_plain/8c09f18633959f215ad0b2d3c3d71d18fd654afd..HEAD:/CHECKLST.txt diff --git a/CHECKLST.txt b/CHECKLST.txt index 164e825e..f44838d4 100644 --- a/CHECKLST.txt +++ b/CHECKLST.txt @@ -15,16 +15,17 @@ The LICENCE file in the main source distribution: The resource files: - - putty/pageant.rc + - putty/windows/pageant.rc + the copyright date appears twice, once in the About box and once in the Licence box. Don't forget to change both! - - putty/puttygen.rc + - putty/windows/puttygen.rc + the copyright date appears twice, once in the About box and once in the Licence box. Don't forget to change both! - - putty/win_res.rc + - putty/windows/win_res.rc2 + the copyright date appears twice, once in the About box and once in the Licence box. Don't forget to change both! - - putty/mac/mac_res.r + - putty/windows/version.rc2 + + the copyright date appears once only. - putty/unix/gtkdlg.c + the copyright date appears twice, once in the About box and once in the Licence box. Don't forget to change both! @@ -41,13 +42,23 @@ The website: Before tagging a release ------------------------ + - First of all, go through the source (including the documentation), + and the website, and review anything tagged with a comment + containing the word XXX-REVIEW-BEFORE-RELEASE. + (Any such comments should state clearly what needs to be done.) + + - Also, do some testing of the Windows version with Minefield, and + of the Unix version with valgrind or efence or both. In + particular, any headline features for the release should get a + workout with memory checking enabled! + For a long time we got away with never checking the current version -number into CVS at all - all version numbers were passed into the -build system on the compiler command line, and the _only_ place -version numbers showed up in CVS was in the tag information. +number in at all - all version numbers were passed into the build +system on the compiler command line, and the _only_ place version +numbers showed up in the source files was in the tag information. Unfortunately, those halcyon days are gone, and we do need the -version number in CVS in a couple of places. These must be updated +version number checked in in a couple of places. These must be updated _before_ tagging a new release. The file used to generate the Unix snapshot version numbers (which @@ -56,20 +67,21 @@ orders them correctly with respect to releases): - putty/LATEST.VER -The Windows installer script: +The Windows installer script (_four_ times, on consecutive lines): - - putty/putty.iss + - putty/windows/putty.iss -The Mac resource file (used to generate the binary bit of the 'vers' -resources -- the strings are supplied by the usual means): +The Windows resource file (used to generate the binary bit of the +VERSIONINFO resources -- the strings are supplied by the usual means): - - putty/mac/version.r + - putty/windows/version.rc2 (BASE_VERSION; NB, _comma_-separated) It might also be worth going through the documentation looking for version numbers - we have a couple of transcripts showing the help text from the command-line tools, and it would be nice to ensure the whole transcripts (certainly including the version numbers) are up -to date. +to date. Sometimes these are marked in between releases as `0.XX', so +it's worth grepping for that too. - putty/doc/pscp.but - putty/doc/plink.but @@ -82,106 +94,72 @@ This is the procedure I (SGT) currently follow (or _should_ follow :-) when actually making a release, once I'm happy with the position of the tag. + - Double-check that we have removed anything tagged with a comment + containing the words XXX-REMOVE-BEFORE-RELEASE or + XXX-REVIEW-BEFORE-RELEASE. + - Write a release announcement (basically a summary of the changes since the last release). Squirrel it away in - ixion:src/putty/local/announce- in case it's needed again + atreus:src/putty/local/announce- in case it's needed again within days of the release going out. - - On my local machines, check out the release-tagged version of the - sources. - + Make sure to run mkfiles.pl _after_ this checkout, just in - case. - - - Build the Windows/x86 release binaries. Don't forget to supply - VER=/DRELEASE=. Run them, or at least one or two of them, to - ensure that they really do report their version number correctly. - + Save the release link maps. Currently I keep these on ixion, - in src/putty/local/maps-. - - - Acquire the Windows/alpha release binaries from Owen. - + Verify the snapshot-key signatures on these, to ensure they're - really the ones he built. If I'm going to snapshot-sign a zip - file I make out of these, I'm damn well going to make sure the - binaries that go _into_ it were snapshot-signed themselves. - + Make sure Owen has kept the Alpha release link maps somewhere - useful. - - - Run Halibut to build the docs. - - - Build the .zip files. - + The binary archive putty.zip just contains all the .exe files - except PuTTYtel, and the .hlp and .cnt files. - + The source archive putty-src.zip is fiddly to build, so it's - done by the shell script mksrcarc.sh. First check out the - release sources in a pristine directory (to avoid cluttering - the zip file with irrelevant stuff), then run mksrcarc.sh in - that directory. - + The docs archive puttydoc.zip contains all the HTML files - output from Halibut. - - - Build the installer. - - - Sign the release (gpg --detach-sign). - + Sign the locally built x86 binaries, the locally built x86 - binary zipfile, and the locally built x86 installer, with the - release keys. - + The Alpha binaries should already have been signed with the - snapshot keys. Having checked that, sign the Alpha binary - zipfile with the snapshot keys too. - + The source archive should be signed with the release keys. - + Don't forget to sign with both DSA and RSA keys for absolutely - everything. - - - Begin to pull together the release directory structure. - + subdir `x86' containing the x86 binaries, x86 binary zip, x86 - installer, and all signatures on the above. - + subdir `alpha' containing the Alpha binaries, Alpha binary - zip, and all signatures on the above. - + top-level dir contains the source zip (plus signatures), - puttydoc.txt, the .hlp and .cnt files, and puttydoc.zip. - - - Create and sign md5sums files: one in the x86 subdir, one in the - alpha subdir, and one in the parent dir of both of those. - + The md5sums files need not list the .DSA and .RSA signatures, - and the top-level md5sums need not list the other two. - + Sign the md5sums files (gpg --clearsign). The Alpha md5sums - should be signed with the snapshot keys, but the other two - with the release keys (yes, the top-level one includes some - Alpha files, but I think people will understand). - - - Now double-check by verifying all the signatures on all the - files. - - - Create subdir `htmldoc' in the release directory, which should - contain exactly the same set of HTML files that went into - puttydoc.zip. - + It also needs a copy of sitestyle.css, because the online - versions of the HTML docs will link to this (although the - zipped form should be self-contained). + - Build the release: `bob putty-0.XX RELEASE=0.XX'. This should + generate a basically valid release directory as + `build.out/putty', and provide link maps and sign.sh alongside + that in build.out. + + - Do a bit of checking that the release binaries basically work, + report their version numbers accurately, and so on. Test the + installer and the Unix source tarball. + + - Save the link maps. Currently I keep these on atreus, in + src/putty/local/maps-. + + - Sign the release: in the `build.out' directory, type `./sign.sh + putty Releases', and enter the passphrases a lot of times. - Now the whole release directory should be present and correct. - Upload to ixion:www/putty/, upload to - chiark:ftp/putty-, and upload to the:www/putty/. + Upload it to atreus:www/putty/. + + - Do final checks on the release directory: + + verify all the signatures: + for i in `find . -name '*.*SA'`; do case $i in *sums*) gpg --verify $i;; *) gpg --verify $i ${i%%.?SA};; esac; done + + check the checksum files: + md5sum -c md5sums + sha1sum -c sha1sums + sha256sum -c sha256sums + sha512sum -c sha512sums + + - Having double-checked the release, copy it from atreus to + chiark:ftp/putty- and to the:www/putty/. + + - Check the permissions! Actually try downloading from the, to make + sure it really works. - Update the HTTP redirects. + Update the one at the:www/putty/htaccess which points the virtual subdir `latest' at the actual latest release dir. TEST THIS ONE - it's quite important. - + ixion:www/putty/.htaccess has an individual redirect for each + + atreus:www/putty/.htaccess has an individual redirect for each version number. Add a new one. - Update the FTP symlink (chiark:ftp/putty-latest -> putty-). - Update web site. - + Adjust front page (`the latest version is '). - + Adjust Download page similarly. - + Adjust filename of installer on links in Download page. + + Adjust front page to say 'The latest version is '. + + Adjust front page to add a news item. + + Adjust Download page to say 'The latest release version ()'. + + Adjust Download page to update filenames of installer and Unix + tarball (both in the hrefs themselves and the link text). + + Check over the Download page and remove any mention of + pre-releases, if there were any before this release. Comment out + the big pre-release section at the top, and also adjust the + sections about source archives at the bottom. + Adjust header text on Changelog page. (That includes changing `are new' in previous version to `were new'!) - - Update the wishlist - all items that have been fixed since the - last release should have their "Fixed-in:" headers updated to - include the release version number. + - Update the wishlist. This can be done without touching individual + items by editing the @releases array in control/bugs2html. - Check the Docs page links correctly to the release docs. (It should do this automatically, owing to the `latest' HTTP @@ -190,14 +168,32 @@ of the tag. - Check that the web server attaches the right content type to .HLP and .CNT files. - - Run webupdate, so that all the changes on ixion propagate to + - Run webupdate, so that all the changes on atreus propagate to chiark. Important to do this _before_ announcing that the release is available. + - After running webupdate, run update-rsync on chiark and verify that + the rsync mirror package (~/ftp/putty-website-mirror) contains a + subdirectory for the new version and mentions it in its .htaccess. + - Announce the release! - + Mail the announcement to putty-announce. + + Construct a release announcement email whose message body is the + announcement written above, and which includes the following + headers: + * Reply-To: + * Subject: PuTTY X.YZ is released + + Mail that release announcement to + . + Post it to comp.security.ssh. - + Mention it in on mono. + + Mention it in on mono. + + - Relax (slightly). + +After the release +----------------- + +The following want doing some time soon after a release has been made: - - All done. Probably best to run `cvs up -A' now, or I'll only - forget in a few days' time and get confused... + - If the release was made from a branch, make sure the version number + on the _trunk_ is up to date in all the locations listed above, so + that (e.g.) Unix snapshots come out right.