X-Git-Url: https://git.distorted.org.uk/u/mdw/putty/blobdiff_plain/a655127470fd533cf892f3b554ee93618bb4b74d..27311cc77360e186bdfe9618193d531d0ea4e00d:/CHECKLST.txt diff --git a/CHECKLST.txt b/CHECKLST.txt index fb630701..efca86d9 100644 --- a/CHECKLST.txt +++ b/CHECKLST.txt @@ -21,9 +21,11 @@ The resource files: - 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/windows/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/windows/version.rc2 + + the copyright date appears once only. - putty/mac/mac_res.r + the copyright date appears twice, once in the About box and once in the Licence box. Don't forget to change both! @@ -46,8 +48,15 @@ The website: Before tagging a release ------------------------ - - First of all, go through the source 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 @@ -64,12 +73,17 @@ orders them correctly with respect to releases): - putty/LATEST.VER -The Windows installer script (_three_ times, on consecutive lines): +The Windows installer script (_four_ times, on consecutive lines): - putty/windows/putty.iss +The Windows resource file (used to generate the binary bit of the +VERSIONINFO resources -- the strings are supplied by the usual means): + + - putty/windows/version.rc2 (BASE_VERSION; NB, _comma_-separated) + The Mac resource file (used to generate the binary bit of the 'vers' -resources -- the strings are supplied by the usual means): +resources): - putty/mac/version.r @@ -92,7 +106,8 @@ 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 @@ -112,28 +127,24 @@ of the tag. - 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. + 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" + + change into the doc subdir + + run `make VERSION="PuTTY release 0.XX" chm', then run `hhc + putty.hhp' to build the .CHM + + then run `make mostlyclean' (destroys the hhc input files but + _not_ the .CHM) + + then `make 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 binary archive putty.zip: all the .exe files except + PuTTYtel, and the .hlp, .cnt and .chm files. + + zip -k putty.zip `ls *.exe | grep -v puttytel` putty.hlp putty.cnt putty.chm - Build the docs archive puttydoc.zip: it contains all the HTML files output from Halibut. @@ -145,9 +156,6 @@ of the tag. + 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. @@ -156,11 +164,9 @@ of the tag. - 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. + puttydoc.txt, the .hlp, .cnt and .chm files, and puttydoc.zip. - Create subdir `htmldoc' in the release directory, which should contain exactly the same set of HTML files that went into @@ -169,17 +175,15 @@ of the tag. 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: + - Create and sign an md5sums file in the top-level directory. + + The md5sums files need not list the .DSA and .RSA signatures. + Easiest thing is to run 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 + + Sign the md5sums file (gpg --clearsign). + for t in DSA RSA; do gpg --load-extension=idea --clearsign -u "Releases ($t)" -o md5sums.$t md5sums; done - Now double-check by verifying all the signatures on all the - files, and running md5sum -c on all the md5sums files. + files, and running md5sum -c on the md5sums file. - Now the whole release directory should be present and correct. Upload to ixion:www/putty/. @@ -187,7 +191,7 @@ of the tag. - 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: + + check the md5sums: md5sum -c md5sums - Having double-checked the release, copy it from ixion to @@ -226,9 +230,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 @@ -236,6 +237,8 @@ of the tag. - Announce the release! + Mail the announcement to putty-announce. + * Set a Reply-To on the mail so that people don't keep + replying to my personal address. + Post it to comp.security.ssh. + Mention it in on mono.