Commit | Line | Data |
---|---|---|
49781f4a AB |
1 | =encoding utf8 |
2 | ||
7277a900 GS |
3 | =head1 NAME |
4 | ||
5 | release_managers_guide - Releasing a new version of perl 5.x | |
6 | ||
c67d51c3 DM |
7 | As of August 2009, this file is mostly complete, although it is missing |
8 | some detail on doing a major release (e.g. 5.10.0 -> 5.12.0). Note that | |
d60a1044 DM |
9 | things change at each release, so there may be new things not covered |
10 | here, or tools may need updating. | |
f6af4394 | 11 | |
7277a900 GS |
12 | =head1 SYNOPSIS |
13 | ||
f6af4394 DM |
14 | This document describes the series of tasks required - some automatic, some |
15 | manual - to produce a perl release of some description, be that a snaphot, | |
8c35d285 | 16 | release candidate, or final, numbered release of maint or blead. |
f6af4394 | 17 | |
8c35d285 | 18 | The release process has traditionally been executed by the current |
ee76d676 JV |
19 | pumpking. Blead releases from 5.11.0 forward are made each month on the |
20 | 20th by a non-pumpking release engineer. The release engineer roster | |
21 | and schedule can be found in Porting/release_schedule.pod. | |
7277a900 | 22 | |
8c35d285 JV |
23 | This document both helps as a check-list for the release engineer |
24 | and is a base for ideas on how the various tasks could be automated | |
25 | or distributed. | |
7277a900 | 26 | |
636a1918 | 27 | The outline of a typical release cycle is as follows: |
f6af4394 | 28 | |
636a1918 | 29 | (5.10.1 is released, and post-release actions have been done) |
f6af4394 DM |
30 | |
31 | ...time passes... | |
32 | ||
33 | an occasional snapshot is released, that still identifies itself as | |
34 | 5.10.1 | |
35 | ||
36 | ...time passes... | |
37 | ||
38 | a few weeks before the release, a number of steps are performed, | |
39 | including bumping the version to 5.10.2 | |
636a1918 DM |
40 | |
41 | ...a few weeks passes... | |
46743ef7 | 42 | |
f6af4394 DM |
43 | perl-5.10.2-RC1 is released |
44 | ||
45 | perl-5.10.2 is released | |
46 | ||
47 | post-release actions are performed, including creating new | |
c5b87fed | 48 | perldelta.pod |
f6af4394 DM |
49 | |
50 | ... the cycle continues ... | |
7277a900 GS |
51 | |
52 | =head1 DETAILS | |
53 | ||
8c35d285 JV |
54 | Some of the tasks described below apply to all four types of |
55 | release of Perl. (snapshot, RC, final release of maint, final | |
56 | release of blead). Some of these tasks apply only to a subset | |
57 | of these release types. If a step does not apply to a given | |
58 | type of release, you will see a notation to that effect at | |
59 | the beginning of the step. | |
60 | ||
61 | =head2 Release types | |
62 | ||
63 | =over 4 | |
64 | ||
65 | =item Snapshot | |
66 | ||
67 | A snapshot is intended to encourage in-depth testing from time-to-time, | |
68 | for example after a key point in the stabilisation of a branch. It | |
69 | requires fewer steps than a full release, and the version number of perl in | |
70 | the tarball will usually be the same as that of the previous release. | |
71 | ||
72 | =item Release Candidate (RC) | |
73 | ||
d60a1044 DM |
74 | A release candidate is an attempt to produce a tarball that is a close as |
75 | possible to the final release. Indeed, unless critical faults are found | |
76 | during the RC testing, the final release will be identical to the RC | |
77 | barring a few minor fixups (updating the release date in F<perlhist.pod>, | |
78 | removing the RC status from F<patchlevel.h>, etc). If faults are found, | |
79 | then the fixes should be put into a new release candidate, never directly | |
80 | into a final release. | |
8c35d285 JV |
81 | |
82 | =item Stable/Maint release | |
83 | ||
84 | At this point you should have a working release candidate with few or no | |
85 | changes since. | |
86 | ||
87 | It's essentially the same procedure as for making a release candidate, but | |
88 | with a whole bunch of extra post-release steps. | |
89 | ||
90 | =item Blead release | |
91 | ||
92 | It's essentially the same procedure as for making a release candidate, but | |
93 | with a whole bunch of extra post-release steps. | |
94 | ||
95 | =back | |
7277a900 | 96 | |
fd838dcf JV |
97 | =head2 Prerequisites |
98 | ||
99 | Before you can make an official release of perl, there are a few | |
100 | hoops you need to jump through: | |
101 | ||
102 | =over 4 | |
103 | ||
8c35d285 JV |
104 | =item PAUSE account |
105 | ||
106 | I<SKIP this step for SNAPSHOT> | |
fd838dcf JV |
107 | |
108 | Make sure you have a PAUSE account suitable for uploading a perl release. | |
109 | If you don't have a PAUSE account, then request one: | |
110 | ||
111 | https://pause.perl.org/pause/query?ACTION=request_id | |
112 | ||
113 | Check that your account is allowed to upload perl distros: goto | |
b386fa44 | 114 | L<https://pause.perl.org/>, login, then select 'upload file to CPAN'; there |
fd838dcf | 115 | should be a "For pumpkings only: Send a CC" tickbox. If not, ask Andreas |
e03f126c | 116 | KE<0xf6>nig to add your ID to the list of people allowed to upload something |
fd838dcf | 117 | called perl. You can find Andreas' email address at: |
4d2c8158 | 118 | |
fd838dcf JV |
119 | https://pause.perl.org/pause/query?ACTION=pause_04imprint |
120 | ||
fdabea7a JV |
121 | =item search.cpan.org |
122 | ||
123 | Make sure that search.cpan.org knows that you're allowed to upload | |
124 | perl distros. Contact Graham Barr to make sure that you're on the right | |
125 | list. | |
126 | ||
8c35d285 JV |
127 | =item CPAN mirror |
128 | ||
129 | Some release engineering steps require a full mirror of the CPAN. | |
130 | Work to fall back to using a remote mirror via HTTP is incomplete | |
131 | but ongoing. (No, a minicpan mirror is not sufficient) | |
132 | ||
133 | =item git checkout and commit bit | |
fd838dcf JV |
134 | |
135 | You will need a working C<git> installation, checkout of the perl | |
136 | git repository and perl commit bit. For information about working | |
137 | with perl and git, see F<pod/perlrepository.pod>. | |
138 | ||
139 | If you are not yet a perl committer, you won't be able to make a | |
140 | release. Have a chat with whichever evil perl porter tried to talk | |
141 | you into the idea in the first place to figure out the best way to | |
142 | resolve the issue. | |
143 | ||
f6af4394 | 144 | |
8c35d285 | 145 | =item Quotation for release announcement epigraph |
f6af4394 | 146 | |
8c35d285 | 147 | I<SKIP this step for SNAPSHOT and RC> |
f6af4394 | 148 | |
8c35d285 JV |
149 | For a numbered blead or maint release of perl, you will need a quotation |
150 | to use as an epigraph to your release announcement. (There's no harm | |
151 | in having one for a snapshot, but it's not required). | |
46743ef7 | 152 | |
f6af4394 DM |
153 | |
154 | =back | |
155 | ||
b82efa27 | 156 | |
2e831dfd | 157 | =head2 Building a release - advance actions |
8c35d285 JV |
158 | |
159 | The work of building a release candidate for a numbered release of | |
160 | perl generally starts several weeks before the first release candidate. | |
52a66c2c DM |
161 | Some of the following steps should be done regularly, but all I<must> be |
162 | done in the run up to a release. | |
7277a900 GS |
163 | |
164 | =over 4 | |
165 | ||
f6af4394 DM |
166 | =item * |
167 | ||
8c35d285 JV |
168 | I<You MAY SKIP this step for SNAPSHOT> |
169 | ||
f6af4394 DM |
170 | Ensure that dual-life CPAN modules are synchronised with CPAN. Basically, |
171 | run the following: | |
172 | ||
db3f805e | 173 | $ ./perl -Ilib Porting/core-cpan-diff -a -o /tmp/corediffs |
7277a900 | 174 | |
f6af4394 DM |
175 | to see any inconsistencies between the core and CPAN versions of distros, |
176 | then fix the core, or cajole CPAN authors as appropriate. See also the | |
177 | C<-d> and C<-v> options for more detail. You'll probably want to use the | |
04dbb930 DG |
178 | C<-c cachedir> option to avoid repeated CPAN downloads and may want to |
179 | use C<-m file:///mirror/path> if you made a local CPAN mirror. | |
7277a900 | 180 | |
f6af4394 | 181 | To see which core distro versions differ from the current CPAN versions: |
7277a900 | 182 | |
db3f805e | 183 | $ ./perl -Ilib Porting/core-cpan-diff -x -a |
7277a900 | 184 | |
52a66c2c | 185 | If you are making a maint release, run C<core-cpan-diff> on both blead and |
636a1918 DM |
186 | maint, then diff the two outputs. Compare this with what you expect, and if |
187 | necessary, fix things up. For example, you might think that both blead | |
188 | and maint are synchronised with a particular CPAN module, but one might | |
189 | have some extra changes. | |
190 | ||
f6af4394 | 191 | =item * |
7277a900 | 192 | |
8c35d285 JV |
193 | I<You MAY SKIP this step for SNAPSHOT> |
194 | ||
f6af4394 | 195 | Ensure dual-life CPAN modules are stable, which comes down to: |
7277a900 GS |
196 | |
197 | for each module that fails its regression tests on $current | |
f6af4394 DM |
198 | did it fail identically on $previous? |
199 | if yes, "SEP" (Somebody Else's Problem) | |
200 | else work out why it failed (a bisect is useful for this) | |
7277a900 GS |
201 | |
202 | attempt to group failure causes | |
203 | ||
204 | for each failure cause | |
f6af4394 DM |
205 | is that a regression? |
206 | if yes, figure out how to fix it | |
207 | (more code? revert the code that broke it) | |
208 | else | |
209 | (presumably) it's relying on something un-or-under-documented | |
210 | should the existing behaviour stay? | |
211 | yes - goto "regression" | |
212 | no - note it in perldelta as a significant bugfix | |
213 | (also, try to inform the module's author) | |
1aff5354 | 214 | |
f6af4394 | 215 | =item * |
7277a900 | 216 | |
8c35d285 JV |
217 | I<You MAY SKIP this step for SNAPSHOT> |
218 | ||
f6af4394 | 219 | Similarly, monitor the smoking of core tests, and try to fix. |
f85d27e8 | 220 | See L<http://doc.procura.nl/smoke/index.html> for a summary. |
7277a900 | 221 | |
f6af4394 | 222 | =item * |
7277a900 | 223 | |
8c35d285 JV |
224 | I<You MAY SKIP this step for SNAPSHOT> |
225 | ||
636a1918 DM |
226 | Similarly, monitor the smoking of perl for compiler warnings, and try to |
227 | fix. | |
228 | ||
229 | =item * | |
230 | ||
8c35d285 JV |
231 | I<You MAY SKIP this step for SNAPSHOT> |
232 | ||
f6af4394 DM |
233 | Run F<Porting/cmpVERSION.pl> to compare the current source tree with the |
234 | previous version to check for for modules that have identical version | |
235 | numbers but different contents, e.g.: | |
7277a900 | 236 | |
f6af4394 | 237 | $ cd ~/some-perl-root |
4c0f950e | 238 | $ ./perl -Ilib Porting/cmpVERSION.pl -xd . v5.10.0 |
f6af4394 DM |
239 | |
240 | then bump the version numbers of any non-dual-life modules that have | |
241 | changed since the previous release, but which still have the old version | |
242 | number. If there is more than one maintenance branch (e.g. 5.8.x, 5.10.x), | |
243 | then compare against both. | |
244 | ||
04dbb930 DG |
245 | Be sure to bump the version numbers in separate commits for each module |
246 | (or group of related modules) so that changes can be cherry-picked later | |
247 | if necessary. | |
248 | ||
f6af4394 DM |
249 | Note that some of the files listed may be generated (e.g. copied from ext/ |
250 | to lib/, or a script like lib/lib_pm.PL is run to produce lib/lib.pm); | |
251 | make sure you edit the correct file! | |
252 | ||
253 | Once all version numbers have been bumped, re-run the checks. | |
254 | ||
255 | Then run again without the -x option, to check that dual-life modules are | |
256 | also sensible. | |
257 | ||
4c0f950e | 258 | $ ./perl -Ilib Porting/cmpVERSION.pl -d . v5.10.0 |
54356a6f | 259 | |
55878aed JV |
260 | =item * |
261 | ||
8c35d285 JV |
262 | I<You MAY SKIP this step for SNAPSHOT> |
263 | ||
f6af4394 | 264 | Get perldelta in a mostly finished state. |
db3f805e | 265 | |
04c2c53e | 266 | Read F<Porting/how_to_write_a_perldelta.pod>, and try to make sure that |
636a1918 DM |
267 | every section it lists is, if necessary, populated and complete. Copy |
268 | edit the whole document. | |
f6af4394 DM |
269 | |
270 | =item * | |
271 | ||
8c35d285 JV |
272 | I<You MUST SKIP this step for SNAPSHOT> |
273 | ||
04dbb930 DG |
274 | Bump the version number (e.g. from 5.12.0 to 5.12.1). |
275 | ||
276 | For a blead release, this can happen on the day of the release. For a | |
277 | release candidate for a stable perl, this should happen a week or two | |
278 | before the first release candidate to allow sufficient time for testing and | |
279 | smoking with the target version built into the perl executable. For | |
280 | subsequent release candidates and the final release, it it not necessary to | |
281 | bump the version further. | |
f6af4394 DM |
282 | |
283 | There is a tool to semi-automate this process. It works in two stages. | |
284 | First, it generates a list of suggested changes, which you review and | |
285 | edit; then you feed this list back and it applies the edits. So, first | |
52a66c2c DM |
286 | scan the source directory looking for likely candidates. The command line |
287 | arguments are the old and new version numbers, and -s means scan: | |
f6af4394 DM |
288 | |
289 | $ Porting/bump-perl-version -s 5.10.0 5.10.1 > /tmp/scan | |
290 | ||
52a66c2c | 291 | This produces a file containing a list of suggested edits, e.g.: |
f6af4394 DM |
292 | |
293 | NetWare/Makefile | |
294 | ||
295 | 89: -MODULE_DESC = "Perl 5.10.0 for NetWare" | |
296 | +MODULE_DESC = "Perl 5.10.1 for NetWare" | |
297 | ||
298 | i.e. in the file F<NetWare/Makefile>, line 89 would be changed as shown. | |
299 | Review the file carefully, and delete any -/+ line pairs that you don't | |
52a66c2c DM |
300 | want changing. You can also edit just the C<+> line to change the |
301 | suggested replacement text. Remember that this tool is largely just | |
302 | grepping for '5.10.0' or whatever, so it will generate false positives. Be | |
303 | careful not change text like "this was fixed in 5.10.0"! Then run: | |
f6af4394 DM |
304 | |
305 | $ Porting/bump-perl-version -u < /tmp/scan | |
306 | ||
54356a6f | 307 | which will update all the files shown. |
f6af4394 DM |
308 | |
309 | Be particularly careful with F<INSTALL>, which contains a mixture of | |
310 | C<5.10.0>-type strings, some of which need bumping on every release, and | |
e03f126c Z |
311 | some of which need to be left unchanged. |
312 | The line in F<INSTALL> about "is binary incompatible with" requires a | |
313 | correct choice of earlier version to declare incompatibility with. | |
314 | ||
315 | Also note that this tool | |
52a66c2c DM |
316 | currently only detects a single substitution per line: so in particular, |
317 | this line in README.vms needs special handling: | |
f6af4394 DM |
318 | |
319 | rename perl-5^.10^.1.dir perl-5_10_1.dir | |
7277a900 | 320 | |
45ce9531 | 321 | When doing a blead release, also make sure the C<PERL_API_*> constants in |
e43cb88f TM |
322 | F<patchlevel.h> are in sync with the version you're releasing, unless you're |
323 | absolutely sure the release you're about to make is 100% binary compatible | |
324 | to an earlier release. When releasing a stable perl version, the C<PERL_API_*> | |
325 | constants C<MUST NOT> be changed as we aim to guarantee binary compatibility | |
326 | in maint branches. | |
45ce9531 | 327 | |
54356a6f JV |
328 | Commit your changes: |
329 | ||
330 | $ git st | |
e91bd5c0 LB |
331 | $ git diff |
332 | B<review the delta carefully> | |
54356a6f JV |
333 | |
334 | $ git commit -a -m 'Bump the perl version in various places for 5.x.y' | |
dc0a62a1 | 335 | |
81fc59ef DG |
336 | When the version number is bumped, you should also update Module::CoreList (as |
337 | described below in L<"Building a release - on the day">) to reflect the new | |
338 | version number. | |
339 | ||
dc0a62a1 DM |
340 | =item * |
341 | ||
8c35d285 JV |
342 | I<You MUST SKIP this step for SNAPSHOT> |
343 | ||
dc0a62a1 DM |
344 | Review and update INSTALL to account for the change in version number; |
345 | in particular, the "Coexistence with earlier versions of perl 5" section. | |
346 | ||
c1b1cb88 FR |
347 | Be particularly careful with the section "Upgrading from 5.X.Y or earlier". For |
348 | stable releases, this needs to refer to the last release in the previous | |
349 | development cycle. For blead releases, it needs to refer to the previous blead | |
350 | release. | |
351 | ||
f6af4394 | 352 | =item * |
7277a900 | 353 | |
b82efa27 RS |
354 | I<You MUST SKIP this step for SNAPSHOT> |
355 | ||
356 | Update the F<Changes> file to contain the git log command which would show | |
357 | all the changes in this release. You will need assume the existence of a | |
358 | not-yet created tag for the forthcoming release; e.g. | |
359 | ||
360 | git log ... perl-5.10.0..perl-5.12.0 | |
361 | ||
362 | Due to warts in the perforce-to-git migration, some branches require extra | |
363 | exclusions to avoid other branches being pulled in. Make sure you have the | |
364 | correct incantation: replace the not-yet-created tag with C<HEAD> and see | |
365 | if C<git log> produces roughly the right number of commits across roughly the | |
366 | right time period (you may find C<git log --pretty=oneline | wc> useful). | |
367 | ||
368 | =item * | |
369 | ||
52a66c2c DM |
370 | Check some more build configurations. The check that setuid builds and |
371 | installs is for < 5.11.0 only. | |
372 | ||
373 | $ sh Configure -Dprefix=/tmp/perl-5.x.y -Uinstallusrbinperl \ | |
374 | -Duseshrplib -Dd_dosuid | |
375 | $ make | |
376 | $ LD_LIBRARY_PATH=`pwd` make test # or similar for useshrplib | |
7277a900 | 377 | |
52a66c2c DM |
378 | $ make suidperl |
379 | $ su -c 'make install' | |
380 | $ ls -l .../bin/sperl | |
381 | -rws--x--x 1 root root 69974 2009-08-22 21:55 .../bin/sperl | |
7277a900 | 382 | |
52a66c2c | 383 | (Then delete the installation directory.) |
7277a900 | 384 | |
52a66c2c | 385 | XXX think of other configurations that need testing. |
7277a900 | 386 | |
f6af4394 | 387 | =item * |
7277a900 | 388 | |
8c35d285 JV |
389 | I<You MAY SKIP this step for SNAPSHOT> |
390 | ||
347f5124 RGS |
391 | L<perlport> has a section currently named I<Supported Platforms> that |
392 | indicates which platforms are known to build in the current release. | |
393 | If necessary update the list and the indicated version number. | |
394 | ||
2e831dfd DM |
395 | =back |
396 | ||
397 | =head2 Building a release - on the day | |
398 | ||
399 | This section describes the actions required to make a release (or snapshot | |
400 | etc) that are performed on the actual day. | |
401 | ||
402 | =over 4 | |
403 | ||
404 | =item * | |
405 | ||
406 | Review all the items in the previous section, | |
407 | L<"Building a release - advance actions"> to ensure they are all done and | |
408 | up-to-date. | |
409 | ||
8c35d285 JV |
410 | =item * |
411 | ||
04dbb930 DG |
412 | For a blead release, if you did not bump the perl version number as part |
413 | of I<advance actions>, do that now. | |
414 | ||
415 | =item * | |
416 | ||
a0db33fe | 417 | I<You MAY SKIP this step for SNAPSHOT> |
2e831dfd | 418 | |
04dbb930 | 419 | Finalize the perldelta. In particular, fill in the Acknowledgements |
38195a8c DG |
420 | section. You can generate a list of contributors with checkAUTHORS.pl. |
421 | For example: | |
422 | ||
423 | $ git log --pretty=fuller v5.13.2..HEAD | \ | |
424 | perl Porting/checkAUTHORS.pl --who - | |
04dbb930 | 425 | |
a0db33fe DM |
426 | Re-read the perldelta to try to find any embarrassing typos and thinkos; |
427 | remove any C<TODO> or C<XXX> flags; update the "Known Problems" section | |
428 | with any serious issues for which fixes are not going to happen now; and | |
429 | run through pod and spell checkers, e.g. | |
2e831dfd | 430 | |
c5b87fed FR |
431 | $ podchecker -warnings -warnings pod/perldelta.pod |
432 | $ spell pod/perldelta.pod | |
2e831dfd | 433 | |
a0db33fe DM |
434 | Also, you may want to generate and view an HTML version of it to check |
435 | formatting, e.g. | |
2e831dfd | 436 | |
c5b87fed | 437 | $ perl pod/pod2html pod/perldelta.pod > /tmp/perldelta.html |
2e831dfd | 438 | |
38195a8c DG |
439 | Another good HTML preview option is http://search.cpan.org/pod2html |
440 | ||
441 | If you make changes, be sure to commit them. | |
442 | ||
8c35d285 JV |
443 | =item * |
444 | ||
a0db33fe DM |
445 | Make sure you have a gitwise-clean perl directory (no modified files, |
446 | unpushed commits etc): | |
8c35d285 | 447 | |
38195a8c | 448 | $ git clean -dxf |
a0db33fe | 449 | $ git status |
8c35d285 JV |
450 | |
451 | =item * | |
452 | ||
a0db33fe DM |
453 | If not already built, Configure and build perl so that you have a Makefile |
454 | and porting tools: | |
8c35d285 | 455 | |
52a66c2c | 456 | $ ./Configure -Dusedevel -des && make |
8c35d285 JV |
457 | |
458 | =item * | |
459 | ||
a0db33fe DM |
460 | Check that files managed by F<regen.pl> and friends are up to date. From |
461 | within your working directory: | |
8c35d285 | 462 | |
a0db33fe | 463 | $ git status |
8f83713a | 464 | $ make regen_all |
a0db33fe DM |
465 | $ make regen_perly |
466 | $ git status | |
8c35d285 | 467 | |
a0db33fe DM |
468 | If any of the files managed by F<regen.pl> have changed, then you should |
469 | re-make perl to check that it's okay, then commit the updated versions: | |
8c35d285 | 470 | |
73ec421b | 471 | $ git commit -a -m 'make regen; make regen_perly' |
8c35d285 | 472 | |
38195a8c DG |
473 | (XXX regen might be a problem depending on the bison version available. |
474 | We need to get a wizard to give better instructions on what to do or not do.) | |
475 | ||
8c35d285 JV |
476 | =item * |
477 | ||
bfadf2ba JV |
478 | I<You MUST SKIP this step for SNAPSHOT> |
479 | ||
1bac61bb | 480 | Update C<Module::CoreList> with module version data for the new release. |
bfadf2ba JV |
481 | |
482 | Note that if this is a maint release, you should run the following actions | |
1bac61bb | 483 | from the maint branch, but commit the C<CoreList.pm> changes in |
38195a8c | 484 | I<blead> and subsequently cherry-pick it. XXX need a better example |
bfadf2ba | 485 | |
a0db33fe | 486 | F<corelist.pl> uses ftp.funet.fi to verify information about dual-lived |
bfadf2ba | 487 | modules on CPAN. It can use a full, local CPAN mirror or fall back |
e8c01f92 SH |
488 | to C<wget> or C<curl> to fetch only package metadata remotely. (If you're |
489 | on Win32, then installing Cygwin is one way to have commands like C<wget> | |
490 | and C<curl> available.) | |
bfadf2ba JV |
491 | |
492 | (If you'd prefer to have a full CPAN mirror, see | |
493 | http://www.cpan.org/misc/cpan-faq.html#How_mirror_CPAN) | |
494 | ||
a0db33fe | 495 | Then change to your perl checkout, and if necessary, |
bfadf2ba | 496 | |
595f83ae | 497 | $ make |
bfadf2ba | 498 | |
81fc59ef DG |
499 | If this not the first update for this version (e.g. if it was updated |
500 | when the version number was originally bumped), first edit | |
d5bddf6e | 501 | F<dist/Module-CoreList/lib/Module/CoreList.pm> to delete the existing |
2ce7d676 RGS |
502 | entries for this version from the C<%released> and C<%version> hashes: |
503 | they will have a key like C<5.010001> for 5.10.1. | |
52a66c2c DM |
504 | |
505 | XXX the edit-in-place functionality of Porting/corelist.pl should | |
506 | be fixed to handle this automatically. | |
507 | ||
bf8ea215 | 508 | Then, If you have a local CPAN mirror, run: |
bfadf2ba | 509 | |
bfadf2ba JV |
510 | $ ./perl -Ilib Porting/corelist.pl ~/my-cpan-mirror |
511 | ||
512 | Otherwise, run: | |
513 | ||
bfadf2ba JV |
514 | $ ./perl -Ilib Porting/corelist.pl cpan |
515 | ||
52a66c2c | 516 | This will chug for a while, possibly reporting various warnings about |
2a720090 | 517 | badly-indexed CPAN modules unrelated to the modules actually in core. |
2ce7d676 | 518 | Assuming all goes well, it will update |
d5bddf6e | 519 | F<dist/Module-CoreList/lib/Module/CoreList.pm>. |
bfadf2ba JV |
520 | |
521 | Check that file over carefully: | |
522 | ||
d5bddf6e | 523 | $ git diff dist/Module-CoreList/lib/Module/CoreList.pm |
bfadf2ba | 524 | |
bfadf2ba JV |
525 | If necessary, bump C<$VERSION> (there's no need to do this for |
526 | every RC; in RC1, bump the version to a new clean number that will | |
527 | appear in the final release, and leave as-is for the later RCs and final). | |
528 | ||
529 | Edit the version number in the new C<< 'Module::CoreList' => 'X.YZ' >> | |
530 | entry, as that is likely to reflect the previous version number. | |
531 | ||
e8c01f92 SH |
532 | Also edit Module::CoreList's new version number in its F<Changes> file and |
533 | in its F<META.yml> file. | |
534 | ||
a0db33fe | 535 | In addition, if this is a final release (rather than a release candidate): |
bfadf2ba JV |
536 | |
537 | =over 4 | |
538 | ||
539 | =item * | |
540 | ||
541 | Update this version's entry in the C<%released> hash with today's date. | |
542 | ||
543 | =item * | |
544 | ||
545 | Make sure that the script has correctly updated the C<CAVEATS> section | |
546 | ||
547 | =back | |
548 | ||
549 | Finally, commit the new version of Module::CoreList: | |
a0db33fe DM |
550 | (unless this is for maint; in which case commit it blead first, then |
551 | cherry-pick it back). | |
bfadf2ba | 552 | |
770cf6ff | 553 | $ git commit -m 'Update Module::CoreList for 5.x.y' dist/Module-CoreList/lib/Module/CoreList.pm |
bfadf2ba | 554 | |
bfadf2ba JV |
555 | =item * |
556 | ||
a0db33fe | 557 | Check that the manifest is sorted and correct: |
8c35d285 | 558 | |
a0db33fe DM |
559 | $ make manisort |
560 | $ make distclean | |
300b5357 | 561 | $ git clean -xdf # This shouldn't be necessary if distclean is correct |
a0db33fe | 562 | $ perl Porting/manicheck |
52a66c2c | 563 | $ git status |
a0db33fe | 564 | |
d5bddf6e JV |
565 | XXX manifest _sorting_ is now checked with make test_porting |
566 | ||
a0db33fe DM |
567 | Commit MANIFEST if it has changed: |
568 | ||
569 | $ git commit -m 'Update MANIFEST' MANIFEST | |
570 | ||
571 | =item * | |
572 | ||
573 | I<You MUST SKIP this step for SNAPSHOT> | |
574 | ||
575 | Add an entry to F<pod/perlhist.pod> with the current date, e.g.: | |
576 | ||
577 | David 5.10.1-RC1 2009-Aug-06 | |
578 | ||
579 | Make sure that the correct pumpking is listed in the left-hand column, and | |
580 | if this is the first release under the stewardship of a new pumpking, make | |
581 | sure that his or her name is listed in the section entitled | |
582 | C<THE KEEPERS OF THE PUMPKIN>. | |
583 | ||
584 | Be sure to commit your changes: | |
585 | ||
586 | $ git commit -m 'add new release to perlhist' pod/perlhist.pod | |
8c35d285 JV |
587 | |
588 | =item * | |
589 | ||
38195a8c | 590 | I<You MUST SKIP this step for SNAPSHOT or BLEAD release> |
d7eb1120 | 591 | |
a42352ee DM |
592 | Update F<patchlevel.h> to add a C<-RC1>-or-whatever string; or, if this is |
593 | a final release, remove it. For example: | |
d7eb1120 DM |
594 | |
595 | static const char * const local_patches[] = { | |
596 | NULL | |
597 | + ,"RC1" | |
598 | PERL_GIT_UNPUSHED_COMMITS /* do not remove this line */ | |
599 | ||
600 | Be sure to commit your change: | |
601 | ||
602 | $ git commit -m 'bump version to RCnnn' patchlevel.h | |
603 | ||
604 | =item * | |
605 | ||
a0db33fe DM |
606 | Build perl, then make sure it passes its own test suite, and installs: |
607 | ||
608 | $ git clean -xdf | |
a42352ee DM |
609 | $ ./Configure -des -Dprefix=/tmp/perl-5.x.y-pretest |
610 | ||
611 | # or if it's an odd-numbered version: | |
a0db33fe | 612 | $ ./Configure -des -Dusedevel -Dprefix=/tmp/perl-5.x.y-pretest |
a42352ee | 613 | |
a0db33fe DM |
614 | $ make test install |
615 | ||
616 | =item * | |
617 | ||
52a66c2c DM |
618 | Check that the output of C</tmp/perl-5.x.y-pretest/bin/perl -v> and |
619 | C</tmp/perl-5.x.y-pretest/bin/perl -V> are as expected, | |
a0db33fe | 620 | especially as regards version numbers, patch and/or RC levels, and @INC |
52a66c2c DM |
621 | paths. Note that as they have been been built from a git working |
622 | directory, they will still identify themselves using git tags and | |
623 | commits. | |
624 | ||
625 | Then delete the temporary installation. | |
626 | ||
627 | =item * | |
628 | ||
a0db33fe DM |
629 | Push all your recent commits: |
630 | ||
631 | $ git push origin .... | |
632 | ||
96054f12 JV |
633 | |
634 | =item * | |
635 | ||
636 | I<You MUST SKIP this step for SNAPSHOT> | |
637 | ||
e8c01f92 | 638 | Tag the release (e.g.): |
96054f12 JV |
639 | |
640 | $ git tag v5.11.0 -m'First release of the v5.11 series!' | |
641 | ||
e8c01f92 SH |
642 | (Adjust the syntax appropriately if you're working on Win32, i.e. use |
643 | C<-m "..."> rather than C<-m'...'>.) | |
644 | ||
f662f3b7 JV |
645 | It is VERY important that from this point forward, you not push |
646 | your git changes to the Perl master repository. If anything goes | |
647 | wrong before you publish your newly-created tag, you can delete | |
648 | and recreate it. Once you push your tag, we're stuck with it | |
649 | and you'll need to use a new version number for your release. | |
650 | ||
a0db33fe DM |
651 | =item * |
652 | ||
8c35d285 JV |
653 | Create a tarball. Use the C<-s> option to specify a suitable suffix for |
654 | the tarball and directory name: | |
655 | ||
656 | $ cd root/of/perl/tree | |
657 | $ make distclean | |
75a012fe DM |
658 | $ git clean -xdf # make sure perl and git agree on files |
659 | $ git status # and there's nothing lying around | |
8c35d285 JV |
660 | |
661 | $ perl Porting/makerel -b -s `git describe` # for a snapshot | |
662 | $ perl Porting/makerel -b -s RC1 # for a release candidate | |
663 | $ perl Porting/makerel -b # for a final release | |
664 | ||
665 | This creates the directory F<../perl-x.y.z-RC1> or similar, copies all | |
666 | the MANIFEST files into it, sets the correct permissions on them, | |
667 | adds DOS line endings to some, then tars it up as | |
668 | F<../perl-x.y.z-RC1.tar.gz>. With C<-b>, it also creates a C<tar.bz2> file. | |
669 | ||
6480287f MT |
670 | If you're getting your tarball suffixed with -uncommitted and you're sure |
671 | your changes were all committed, you can override the suffix with: | |
672 | ||
673 | $ perl Porting/makerel -b -s '' | |
96054f12 | 674 | |
8c35d285 JV |
675 | XXX if we go for extra tags and branches stuff, then add the extra details |
676 | here | |
677 | ||
678 | =item * | |
679 | ||
a42352ee DM |
680 | Clean up the temporary directory, e.g. |
681 | ||
682 | $ rm -rf ../perl-x.y.z-RC1 | |
683 | ||
684 | =item * | |
685 | ||
8c35d285 JV |
686 | Copy the tarballs (.gz and possibly .bz2) to a web server somewhere you |
687 | have access to. | |
688 | ||
689 | =item * | |
690 | ||
691 | Download the tarball to some other machine. For a release candidate, | |
692 | you really want to test your tarball on two or more different platforms | |
693 | and architectures. The #p5p IRC channel on irc.perl.org is a good place | |
694 | to find willing victims. | |
695 | ||
696 | =item * | |
697 | ||
698 | Check that basic configuration and tests work on each test machine: | |
699 | ||
700 | $ ./Configure -des && make all test | |
f6af4394 DM |
701 | |
702 | =item * | |
703 | ||
8c35d285 JV |
704 | Check that the test harness and install work on each test machine: |
705 | ||
a42352ee | 706 | $ make distclean |
8c35d285 | 707 | $ ./Configure -des -Dprefix=/install/path && make all test_harness install |
a42352ee | 708 | $ cd /install/path |
8c35d285 JV |
709 | |
710 | =item * | |
711 | ||
712 | Check that the output of C<perl -v> and C<perl -V> are as expected, | |
713 | especially as regards version numbers, patch and/or RC levels, and @INC | |
714 | paths. | |
715 | ||
716 | Note that the results may be different without a F<.git/> directory, | |
717 | which is why you should test from the tarball. | |
718 | ||
719 | =item * | |
720 | ||
459fc3ca DM |
721 | Run the Installation Verification Procedure utility: |
722 | ||
723 | $ bin/perlivp | |
724 | ... | |
725 | All tests successful. | |
726 | $ | |
727 | ||
728 | =item * | |
729 | ||
d60a1044 DM |
730 | Compare the pathnames of all installed files with those of the previous |
731 | release (i.e. against the last installed tarball on this branch which you | |
732 | have previously verified using this same procedure). In particular, look | |
733 | for files in the wrong place, or files no longer included which should be. | |
734 | For example, suppose the about-to-be-released version is 5.10.1 and the | |
735 | previous is 5.10.0: | |
736 | ||
737 | cd installdir-5.10.0/ | |
738 | find . -type f | perl -pe's/5\.10\.0/5.10.1/g' | sort > /tmp/f1 | |
739 | cd installdir-5.10.1/ | |
740 | find . -type f | sort > /tmp/f2 | |
741 | diff -u /tmp/f[12] | |
742 | ||
743 | =item * | |
744 | ||
8c35d285 JV |
745 | Bootstrap the CPAN client on the clean install: |
746 | ||
75a012fe | 747 | $ bin/perl -MCPAN -e'shell' |
8c35d285 | 748 | |
e8c01f92 SH |
749 | (Use C<... -e "shell"> instead on Win32. You probably also need a set of |
750 | Unix command-line tools available for CPAN to function correctly without | |
751 | Perl alternatives like LWP installed. Cygwin is an obvious choice.) | |
752 | ||
8c35d285 JV |
753 | =item * |
754 | ||
a42352ee DM |
755 | Try installing a popular CPAN module that's reasonably complex and that |
756 | has dependencies; for example: | |
8c35d285 | 757 | |
a42352ee DM |
758 | CPAN> install Inline |
759 | CPAN> quit | |
8c35d285 JV |
760 | |
761 | Check that your perl can run this: | |
762 | ||
75a012fe | 763 | $ bin/perl -lwe 'use Inline C => "int f() { return 42;} "; print f' |
a42352ee DM |
764 | 42 |
765 | $ | |
8c35d285 | 766 | |
e8c01f92 SH |
767 | (Use C<... -lwe "use ..."> instead on Win32.) |
768 | ||
8c35d285 JV |
769 | =item * |
770 | ||
771 | Bootstrap the CPANPLUS client on the clean install: | |
772 | ||
75a012fe | 773 | $ bin/cpanp |
8c35d285 | 774 | |
e8c01f92 SH |
775 | (Again, on Win32 you'll need something like Cygwin installed, but make sure |
776 | that you don't end up with its various F<bin/cpan*> programs being found on | |
777 | the PATH before those of the Perl that you're trying to test.) | |
778 | ||
8c35d285 JV |
779 | =item * |
780 | ||
a42352ee | 781 | Install an XS module, for example: |
8c35d285 | 782 | |
a42352ee DM |
783 | CPAN Terminal> i DBI |
784 | CPAN Terminal> quit | |
785 | $ bin/perl -MDBI -e 1 | |
75a012fe | 786 | $ |
8c35d285 JV |
787 | |
788 | =item * | |
789 | ||
bc4c40f2 JV |
790 | I<If you're building a SNAPSHOT, you should STOP HERE> |
791 | ||
792 | =item * | |
8c35d285 | 793 | |
7f89f796 | 794 | Check that the L<perlbug> utility works. Try the following: |
47b1f096 | 795 | |
a14438df | 796 | $ bin/perlbug |
47b1f096 DM |
797 | ... |
798 | Subject: test bug report | |
799 | Local perl administrator [yourself]: | |
800 | Editor [vi]: | |
801 | Module: | |
802 | Category [core]: | |
803 | Severity [low]: | |
804 | (edit report) | |
805 | Action (Send/Display/Edit/Subject/Save to File): f | |
806 | Name of file to save message in [perlbug.rep]: | |
807 | Action (Send/Display/Edit/Subject/Save to File): q | |
808 | ||
809 | and carefully examine the output (in F<perlbug.rep]>), especially | |
810 | the "Locally applied patches" section. If everything appears okay, then | |
75a012fe DM |
811 | delete the file, and try it again, this time actually submitting the bug |
812 | report. Check that it shows up, then remember to close it! | |
47b1f096 DM |
813 | |
814 | =item * | |
815 | ||
f6af4394 DM |
816 | Wait for the smoke tests to catch up with the commit which this release is |
817 | based on (or at least the last commit of any consequence). | |
7277a900 | 818 | |
f6af4394 DM |
819 | Then check that the smoke tests pass (particularly on Win32). If not, go |
820 | back and fix things. | |
7277a900 | 821 | |
7277a900 | 822 | |
f6af4394 | 823 | =item * |
7277a900 | 824 | |
f6af4394 | 825 | Once smoking is okay, upload it to PAUSE. This is the point of no return. |
db3f805e JV |
826 | If anything goes wrong after this point, you will need to re-prepare |
827 | a new release with a new minor version or RC number. | |
828 | ||
a14438df DM |
829 | https://pause.perl.org/ |
830 | ||
831 | (Login, then select 'Upload a file to CPAN') | |
832 | ||
45924287 RS |
833 | If your workstation is not connected to a high-bandwidth, |
834 | high-reliability connection to the Internet, you should probably use the | |
835 | "GET URL" feature (rather than "HTTP UPLOAD") to have PAUSE retrieve the | |
836 | new release from wherever you put it for testers to find it. This will | |
837 | eliminate anxious gnashing of teeth while you wait to see if your | |
838 | 15 megabyte HTTP upload successfully completes across your slow, twitchy | |
c27b4e97 SH |
839 | cable modem. You can make use of your home directory on dromedary for |
840 | this purpose: F<http://users.perl5.git.perl.org/~USERNAME> maps to | |
841 | F</home/USERNAME/public_html>, where F<USERNAME> is your login account | |
842 | on dromedary. I<Remember>: if your upload is partially successful, you | |
843 | may need to contact a PAUSE administrator or even bump the version of perl. | |
45924287 | 844 | |
a42352ee | 845 | Upload both the .gz and .bz2 versions of the tarball. |
f6af4394 | 846 | |
c27b4e97 | 847 | Wait until you receive notification emails from the PAUSE indexer |
38195a8c | 848 | confirming that your uploads have been received. IMPORTANT -- you will |
b28f69c2 Z |
849 | probably get an email that indexing has failed, due to module permissions. |
850 | This is considered normal. | |
38195a8c DG |
851 | |
852 | Do not proceed any further until you are sure that your tarballs are on | |
853 | CPAN. Check your authors directory on one of the "fast" CPAN mirrors | |
b28f69c2 | 854 | (e.g., cpan.hexten.net |
38195a8c | 855 | or cpan.cpantesters.org) to confirm that your uploads have been successful. |
c27b4e97 | 856 | |
210de33e DM |
857 | =item * |
858 | ||
f662f3b7 | 859 | Now that you've shipped the new perl release to PAUSE, it's |
e8c01f92 | 860 | time to publish the tag you created earlier to the public git repo (e.g.): |
f662f3b7 JV |
861 | |
862 | $ git push origin tag v5.11.0 | |
f6af4394 DM |
863 | |
864 | =item * | |
865 | ||
a42352ee | 866 | Disarm the F<patchlevel.h> change; for example, |
d7eb1120 DM |
867 | |
868 | static const char * const local_patches[] = { | |
869 | NULL | |
870 | - ,"RC1" | |
871 | PERL_GIT_UNPUSHED_COMMITS /* do not remove this line */ | |
872 | ||
873 | Be sure to commit your change: | |
874 | ||
875 | $ git commit -m 'disarm RCnnn bump' patchlevel.h | |
a14438df | 876 | $ git push origin .... |
d7eb1120 | 877 | |
2e831dfd DM |
878 | |
879 | =item * | |
880 | ||
db3f805e | 881 | Mail p5p to announce your new release, with a quote you prepared earlier. |
f6af4394 DM |
882 | |
883 | =item * | |
884 | ||
85531b0a DG |
885 | Add your quote to F<Porting/epigraphs.pod> and commit it. |
886 | ||
887 | =item * | |
888 | ||
bc4c40f2 | 889 | I<You MUST SKIP this step for RC> |
8c35d285 | 890 | |
75a012fe DM |
891 | Remind the current maintainer of C<Module::CoreList> to push a new release |
892 | to CPAN. | |
7277a900 | 893 | |
75a012fe | 894 | =item * |
a2cba4bc | 895 | |
bc4c40f2 | 896 | I<You MUST SKIP this step for RC> |
7277a900 | 897 | |
c5b87fed | 898 | Create a new perldelta. |
7277a900 | 899 | |
5ef3945b SH |
900 | First, update the F<.gitignore> file in the F<pod/> folder to ignore the next |
901 | release's generated F<pod/perlNNNdelta.pod> file rather than this releases's | |
902 | one which we are about to set in stone (where NNN is the perl version number | |
903 | without the dots. i.e. 5135 for 5.13.5). | |
904 | ||
905 | Then, move the existing F<pod/perldelta.pod> to F<pod/perlNNNdelta.pod>. | |
7277a900 | 906 | |
c5b87fed FR |
907 | Now edit the moved delta file to change the C<NAME> from C<perldelta> to |
908 | C<perlNNNdelta>. | |
7277a900 | 909 | |
c5b87fed FR |
910 | Then create a new empty perldelta.pod file for the new release; see |
911 | F<Porting/how_to_write_a_perldelta.pod>. | |
8e967a1c | 912 | |
c5b87fed | 913 | You should be able to do this by just copying in a skeleton template and |
5ef3945b | 914 | then doing a quick fix up of the version numbers. |
8e967a1c | 915 | |
c5b87fed | 916 | Then commit the move and the new file. |
8e967a1c | 917 | |
c5b87fed | 918 | For example, assuming you just released 5.10.1: |
8e967a1c | 919 | |
c5b87fed FR |
920 | $ git mv pod/perldelta.pod pod/perl5101delta.pod |
921 | $ (edit pod/perl5101delta.pod to retitle) | |
8e967a1c | 922 | $ git add pod/perl5101delta.pod |
c5b87fed FR |
923 | |
924 | $ cp -i Porting/perldelta_template.pod pod/perldelta.pod | |
925 | $ (edit pod/perldelta.pod) | |
926 | $ git add pod/perldelta.pod | |
927 | $ git commit -m 'create perldelta for 5.10.2' | |
8e967a1c DG |
928 | |
929 | Now you need to update various tables of contents, most of which can be | |
930 | generated automatically. | |
7277a900 | 931 | |
c5b87fed FR |
932 | Edit F<pod.lst>: add the new entry, flagged as 'd', and unflag the previous |
933 | entry from being 'd'; for example: | |
75a012fe | 934 | |
c5b87fed FR |
935 | -d perl5101delta Perl changes in version 5.10.1 |
936 | +d perl5102delta Perl changes in version 5.10.2 | |
75a012fe | 937 | + perl5101delta Perl changes in version 5.10.1 |
7277a900 | 938 | |
75a012fe DM |
939 | Run C<perl pod/buildtoc --build-all> to update the F<perldelta> version in |
940 | the following files: | |
57433fbf JV |
941 | |
942 | MANIFEST | |
75a012fe DM |
943 | Makefile.SH |
944 | pod.lst | |
57433fbf | 945 | pod/perl.pod |
57433fbf | 946 | vms/descrip_mms.template |
75a012fe DM |
947 | win32/Makefile |
948 | win32/makefile.mk | |
949 | win32/pod.mak | |
950 | ||
951 | Then manually edit (F<vms/descrip_mms.template> to bump the version | |
952 | in the following entry: | |
57433fbf | 953 | |
c5b87fed | 954 | [.pod]perl5101delta.pod : [.pod]perldelta.pod |
75a012fe DM |
955 | |
956 | XXX this previous step needs to fixed to automate it in pod/buildtoc. | |
957 | ||
75a012fe DM |
958 | Finally, commit: |
959 | ||
c5b87fed | 960 | $ git commit -a -m 'update TOC for perlNNNdelta' |
75a012fe DM |
961 | |
962 | At this point you may want to compare the commit with a previous bump to | |
5ef3945b | 963 | see if they look similar. See commit 2b6e134265 for an example of a |
75a012fe | 964 | previous version bump. |
57433fbf JV |
965 | |
966 | =item * | |
967 | ||
bc4c40f2 | 968 | I<You MUST SKIP this step for RC, BLEAD> |
dc0a62a1 | 969 | |
66d8ce14 JV |
970 | If this was the first release of a new maint series, (5.x.0 where x is |
971 | even), then create a new maint branch based on the commit tagged as | |
972 | the current release and bump the version in the blead branch in git, | |
973 | e.g. 5.12.0 to 5.13.0. | |
addebd58 DM |
974 | |
975 | [ XXX probably lots more stuff to do, including perldelta, | |
f6af4394 | 976 | C<lib/feature.pm> ] |
7277a900 | 977 | |
233ca920 JV |
978 | Assuming you're using git 1.7.x or newer: |
979 | ||
980 | $ git checkout -b maint-5.12 | |
981 | $ git push origin -u maint-5.12 | |
addebd58 DM |
982 | |
983 | =item * | |
984 | ||
bc4c40f2 | 985 | I<You MUST SKIP this step for RC, BLEAD> |
8c35d285 | 986 | |
c5b87fed | 987 | Copy the perldelta.pod for this release into the other branches; for |
75a012fe | 988 | example: |
7277a900 | 989 | |
c5b87fed | 990 | $ cp -i ../5.10.x/pod/perldelta.pod pod/perl5101delta.pod # for example |
75a012fe DM |
991 | $ git add pod/perl5101delta.pod |
992 | ||
993 | Edit F<pod.lst> to add an entry for the file, e.g.: | |
994 | ||
995 | perl5101delta Perl changes in version 5.10.1 | |
bc4c40f2 | 996 | |
75a012fe | 997 | Then rebuild various files: |
7277a900 | 998 | |
75a012fe DM |
999 | $ perl pod/buildtoc --build-all |
1000 | ||
1001 | Finally, commit: | |
1002 | ||
1003 | $ git commit -a -m 'add perlXXXdelta' | |
7277a900 | 1004 | |
f6af4394 | 1005 | =item * |
7277a900 | 1006 | |
f6af4394 DM |
1007 | Make sure any recent F<pod/perlhist.pod> entries are copied to |
1008 | F<perlhist.pod> on other branches; typically the RC* and final entries, | |
1009 | e.g. | |
7277a900 | 1010 | |
f6af4394 DM |
1011 | 5.8.9-RC1 2008-Nov-10 |
1012 | 5.8.9-RC2 2008-Dec-06 | |
1013 | 5.8.9 2008-Dec-14 | |
7277a900 | 1014 | |
6e40fbf9 DM |
1015 | =item * |
1016 | ||
a3738a12 DM |
1017 | If necessary, send an email to C<perlbug-admin at perl.org> requesting |
1018 | that new version numbers be added to the RT fields C<Perl Version> and | |
1019 | C<Fixed In>. | |
1020 | ||
1021 | =item * | |
1022 | ||
bc4c40f2 JV |
1023 | I<You MUST RETIRE to your preferred PUB, CAFE or SEASIDE VILLA for some |
1024 | much-needed rest and relaxation>. | |
8c35d285 JV |
1025 | |
1026 | Thanks for releasing perl! | |
1027 | ||
7277a900 GS |
1028 | =back |
1029 | ||
b28f69c2 Z |
1030 | =head2 Building a release - the day after |
1031 | ||
1032 | =over 4 | |
1033 | ||
1034 | =item * | |
1035 | ||
98df743a Z |
1036 | Check your author directory under L<http://www.cpan.org/authors/id/> |
1037 | to ensure that the tarballs are available on the website. | |
b28f69c2 Z |
1038 | |
1039 | =item * | |
1040 | ||
98df743a Z |
1041 | Check C</src> on CPAN (on a fast mirror) to ensure that links to |
1042 | the new tarballs have appeared. There should be links in C</src/5.0> | |
1043 | (which is accumulating all new versions), links in C</src> (which shows | |
1044 | only the latest version on each branch), and an appropriate mention in | |
1045 | C</src/README.html> (which describes the latest versions). | |
1046 | ||
1047 | These links should appear automatically, some hours after upload. | |
1048 | If they don't, or the C<README.html> description is inadequate, | |
1049 | ask Ask <ask@perl.org>. | |
b28f69c2 Z |
1050 | |
1051 | =item * | |
1052 | ||
98df743a Z |
1053 | Check L<http://www.cpan.org/src/> to ensure that the C</src> updates |
1054 | have been correctly mirrored to the website. | |
1055 | If they haven't, ask Ask <ask@perl.org>. | |
1056 | ||
1057 | =item * | |
b28f69c2 | 1058 | |
98df743a Z |
1059 | Check L<http://search.cpan.org> to see if it has indexed the distribution. |
1060 | It should be visible at a URL like C<http://search.cpan.org/dist/perl-5.10.1/>. | |
b28f69c2 Z |
1061 | |
1062 | =item * | |
1063 | ||
98df743a Z |
1064 | I<This step ONLY for STABLE> |
1065 | ||
1066 | Ask Rafael to update L<http://dev.perl.org/perl5/>. | |
b28f69c2 Z |
1067 | |
1068 | =back | |
1069 | ||
7277a900 GS |
1070 | =head1 SOURCE |
1071 | ||
f6af4394 DM |
1072 | Based on |
1073 | http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2009-05/msg00608.html, | |
1074 | plus a whole bunch of other sources, including private correspondence. | |
7277a900 GS |
1075 | |
1076 | =cut | |
1077 |