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