X-Git-Url: https://git.distorted.org.uk/u/mdw/putty/blobdiff_plain/8855e10ac58cafaf6ae95b4695c3332ceada887d..2ff340bdd3941537211af374feaa6023a20529be:/CHECKLST.txt diff --git a/CHECKLST.txt b/CHECKLST.txt index ae2d5b9e..37b2de61 100644 --- a/CHECKLST.txt +++ b/CHECKLST.txt @@ -48,9 +48,15 @@ The website: Before tagging a release ------------------------ - - First of all, go through the source (including the documentation) - and remove anything tagged with a comment containing the word - XXX-REMOVE-BEFORE-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 in at all - all version numbers were passed into the build @@ -100,103 +106,36 @@ This is the procedure I (SGT) currently follow (or _should_ follow of the tag. - Double-check that we have removed anything tagged with a comment - containing the word XXX-REMOVE-BEFORE-RELEASE. + 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 within days of the release going out. - - On my local machines, check out the release-tagged version of the - sources. Do this in a _clean_ directory; don't depend on my usual - source dir. - + Make sure to run mkfiles.pl _after_ this checkout, just in - case. - - - Build the source archives now, while the directory is still - pristine. - + run ./mksrcarc.sh to build the Windows source zip. - + run `./mkunxarc.sh X.YZ' to build the Unix tarball. - - - 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, - and sanity-check the version info reported on the files by Windows. - + 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 signatures on these, to ensure they're really the - ones he built. If I'm going to sign a zip file I make out of - these, I'm damn well going to make sure the binaries that go - _into_ it are signed themselves. - + Make sure Owen has kept the Alpha release link maps somewhere - useful. - - - Run Halibut to build the docs. Define VERSION on the make command - line to override the version strings, since Subversion revision - numbers are less meaningful on a tag. - + make -C doc VERSION="PuTTY release 0.XX" - - - Build the binary archives putty.zip (one for each architecture): - each one just contains all the .exe files except PuTTYtel, and - the .hlp and .cnt files. - + zip -k putty.zip `ls *.exe | grep -v puttytel` putty.hlp putty.cnt - + same again for Alpha. - - - Build the docs archive puttydoc.zip: it contains all the HTML - files output from Halibut. - + zip puttydoc.zip *.html - - - 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 - release keys. Having checked that, sign the Alpha binary - zipfile with the release 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. - for i in ; do for t in DSA RSA; do gpg --load-extension=idea --detach-sign -u "Releases ($t)" -o $i.$t $i; done; done - - - 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 Windows source zip (plus - signatures), the Unix source tarball (plus signatures), - puttydoc.txt, the .hlp and .cnt files, and puttydoc.zip. - - - 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). - - - 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. Easiest - thing is to run, in each directory, this command: - md5sum `\find * -name '*SA' -o -type f -print` > md5sums - + Sign the md5sums files (gpg --clearsign). - for i in md5sums */md5sums; do for t in DSA RSA; do gpg --load-extension=idea --clearsign -u "Releases ($t)" -o $i.$t $i; done; done - - - Now double-check by verifying all the signatures on all the - files, and running md5sum -c on all the md5sums files. + - 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 ixion, 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 it to ixion:www/putty/. - Do final checks on the release directory: - + verify all the signatures. In each directory: - for i in *.*SA; do case $i in md5sums*) gpg --verify $i;; *) gpg --verify $i `echo $i | sed 's/\..SA$//'`;; esac; done - + check the md5sums. In each directory: + + verify all the signatures: + for i in `find . -name '*.*SA'`; do case $i in *md5sums*) gpg --verify $i;; *) gpg --verify $i ${i%%.?SA};; esac; done + + check the md5sums: md5sum -c md5sums - Having double-checked the release, copy it from ixion to @@ -235,9 +174,6 @@ of the tag. - Run webupdate, so that all the changes on ixion propagate to chiark. Important to do this _before_ announcing that the release is available. - * Don't forget to create the new directories on chiark - - ~/www/putty/{,/x86,/alpha,/htmldoc} - before running - webupdate. - After running webupdate, run update-rsync on chiark and verify that the rsync mirror package correctly identifies the new