X-Git-Url: https://asedeno.scripts.mit.edu/gitweb/?a=blobdiff_plain;f=CHECKLST.txt;h=f4d412039b4d91b8e319cd8fcf5994733fb29c09;hb=bee656c1b00ec7485e69d6610d149926d8e5bdd9;hp=78e9d22317bf5e0a7e0b838d904449246fb60e62;hpb=7524da621b1689b3384020cd6d83c990ef86bfa1;p=PuTTY.git diff --git a/CHECKLST.txt b/CHECKLST.txt index 78e9d223..f4d41203 100644 --- a/CHECKLST.txt +++ b/CHECKLST.txt @@ -1,43 +1,28 @@ Checklists for PuTTY administrative procedures ============================================== -Locations of the licence ------------------------- +Going into pre-release stabilisation +------------------------------------ -The PuTTY copyright notice and licence are stored in quite a few -places. At the start of a new year, the copyright year needs -updating in all of them; and when someone sends a massive patch, -their name needs adding in all of them too. +When we begin to work towards a release and want to enabling +pre-releases on the website: -The LICENCE file in the main source distribution: + - Make a branch whose tip will be the current state of the + pre-release. Regardless of whether the branch is from master or + from a prior release branch, the name of the branch must now be in + the form 'pre-X.YZ', or else the website will fail to link to it + properly in gitweb and the build script will check out the wrong + thing. - - putty/LICENCE + - Edit ~/adm/puttysnap.sh on my build machine to set $prerelver correctly. -The resource files: + - Edit ~/adm/puttysnap.sh on the master machine to enable pre-release + builds, by changing the 'if false' to 'if true'. - - 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/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.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/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! - -The documentation (both the preamble blurb and the licence appendix): - - - putty/doc/blurb.but - - putty/doc/licence.but - -The website: - - - putty-website/licence.html + - Put the website into pre-release mode, by defining prerel_version() + in components/Base.mc to return the upcoming version number. Also + add a news announcement in components/news. (Previous naming + convention has been to name it in the form 'X.YZ-pre.mi'.) Preparing to make a release --------------------------- @@ -64,29 +49,25 @@ for it: XXX-REVIEW-BEFORE-RELEASE. ('git grep XXX-RE' should only show up hits in this file itself.) - - 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) + - Now update the version numbers and the transcripts in the docs, by + checking out the release branch and running - - 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: + make distclean + ./release.pl --version=X.YZ --setver - perl -e 'printf "%d\n", time/86400 - 1000' + Then check that the resulting automated git commit has updated the + version number in the following places: - and then substitute the resulting value into the definition of - 'Epoch' in Buildscr. + * putty/LATEST.VER + * putty/doc/plink.but + * putty/doc/pscp.but + * putty/windows/putty.iss (four times, on consecutive lines) - - Commit those version number and epoch changes (on the appropriate - branch, of course!), and then make the release tag pointing at the - resulting commit. + and also check that it has reset the definition of 'Epoch' in + Buildscr. + + - Make the release tag, pointing at the version-update commit we just + generated. - If the release is on a branch (which I expect it generally will be), merge that branch to master. @@ -96,34 +77,23 @@ for it: atreus:src/putty-local/announce- in case it's needed again within days of the release going out. - - 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. + - Update the website, in a local checkout: + * Write a release file in components/releases which identifies the + new version, its release date, a section for the Changes page, + and a news announcement for the front page. + * Disable the pre-release sections of the website (if previously + enabled), by editing prerel_version() in components/Base.mc to + return undef. + + - Update the wishlist, in a local checkout: + * If there are any last-minute wishlist entries (e.g. security + vulnerabilities fixed in the new release), write entries for + them. + * If any other bug fixes have been cherry-picked to the release + branch (so that the wishlist mechanism can't automatically mark + them as fixed in the new release), add appropriate Fixed-in + headers for those. + * Add an entry to the @releases array in control/bugs2html. - Build the release, by checking out the release tag: git checkout 0.XX @@ -135,9 +105,13 @@ for it: - 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. + - Do a bit of checking of the release binaries: + * make sure they basically work + * check they report the right version number + * if there's any easily observable behaviour difference between + the release branch and master, arrange to observe it + * test the Windows installer + * test the Unix source tarball. - Sign the release: in the `build.out' directory, type sh sign.sh -r putty @@ -149,55 +123,36 @@ 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-). + - Upload the release itself and its link maps to everywhere it needs + to be, by running this in the build.out directory: + ../release.pl --version=X.YZ --upload - - Check the Docs page links correctly to the release docs. (It - should do this automatically, owing to the `latest' HTTP - redirect.) + - Check that downloads via version-numbered URLs all work: + ../release.pl --version=X.YZ --precheck - - Check that the web server attaches the right content type to .HLP - and .CNT files. + - Switch the 'latest' links over to the new release: + * Update the HTTP redirect at the:www/putty/htaccess . + * Update the FTP symlink at chiark:ftp/putty-latest . - - Run 'git push' in the website checkout, and then 'git pull' in - ~/www/putty on atreus to fetch the website updates. + - Now verify that downloads via the 'latest' URLs are all redirected + correctly and work: + ../release.pl --version=X.YZ --postcheck - - 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 + - Push all the git repositories: + * run 'git push' in the website checkout + * run 'git push' in the wishlist checkout + * push from the main PuTTY checkout. Typically this one will be + pushing both the release tag and an update to the master branch, + plus removing the pre-release branch, so you'll want some + commands along these lines: + 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 + - Run ~/adm/puttyweb.sh on atreus to update the website after all + those git pushes. - - Check over the web site to make sure all the changes to wishlist - and main web pages are present and correct. + - Check that the unpublished website on atreus looks sensible. - Run webupdate, so that all the changes on atreus propagate to chiark. Important to do this _before_ announcing that the release @@ -218,7 +173,7 @@ locally, this is the procedure for putting it up on the web. + Post it to comp.security.ssh. + Mention it in on mono. - - Edit ~/adm/puttysnap.sh to disable pre-release builds, if they were - previously enabled. + - Edit the master ~/adm/puttysnap.sh to disable pre-release builds, + if they were previously enabled. - Relax (slightly).