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!
- putty-website/licence.html
-Before tagging a release
-------------------------
+Preparing to make a 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.
+
+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.
+ - 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!
+
+ - 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.)
-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.
+ - 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)
-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):
+ - 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:
- - putty/LATEST.VER
+ perl -e 'printf "%d\n", time/86400 - 1000'
-The Windows installer script (_four_ times, on consecutive lines):
+ and then substitute the resulting value into the definition of
+ 'Epoch' in Buildscr.
+
+ - Commit those version number and epoch changes (on the appropriate
+ branch, of course!), and then make the release tag pointing at the
+ resulting commit.
+
+ - 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
+ atreus: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.
- - putty/windows/putty.iss
+ - 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.
-The Windows resource file (used to generate the binary bit of the
-VERSIONINFO resources -- the strings are supplied by the usual means):
+ - 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.
- - putty/windows/version.rc2 (BASE_VERSION; NB, _comma_-separated)
+ - Update the wishlist mechanism for the new release. This can be done
+ without touching individual items by editing the @releases array in
+ control/bugs2html.
-The Mac resource file (used to generate the binary bit of the 'vers'
-resources):
+ - 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.
- - putty/mac/version.r
+ - Double-check in build.log that the release was built from the right
+ git commit.
-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.
+ - 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.
- - putty/doc/pscp.but
- - putty/doc/plink.but
- - putty/doc/psftp.but (in case it ever acquires a similar thing)
+ - 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
----------------------------
-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 word XXX-REMOVE-BEFORE-RELEASE.
+ - Save the link maps. Currently I keep these on atreus, in
+ src/putty-local/maps-<version>.
- - 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 entire release directory to atreus:www/putty/<version>.
- - 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>.
-
- - 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.
- + change into the doc subdir
- + run `make VERSION="PuTTY release 0.XX" chm', then run `hhc
- putty.hhp' to build the .CHM
- + then move the .CHM somewhere else so `make clean' doesn't blow
- it away
- + then run `make clean'
- + 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 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 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.
- 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.
- + 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.
-
- - 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 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:
- 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
-
- - Now double-check by verifying all the signatures on all the
- files, and running md5sum -c on all the md5sums files.
-
- - 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. In each directory:
+ - 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 ixion to
+ - Having double-checked the release, copy it from atreus 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 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-<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 NEXT RELEASE 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.
-
- - 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
+ - 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.
- * Don't forget to create the new directories on chiark -
- ~/www/putty/<ver>{,/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
- 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 mentions it in its .htaccess.
- 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 ~/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