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/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!
- - putty/mac/macpgen.r
- + the copyright date appears twice, once in the About box and
- once in the Licence box. Don't forget to change both!
- - 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!
+ - 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'.)
-The documentation (both the preamble blurb and the licence appendix):
+Preparing to make a release
+---------------------------
- - putty/doc/blurb.but
- - putty/doc/licence.but
+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 website:
-
- - putty-website/licence.html
-
-Before tagging a release
-------------------------
+To begin with, before dropping the tag, make sure everything is ready
+for it:
- 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.)
-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
-system on the compiler command line, and the _only_ place version
-numbers showed up in the source files was in the tag information.
-
-Unfortunately, those halcyon days are gone, and we do need the
-version number checked in in a couple of places. These must be updated
-_before_ tagging a new release.
+ - 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!
-The file used to generate the Unix snapshot version numbers (which
-are <previousrelease>-<date> so that the Debian versioning system
-orders them correctly with respect to releases):
+ - 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.)
- - putty/LATEST.VER
+ - Now update the version numbers and the transcripts in the docs, by
+ checking out the release branch and running
-The Windows installer script (_four_ times, on consecutive lines):
+ make distclean
+ ./release.pl --version=X.YZ --setver
- - putty/windows/putty.iss
+ Then check that the resulting automated git commit has updated the
+ version number in the following places:
-The Windows resource file (used to generate the binary bit of the
-VERSIONINFO resources -- the strings are supplied by the usual means):
+ * putty/LATEST.VER
+ * putty/doc/plink.but
+ * putty/doc/pscp.but
+ * putty/windows/putty.iss (four times, on consecutive lines)
- - putty/windows/version.rc2 (BASE_VERSION; NB, _comma_-separated)
+ and also check that it has reset the definition of 'Epoch' in
+ Buildscr.
-The Mac resource file (used to generate the binary bit of the 'vers'
-resources):
+ - Make the release tag, pointing at the version-update commit we just
+ generated.
- - putty/mac/version.r
+ - If the release is on a branch (which I expect it generally will
+ be), merge that branch to master.
-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. Sometimes these are marked in between releases as `0.XX', so
-it's worth grepping for that too.
+ - Write a release announcement (basically a summary of the changes
+ since the last release). Squirrel it away in
+ thyestes:src/putty-local/announce-<ver> in case it's needed again
+ within days of the release going out.
- - putty/doc/pscp.but
- - putty/doc/plink.but
- - putty/doc/psftp.but (in case it ever acquires a similar thing)
+ - 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-X.YZ-rcN.out/putty', and provide link maps and sign.sh
+ alongside that.
+
+ - Double-check in build-X.YZ-rcN.log that the release was built from
+ the right git commit.
+
+ - 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-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
----------------------------
-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.
+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.
- - Double-check that we have removed anything tagged with a comment
- containing the words XXX-REMOVE-BEFORE-RELEASE or
- XXX-REVIEW-BEFORE-RELEASE.
+ - Make a final adjustment to your local website changes, filling in
+ the release date in components/releases/X.YZ.mi.
- - Write a release announcement (basically a summary of the changes
- since the last release). Squirrel it away in
- ixion:src/putty/local/announce-<ver> in case it's needed again
- within days of the release going out.
+ - 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 that downloads via version-numbered URLs all work:
+ ../release.pl --version=X.YZ --precheck
+
+ - 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 .
+
+ - Now verify that downloads via the 'latest' URLs are all redirected
+ correctly and work:
+ ../release.pl --version=X.YZ --postcheck
+
+ - 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 ~/adm/puttyweb.sh on thyestes to update the website after all
+ those git pushes.
- - 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=<ver>. 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-<version>.
-
- - 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.
- + 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 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.
- + 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 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 <filenames>; 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.
- + 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 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 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 the md5sums file.
-
- - Now the whole release directory should be present and correct.
- Upload to ixion:www/putty/<ver>.
-
- - 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:
- md5sum -c md5sums
-
- - Having double-checked the release, copy it from ixion to
- chiark:ftp/putty-<ver> and to the:www/putty/<ver>.
-
- - Check the permissions! Actually try downloading from the, to make
- sure it really works.
-
- - 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-<ver>).
-
- - Update web site.
- + Adjust front page (`the latest version is <ver>').
- + Adjust Download page similarly.
- + Adjust filenames of installer and Unix tarball on links in
- Download page.
- + Adjust header text on Changelog page. (That includes changing
- `are new' in previous version to `were new'!)
- + FOR 0.59 ONLY: update the docs page so that it links to the
- release .chm as well as the release .hlp and .cnt. Remove this
- checklist item after it's done; it won't need doing again in
- the subsequent release.
- + FOR 0.59 ONLY: update the Download page to remove all the Alpha
- links. Remove this checklist item after it's done; it won't
- need doing again in the subsequent release.
-
- - Update the wishlist. This can be done without touching individual
- items by editing the @releases array in control/bugs2html.
-
- - Check the Docs page links correctly to the release docs. (It
- should do this automatically, owing to the `latest' HTTP
- redirect.)
-
- - 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
+ - Check that the unpublished website on thyestes looks sensible.
+
+ - Run webupdate, so that all the changes on thyestes 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/<ver>{,/x86,/htmldoc} - before running
- webupdate.
- - After running webupdate, run update-rsync on chiark and verify
- that the rsync mirror package correctly identifies the new
- version.
+ - 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 that the links from its
+ latest.html point into that subdirectory.
- 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.
+ + Construct a release announcement email whose message body is the
+ announcement written above, and which includes the following
+ headers:
+ * Reply-To: <putty@projects.tartarus.org>
+ * Subject: PuTTY X.YZ is released
+ + Mail that release announcement to
+ <putty-announce@lists.tartarus.org>.
+ Post it to comp.security.ssh.
+ Mention it in <TDHTT> on mono.
- - Relax (slightly).
-
-After the release
------------------
+ - Edit the master ~/adm/puttysnap.sh to disable pre-release builds,
+ if they were previously enabled.
-The following want doing some time soon after a release has been made:
-
- - If the release was made from a branch, make sure the version number
- on the _trunk_ is up to date in all the locations listed above, so
- that (e.g.) Unix snapshots come out right.
+ - Relax (slightly).
projects / PuTTY.git / blobdiff