X-Git-Url: https://asedeno.scripts.mit.edu/gitweb/?a=blobdiff_plain;f=CHECKLST.txt;h=78e9d22317bf5e0a7e0b838d904449246fb60e62;hb=1d20c1b396738e66612bbdffda5dcd85b28e5267;hp=d808b51ead0af9555991031208841e4b281ebbf5;hpb=f4a4551d5bb0774e86a675fb5eeebcb31fff950b;p=PuTTY.git diff --git a/CHECKLST.txt b/CHECKLST.txt index d808b51e..78e9d223 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! @@ -38,150 +39,141 @@ The website: - putty-website/licence.html -Before tagging a release ------------------------- - -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. +Preparing to make a release +--------------------------- -Unfortunately, those halcyon days are gone, and we do need the -version number in CVS in a couple of places. These must be updated -_before_ tagging a new release. +Now that PuTTY is in git, a lot of the release preparation can be done +in advance, in local checkouts, and not pushed until the actual +process of _releasing_ it. -The file used to generate the Unix snapshot version numbers (which -are - so that the Debian versioning system -orders them correctly with respect to releases): +To begin with, before dropping the tag, make sure everything is ready +for it: - - putty/LATEST.VER + - 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.) -The Windows installer script: + - 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! - - putty/putty.iss + - Double-check that we have removed anything tagged with a comment + containing the words XXX-REMOVE-BEFORE-RELEASE or + XXX-REVIEW-BEFORE-RELEASE. ('git grep XXX-RE' should only show up + hits in this file itself.) -The Mac resource file (used to generate the binary bit of the 'vers' -resources -- the strings are supplied by the usual means): + - Now update version numbers in + * putty/LATEST.VER + * putty/windows/putty.iss (four times, on consecutive lines) + * putty/doc/pscp.but (and make sure the rest of the transcript is + up to date) + * putty/doc/plink.but (likewise) - - putty/mac/version.r + - Reset the epoch used for the $(Days) value computed in Buildscr for + the Windows binary version resource. It's probably not a good idea + to set it to _today_ (since it might clash with the zero-valued + field used in actual releases), so perhaps we should start it 1000 + days before the release date so as to have a largish number + recognisable as being the right kind of thing by its order of + magnitude. So, do this: -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. + perl -e 'printf "%d\n", time/86400 - 1000' - - putty/doc/pscp.but - - putty/doc/plink.but - - putty/doc/psftp.but (in case it ever acquires a similar thing) + and then substitute the resulting value into the definition of + 'Epoch' in Buildscr. -The actual release procedure ----------------------------- + - Commit those version number and epoch changes (on the appropriate + branch, of course!), and then make the release tag pointing at the + resulting commit. -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. + - If the release is on a branch (which I expect it generally will + be), merge that branch to master. - 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 built by puttysnap.sh (my - cron script that also builds the nightly snapshot source - archive). - + 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. - This was the most fiddly bit of the last release I did: the - script that built the source archive was on ixion, so I had to - bring the archive back to my local machine, check everything - in it was untampered-with, and _then_ sign it. Perhaps next - time I should arrange that puttysnap.sh can run on my local - box; it'd be a lot easier. - + 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). - - - 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/. - - - 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 - 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. + - Update the web site, in a local checkout. + + 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. + + Do the same on the Docs page. + Adjust header text on Changelog page. (That includes changing `are new' in previous version to `were new'!) + + .htaccess has an individual redirect for each version number. Add + a new one. + + - For 0.66 only: if it's not already done, switch the remaining + signature links on the Download page over to using the new + signature style. Then remove this checklist item, since it'll only + need doing this once. + + - If there are any last-minute wishlist entries (e.g. security + vulnerabilities fixed in the new release), write entries for them + in a local checkout of putty-wishlist. + + - Update the wishlist mechanism for the new release. This can be done + without touching individual items by editing the @releases array in + control/bugs2html. + + - Build the release, by checking out the release tag: + git checkout 0.XX + bob . 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. + + - Double-check in build.log that the release was built from the right + git commit. + + - 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. + + - Sign the release: in the `build.out' directory, type + sh sign.sh -r putty + and enter the passphrases a lot of times. + +The actual release procedure +---------------------------- + +Once all the above preparation is done and the release has been built +locally, this is the procedure for putting it up on the web. + + - Save the link maps. Currently I keep these on atreus, in + src/putty-local/maps-. + + - Upload the entire release directory to atreus:www/putty/. + + - Do final checks on the release directory in its new location: + + verify all the signatures: + for i in `find . -name '*.gpg'`; do case $i in *sums*) gpg --verify $i;; *) gpg --verify $i ${i%%.gpg};; 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 redirect at the:www/putty/htaccess which points the + virtual subdir `latest' at the actual latest release dir. TEST THIS + ONE - it's quite important. + + - Update the FTP symlink (chiark:ftp/putty-latest -> putty-). - Check the Docs page links correctly to the release docs. (It should do this automatically, owing to the `latest' HTTP @@ -190,14 +182,43 @@ 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 'git push' in the website checkout, and then 'git pull' in + ~/www/putty on atreus to fetch the website updates. + + - Push the changes to PuTTY itself. Something like: + git push origin master # update the master branch + git push origin --tags # should push the new release tag + git push origin :pre-0.XX # delete the pre-release branch + + - Run 'git push' in the putty-wishlist checkout. Then run 'git pull' + in ~/pub/putty-wishlist on atreus, and update the wishlist web + pages with the commands + cd ~/pub/putty-wishlist/control + perl bugs2html + + - Check over the web site to make sure all the changes to wishlist + and main web pages are present and correct. + + - 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. + + - Edit ~/adm/puttysnap.sh to disable pre-release builds, if they were + previously enabled. - - All done. Probably best to run `cvs up -A' now, or I'll only - forget in a few days' time and get confused... + - Relax (slightly).