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
---------------------------
checking out the release branch and running
make distclean
- ./release.pl --set-version=X.YZ
+ ./release.pl --version=X.YZ --setver
Then check that the resulting automated git commit has updated the
version number in the following places:
- Write a release announcement (basically a summary of the changes
since the last release). Squirrel it away in
- atreus:src/putty-local/announce-<ver> in case it's needed again
+ thyestes:src/putty-local/announce-<ver> 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 <ver>'.
- + Adjust front page to add a news item.
- + Adjust Download page to say 'The latest release version (<ver>)'.
- + 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.
-
- - 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
+ - Update the website, in a local checkout:
+ * Write a release file in components/releases which identifies the
+ new version, a section for the Changes page, and a news
+ announcement for the front page.
+ + The one thing this can't yet contain is the release date;
+ that has to be put in at the last minute, when the release
+ goes live. Fill in 'FIXME', for the moment.
+ * 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.
+
+ - Make a release-candidate build from the release tag, and put the
+ build.out and build.log dfiles somewhere safe. Normally I store
+ these in an adjacent directory, so I'll run a command like
+ bob -o ../X.YZ/build-X.YZ-rcN.out -l ../X.YZ/build-X.YZ-rcN.log -c X.YZ . RELEASE=X.YZ
This should generate a basically valid release directory as
- `build.out/putty', and provide link maps and sign.sh alongside that
- in build.out.
+ `build-X.YZ-rcN.out/putty', and provide link maps and sign.sh
+ alongside that.
- - Double-check in build.log that the release was built from the right
- git commit.
+ - Double-check in build-X.YZ-rcN.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
+ - Sign the release: in the `build-X.YZ-rcN.out' directory, type
sh sign.sh -r putty
and enter the passphrases a lot of times.
+ - For my own safety, make the release candidate build read-only.
+ chmod -R a-w build-X.YZ-rcN.out build-X.YZ-rcN.log
+
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-<version>.
- rsync -av maps-x86/ atreus:src/putty-local/maps-X.YZ
-
- - Upload the entire release directory to atreus:www/putty/<version>.
- rsync -av putty/ atreus:www/putty/X.YZ
-
- - 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-<ver> and to the:www/putty/<ver>.
- rsync -av putty/ chiark:ftp/putty-X.YZ
- rsync -av putty/ the:www/putty/X.YZ
-
- - 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.
+ - Make a final adjustment to your local website changes, filling in
+ the release date in components/releases/X.YZ.mi.
- - Update the FTP symlink (chiark:ftp/putty-latest -> putty-<ver>).
+ - 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,
- .CNT and .CHM files, by downloading one of each and checking
- they're all application/octet-stream.
- for ext in hlp cnt chm; do curl -v http://the.earth.li/~sgtatham/putty/X.YZ/putty.$ext 2>&1 >/dev/null | grep Content-Type; done
+ - 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-X.YZ # 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 thyestes 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 thyestes looks sensible.
- - Run webupdate, so that all the changes on atreus propagate to
+ - Run webupdate, so that all the changes on thyestes 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.
+ subdirectory for the new version and that the links from its
+ latest.html point into that subdirectory.
- Announce the release!
+ Construct a release announcement email whose message body is the
+ Post it to comp.security.ssh.
+ Mention it in <TDHTT> 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).
projects / PuTTY.git / blobdiff