1 Checklists for PuTTY administrative procedures
2 ==============================================
4 Locations of the licence
5 ------------------------
7 The PuTTY copyright notice and licence are stored in quite a few
8 places. At the start of a new year, the copyright year needs
9 updating in all of them; and when someone sends a massive patch,
10 their name needs adding in all of them too.
12 The LICENCE file in the main source distribution:
18 - putty/windows/pageant.rc
19 + the copyright date appears twice, once in the About box and
20 once in the Licence box. Don't forget to change both!
21 - putty/windows/puttygen.rc
22 + the copyright date appears twice, once in the About box and
23 once in the Licence box. Don't forget to change both!
24 - putty/windows/win_res.rc
25 + the copyright date appears twice, once in the About box and
26 once in the Licence box. Don't forget to change both!
28 + the copyright date appears twice, once in the About box and
29 once in the Licence box. Don't forget to change both!
31 + the copyright date appears twice, once in the About box and
32 once in the Licence box. Don't forget to change both!
34 + the copyright date appears twice, once in the About box and
35 once in the Licence box. Don't forget to change both!
37 The documentation (both the preamble blurb and the licence appendix):
40 - putty/doc/licence.but
44 - putty-website/licence.html
46 Before tagging a release
47 ------------------------
49 - First of all, go through the source and remove anything tagged
50 with a comment containing the word XXX-REMOVE-BEFORE-RELEASE.
52 For a long time we got away with never checking the current version
53 number in at all - all version numbers were passed into the build
54 system on the compiler command line, and the _only_ place version
55 numbers showed up in the source files was in the tag information.
57 Unfortunately, those halcyon days are gone, and we do need the
58 version number checked in in a couple of places. These must be updated
59 _before_ tagging a new release.
61 The file used to generate the Unix snapshot version numbers (which
62 are <previousrelease>-<date> so that the Debian versioning system
63 orders them correctly with respect to releases):
67 The Windows installer script:
69 - putty/windows/putty.iss
71 The Mac resource file (used to generate the binary bit of the 'vers'
72 resources -- the strings are supplied by the usual means):
76 It might also be worth going through the documentation looking for
77 version numbers - we have a couple of transcripts showing the help
78 text from the command-line tools, and it would be nice to ensure the
79 whole transcripts (certainly including the version numbers) are up
80 to date. Sometimes these are marked in between releases as `0.XX', so
81 it's worth grepping for that too.
85 - putty/doc/psftp.but (in case it ever acquires a similar thing)
87 The actual release procedure
88 ----------------------------
90 This is the procedure I (SGT) currently follow (or _should_ follow
91 :-) when actually making a release, once I'm happy with the position
94 - Double-check that we have removed anything tagged with a comment
95 containing the word XXX-REMOVE-BEFORE-RELEASE.
97 - Write a release announcement (basically a summary of the changes
98 since the last release). Squirrel it away in
99 ixion:src/putty/local/announce-<ver> in case it's needed again
100 within days of the release going out.
102 - On my local machines, check out the release-tagged version of the
103 sources. Do this in a _clean_ directory; don't depend on my usual
105 + Make sure to run mkfiles.pl _after_ this checkout, just in
108 - Build the source archives now, while the directory is still
110 + run ./mksrcarc.sh to build the Windows source zip.
111 + run `./mkunxarc.sh X.YZ' to build the Unix tarball.
113 - Build the Windows/x86 release binaries. Don't forget to supply
114 VER=/DRELEASE=<ver>. Run them, or at least one or two of them, to
115 ensure that they really do report their version number correctly.
116 + Save the release link maps. Currently I keep these on ixion,
117 in src/putty/local/maps-<version>.
119 - Acquire the Windows/alpha release binaries from Owen.
120 + Verify the signatures on these, to ensure they're really the
121 ones he built. If I'm going to sign a zip file I make out of
122 these, I'm damn well going to make sure the binaries that go
123 _into_ it are signed themselves.
124 + Make sure Owen has kept the Alpha release link maps somewhere
127 - Run Halibut to build the docs. Define VERSION on the make command
128 line to override the version strings, since Subversion revision
129 numbers are less meaningful on a tag.
130 + make -C doc VERSION="PuTTY release 0.XX"
132 - Build the binary archives putty.zip (one for each architecture):
133 each one just contains all the .exe files except PuTTYtel, and
134 the .hlp and .cnt files.
135 + zip -k putty.zip `ls *.exe | grep -v puttytel` putty.hlp putty.cnt
136 + same again for Alpha.
138 - Build the docs archive puttydoc.zip: it contains all the HTML
139 files output from Halibut.
140 + zip puttydoc.zip *.html
142 - Build the installer.
144 - Sign the release (gpg --detach-sign).
145 + Sign the locally built x86 binaries, the locally built x86
146 binary zipfile, and the locally built x86 installer, with the
148 + The Alpha binaries should already have been signed with the
149 release keys. Having checked that, sign the Alpha binary
150 zipfile with the release keys too.
151 + The source archive should be signed with the release keys.
152 + Don't forget to sign with both DSA and RSA keys for absolutely
154 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
156 - Begin to pull together the release directory structure.
157 + subdir `x86' containing the x86 binaries, x86 binary zip, x86
158 installer, and all signatures on the above.
159 + subdir `alpha' containing the Alpha binaries, Alpha binary
160 zip, and all signatures on the above.
161 + top-level dir contains the Windows source zip (plus
162 signatures), the Unix source tarball (plus signatures),
163 puttydoc.txt, the .hlp and .cnt files, and puttydoc.zip.
165 - Create subdir `htmldoc' in the release directory, which should
166 contain exactly the same set of HTML files that went into
168 + It also needs a copy of sitestyle.css, because the online
169 versions of the HTML docs will link to this (although the
170 zipped form should be self-contained).
172 - Create and sign md5sums files: one in the x86 subdir, one in the
173 alpha subdir, and one in the parent dir of both of those.
174 + The md5sums files need not list the .DSA and .RSA signatures,
175 and the top-level md5sums need not list the other two. Easiest
176 thing is to run, in each directory, this command:
177 md5sum `\find * -name '*SA' -o -type f -print` > md5sums
178 + Sign the md5sums files (gpg --clearsign).
179 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
181 - Now double-check by verifying all the signatures on all the
182 files, and running md5sum -c on all the md5sums files.
184 - Now the whole release directory should be present and correct.
185 Upload to ixion:www/putty/<ver>.
187 - Do final checks on the release directory:
188 + verify all the signatures. In each directory:
189 for i in *.*SA; do case $i in md5sums*) gpg --verify $i;; *) gpg --verify $i `echo $i | sed 's/\..SA$//'`;; esac; done
190 + check the md5sums. In each directory:
193 - Having double-checked the release, copy it from ixion to
194 chiark:ftp/putty-<ver> and to the:www/putty/<ver>.
196 - Check the permissions! Actually try downloading from the, to make
197 sure it really works.
199 - Update the HTTP redirects.
200 + Update the one at the:www/putty/htaccess which points the
201 virtual subdir `latest' at the actual latest release dir. TEST
202 THIS ONE - it's quite important.
203 + ixion:www/putty/.htaccess has an individual redirect for each
204 version number. Add a new one.
206 - Update the FTP symlink (chiark:ftp/putty-latest -> putty-<ver>).
209 + Adjust front page (`the latest version is <ver>').
210 + Adjust Download page similarly.
211 + Adjust filenames of installer and Unix tarball on links in
213 + Adjust header text on Changelog page. (That includes changing
214 `are new' in previous version to `were new'!)
216 - Update the wishlist. This can be done without touching individual
217 items by editing the @releases array in control/bugs2html.
219 - Check the Docs page links correctly to the release docs. (It
220 should do this automatically, owing to the `latest' HTTP
223 - Check that the web server attaches the right content type to .HLP
226 - Run webupdate, so that all the changes on ixion propagate to
227 chiark. Important to do this _before_ announcing that the release
229 * Don't forget to create the new directories on chiark -
230 ~/www/putty/<ver>{,/x86,/alpha,/htmldoc} - before running
233 - After running webupdate, run update-rsync on chiark and verify
234 that the rsync mirror package correctly identifies the new
237 - Announce the release!
238 + Mail the announcement to putty-announce.
239 + Post it to comp.security.ssh.
240 + Mention it in <TDHTT> on mono.
247 The following want doing some time soon after a release has been made:
249 - If the release was made from a branch, make sure the version number
250 on the _trunk_ is up to date in all the locations listed above, so
251 that (e.g.) Unix snapshots come out right.