This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
this is already mentioned at the end (and that is more correct)
[perl5.git] / Porting / release_managers_guide.pod
CommitLineData
49781f4a
AB
1=encoding utf8
2
7277a900
GS
3=head1 NAME
4
5release_managers_guide - Releasing a new version of perl 5.x
6
dc0a4df9
DM
7Note that things change at each release, so there may be new things not
8covered here, or tools may need updating.
9
c78277ad
DR
10=head1 MAKING A CHECKLIST
11
12If you are preparing to do a release, you can run the
13F<Porting/make-rmg-checklist> script to generate a new version of this
14document that starts with a checklist for your release.
15
16This script is run as:
17
18 perl Porting/make-rmg-checklist \
19 --type [BLEAD-POINT or MAINT or ...] > /tmp/rmg.pod
20
21You can also pass the C<--html> flag to generate an HTML document instead of
22POD.
f6af4394 23
0056d3d2
DR
24 perl Porting/make-rmg-checklist --html \
25 --type [BLEAD-POINT or MAINT or ...] > /tmp/rmg.html
26
7277a900
GS
27=head1 SYNOPSIS
28
f6af4394 29This document describes the series of tasks required - some automatic, some
dc0a4df9
DM
30manual - to produce a perl release of some description, be that a release
31candidate, or final, numbered release of maint or blead.
f6af4394 32
8c35d285 33The release process has traditionally been executed by the current
ee76d676
JV
34pumpking. Blead releases from 5.11.0 forward are made each month on the
3520th by a non-pumpking release engineer. The release engineer roster
36and schedule can be found in Porting/release_schedule.pod.
7277a900 37
8c35d285
JV
38This document both helps as a check-list for the release engineer
39and is a base for ideas on how the various tasks could be automated
40or distributed.
7277a900 41
da571fa1 42The checklist of a typical release cycle is as follows:
f6af4394 43
636a1918 44 (5.10.1 is released, and post-release actions have been done)
f6af4394
DM
45
46 ...time passes...
47
f6af4394
DM
48 a few weeks before the release, a number of steps are performed,
49 including bumping the version to 5.10.2
636a1918
DM
50
51 ...a few weeks passes...
46743ef7 52
f6af4394
DM
53 perl-5.10.2-RC1 is released
54
55 perl-5.10.2 is released
56
57 post-release actions are performed, including creating new
c5b87fed 58 perldelta.pod
f6af4394
DM
59
60 ... the cycle continues ...
7277a900 61
dc0a4df9 62
7277a900
GS
63=head1 DETAILS
64
6a958a95
DM
65Some of the tasks described below apply to all four types of
66release of Perl. (blead, RC, final release of maint, final
8c35d285
JV
67release of blead). Some of these tasks apply only to a subset
68of these release types. If a step does not apply to a given
69type of release, you will see a notation to that effect at
70the beginning of the step.
71
dc0a4df9 72
8c35d285
JV
73=head2 Release types
74
75=over 4
76
8c35d285
JV
77=item Release Candidate (RC)
78
d60a1044
DM
79A release candidate is an attempt to produce a tarball that is a close as
80possible to the final release. Indeed, unless critical faults are found
81during the RC testing, the final release will be identical to the RC
82barring a few minor fixups (updating the release date in F<perlhist.pod>,
83removing the RC status from F<patchlevel.h>, etc). If faults are found,
84then the fixes should be put into a new release candidate, never directly
85into a final release.
8c35d285 86
6a958a95
DM
87
88=item Stable/Maint release (MAINT).
89
90A release with an even version number, and subversion number > 0, such as
915.14.1 or 5.14.2.
8c35d285
JV
92
93At this point you should have a working release candidate with few or no
94changes since.
95
96It's essentially the same procedure as for making a release candidate, but
97with a whole bunch of extra post-release steps.
98
6a958a95
DM
99=item A blead point release (BLEAD-POINT)
100
101A release with an odd version number, such as 5.15.0 or 5.15.1.
102
103This isn't for production, so it has less stability requirements than for
104other release types, and isn't preceded by RC releases. Other than that,
105it is similar to a MAINT release.
106
107=item Blead final release (BLEAD-FINAL)
108
109A release with an even version number, and subversion number == 0, such as
dc0a4df9 1105.14.0. That is to say, it's the big new release once per year.
8c35d285
JV
111
112It's essentially the same procedure as for making a release candidate, but
6a958a95 113with a whole bunch of extra post-release steps, even more than for MAINT.
8c35d285
JV
114
115=back
7277a900 116
da571fa1 117=for checklist begin
dc0a4df9 118
fd838dcf
JV
119=head2 Prerequisites
120
121Before you can make an official release of perl, there are a few
122hoops you need to jump through:
123
00c28750 124=head3 PAUSE account with pumpkin status
8c35d285 125
fd838dcf
JV
126Make sure you have a PAUSE account suitable for uploading a perl release.
127If you don't have a PAUSE account, then request one:
128
129 https://pause.perl.org/pause/query?ACTION=request_id
130
9a3b7d40
FR
131Check that your account is allowed to upload perl distros: go to
132L<https://pause.perl.org/pause/authenquery?ACTION=who_pumpkin> and check that
133your PAUSE ID is listed there. If not, ask Andreas KE<0xf6>nig to add your ID
134to the list of people allowed to upload something called perl. You can find
135Andreas' email address at:
4d2c8158 136
fd838dcf
JV
137 https://pause.perl.org/pause/query?ACTION=pause_04imprint
138
00c28750 139=head3 search.cpan.org pumpkin status
fdabea7a
JV
140
141Make sure that search.cpan.org knows that you're allowed to upload
142perl distros. Contact Graham Barr to make sure that you're on the right
143list.
144
a72d816c
RS
145=head3 rt.perl.org update access
146
147Make sure you have permission to close tickets on L<http://rt.perl.org/>
148so you can respond to bug report as necessary during your stint. If you
149don't, make an account (if you don't have one) and contact the pumpking
150with your username to get ticket-closing permission.
151
da571fa1 152=head3 git checkout and commit bit
fd838dcf
JV
153
154You will need a working C<git> installation, checkout of the perl
155git repository and perl commit bit. For information about working
c222ef46 156with perl and git, see F<pod/perlgit.pod>.
fd838dcf
JV
157
158If you are not yet a perl committer, you won't be able to make a
159release. Have a chat with whichever evil perl porter tried to talk
160you into the idea in the first place to figure out the best way to
161resolve the issue.
162
845a9291
MM
163=head3 git clone of https://github.com/perlorg/perlweb
164
165For updating the L<http://dev.perl.org> web pages, either a Github account or
166sweet-talking somebody with a Github account into obedience is needed. This
167is only needed on the day of the release or shortly afterwards.
168
da571fa1 169=for checklist skip RC
f6af4394 170
da571fa1 171=head3 Quotation for release announcement epigraph
f6af4394 172
b1288acc 173I<SKIP this step for RC>
f6af4394 174
6a958a95 175For all except an RC release of perl, you will need a quotation
b1288acc 176to use as an epigraph to your release announcement.
46743ef7 177
2e831dfd 178=head2 Building a release - advance actions
8c35d285 179
9c39c536
A
180The work of building a release candidate for an even numbered release
181(BLEAD-FINAL) of perl generally starts several weeks before the first
182release candidate. Some of the following steps should be done regularly,
183but all I<must> be done in the run up to a release.
7277a900 184
dc0a4df9 185=head3 dual-life CPAN module synchronisation
f6af4394 186
1d84c074 187To see which core distro versions differ from the current CPAN versions:
f6af4394 188
1d84c074 189 $ ./perl -Ilib Porting/core-cpan-diff -x -a
7277a900 190
1d84c074
JL
191Passing C<-u cpan> (and maybe C<-u undef>) will probably be helpful, since
192those are the only types of distributions that you can actually affect as a
193perl release manager (as opposed to a CPAN module maintainer).
7277a900 194
1d84c074
JL
195You can also run an actual diff of the contents of the modules, comparing core
196to CPAN, to ensure that there were no erroneous/extraneous changes that need to
197be dealt with. You do this by not passing the C<-x> option:
7277a900 198
1d84c074
JL
199 $ ./perl -Ilib Porting/core-cpan-diff -a -o /tmp/corediffs
200
201then fix the core, or cajole CPAN authors as appropriate. See also the C<-d>
202and C<-v> options for more detail (and the C<-u> option as mentioned above).
203You'll probably want to use the C<-c cachedir> option to avoid repeated CPAN
204downloads and may want to use C<-m file:///mirror/path> if you made a local
205CPAN mirror. Note that a minicpan mirror won't actually work, but can provide a
206good first pass to quickly get a list of modules which definitely haven't
207changed, to avoid having to download absolutely everything.
7277a900 208
6a958a95 209If you are making a MAINT release, run C<core-cpan-diff> on both blead and
636a1918
DM
210maint, then diff the two outputs. Compare this with what you expect, and if
211necessary, fix things up. For example, you might think that both blead
212and maint are synchronised with a particular CPAN module, but one might
213have some extra changes.
214
9c39c536
A
215=head3 How to sync a CPAN module with a cpan/ distro
216
217=over 4
218
219=item *
220
221Fetch the most recent version from CPAN.
222
223=item *
224
225Unpack the retrieved tarball. Rename the old directory; rename the new
226directory to the original name.
227
228=item *
229
9e40a104 230Restore any F<.gitignore> file. This can be done by issuing
02cbdfef 231C<git checkout .gitignore> in the F<cpan/Distro> directory.
9c39c536
A
232
233=item *
234
235Remove files we do not need. That is, remove any files that match the
02cbdfef 236entries in C<@IGNORE> in F<Porting/Maintainer.pl>, and anything that
9c39c536
A
237matches the C<EXCLUDED> section of the distro's entry in the C<%Modules>
238hash.
239
240=item *
241
242Restore any files mentioned in the C<CUSTOMIZED> section, using
243C<git checkout>. Make any new customizations if necessary. Also,
244restore any files that are mentioned in C<@IGNORE>, but were checked
245in in the repository anyway.
246
247=item *
248
249For any new files in the distro, determine whether they are needed.
250If not, delete them, and list them in either C<EXCLUDED> or C<@INGORE>.
251Otherwise, add them to C<MANIFEST>, and run C<git add> to add the files
252to the repository.
253
254=item *
255
256For any files that are gone, remove them from C<MANIFEST>, and use
257C<git rm> to tell git the files will be gone.
258
259=item *
260
261If the C<MANIFEST> file was changed in any of the previous steps, run
262C<perl Porting/manisort --output MANIFEST.sort; mv MANIFEST.sort MANIFEST>.
263
264=item *
265
266For any files that have an execute bit set, either remove the execute
02cbdfef 267bit, or edit F<Porting/exec-bit.txt>
9c39c536
A
268
269=item *
270
271Run C<make>, see if C<perl> compiles.
272
273=item *
274
275Run the tests for the package.
276
277=item *
278
02cbdfef 279Run the tests in F<t/porting>.
9c39c536
A
280
281=item *
282
02cbdfef 283Update the C<DISTRIBUTION> entry in F<Porting/Maintainers.pl>.
9c39c536
A
284
285=item *
286
287Run a full configure/build/test cycle.
288
289=item *
290
291If everything is ok, commit the changes.
292
293=back
294
295For entries with a non-simple C<FILES> section, or with a C<MAP>, you
296may have to take more steps than listed above.
297
02cbdfef 298F<Porting/sync-with-cpan> is a script that automates most of the steps
9c39c536
A
299above; but see the comments at the beginning of the file.
300
dc0a4df9
DM
301
302=head3 dual-life CPAN module stability
7277a900 303
f6af4394 304Ensure dual-life CPAN modules are stable, which comes down to:
7277a900
GS
305
306 for each module that fails its regression tests on $current
f6af4394
DM
307 did it fail identically on $previous?
308 if yes, "SEP" (Somebody Else's Problem)
309 else work out why it failed (a bisect is useful for this)
7277a900
GS
310
311 attempt to group failure causes
312
313 for each failure cause
f6af4394
DM
314 is that a regression?
315 if yes, figure out how to fix it
316 (more code? revert the code that broke it)
317 else
318 (presumably) it's relying on something un-or-under-documented
319 should the existing behaviour stay?
320 yes - goto "regression"
321 no - note it in perldelta as a significant bugfix
322 (also, try to inform the module's author)
1aff5354 323
dc0a4df9 324
00c28750 325=head3 monitor smoke tests for failures
7277a900 326
5157df7a
AB
327Similarly, monitor the smoking of core tests, and try to fix. See
328L<http://doc.procura.nl/smoke/index.html> for a summary. See also
329L<http://www.nntp.perl.org/group/perl.daily-build.reports/> which has
330the raw reports.
7277a900 331
636a1918
DM
332Similarly, monitor the smoking of perl for compiler warnings, and try to
333fix.
334
dc0a4df9 335
00c28750 336=head3 update perldelta
636a1918 337
f6af4394 338Get perldelta in a mostly finished state.
db3f805e 339
04c2c53e 340Read F<Porting/how_to_write_a_perldelta.pod>, and try to make sure that
636a1918
DM
341every section it lists is, if necessary, populated and complete. Copy
342edit the whole document.
f6af4394 343
f6af4394 344
dc0a4df9
DM
345=head3 Bump the version number
346
347Increase the version number (e.g. from 5.12.0 to 5.12.1).
04dbb930 348
6a958a95 349For a BLEAD-POINT release, this can happen on the day of the release. For a
04dbb930
DG
350release candidate for a stable perl, this should happen a week or two
351before the first release candidate to allow sufficient time for testing and
352smoking with the target version built into the perl executable. For
353subsequent release candidates and the final release, it it not necessary to
354bump the version further.
f6af4394 355
8b2227e6 356There is a tool to semi-automate this process:
f6af4394 357
8b2227e6 358 $ ./perl -Ilib Porting/bump-perl-version -i 5.10.0 5.10.1
f6af4394 359
8b2227e6
LB
360Remember that this tool is largely just grepping for '5.10.0' or whatever,
361so it will generate false positives. Be careful not change text like
362"this was fixed in 5.10.0"!
ceb7f800 363
8b2227e6 364Use git status and git diff to select changes you want to keep.
ceb7f800 365
f6af4394
DM
366Be particularly careful with F<INSTALL>, which contains a mixture of
367C<5.10.0>-type strings, some of which need bumping on every release, and
e03f126c
Z
368some of which need to be left unchanged.
369The line in F<INSTALL> about "is binary incompatible with" requires a
370correct choice of earlier version to declare incompatibility with.
371
6a958a95
DM
372When doing a BLEAD-POINT or BLEAD-FINAL release, also make sure the
373C<PERL_API_*> constants in F<patchlevel.h> are in sync with the version
374you're releasing, unless you're
e43cb88f 375absolutely sure the release you're about to make is 100% binary compatible
6a958a95 376to an earlier release. When releasing a MAINT perl version, the C<PERL_API_*>
e43cb88f
TM
377constants C<MUST NOT> be changed as we aim to guarantee binary compatibility
378in maint branches.
45ce9531 379
17163f85
DM
380After editing, regenerate uconfig.h (this must be run on a system with a
381/bin/sh available):
22be9667 382
17163f85 383 $ perl regen/uconfig_h.pl
22be9667
JV
384
385Test your changes:
386
17163f85 387 $ git clean -xdf # careful if you don't have local files to keep!
22be9667
JV
388 $ ./Configure -des -Dusedevel
389 $ make
390 $ make test
391
54356a6f
JV
392Commit your changes:
393
04abd20e 394 $ git status
e91bd5c0
LB
395 $ git diff
396 B<review the delta carefully>
54356a6f
JV
397
398 $ git commit -a -m 'Bump the perl version in various places for 5.x.y'
dc0a62a1 399
21768cb3
FC
400At this point you may want to compare the commit with a previous bump to
401see if they look similar. See commit 8891dd8d for an example of a
402previous version bump.
403
dc0a4df9
DM
404When the version number is bumped, you should also update Module::CoreList
405(as described below in L<"update Module::CoreList">) to reflect the new
81fc59ef
DG
406version number.
407
dc0a4df9
DM
408
409=head3 update INSTALL
dc0a62a1
DM
410
411Review and update INSTALL to account for the change in version number;
412in particular, the "Coexistence with earlier versions of perl 5" section.
413
6a958a95
DM
414Be particularly careful with the section "Upgrading from 5.X.Y or earlier".
415The "X.Y" needs to be changed to the most recent version that we are
416I<not> binary compatible with.
417
418For MAINT and BLEAD-FINAL releases, this needs to refer to the last
419release in the previous development cycle (so for example, for a 5.14.x
420release, this would be 5.13.11).
421
422For BLEAD-POINT releases, it needs to refer to the previous BLEAD-POINT
423release (so for 5.15.3 this would be 5.15.2).
424
dc0a4df9 425=head3 Check more build configurations
b82efa27 426
a65c7ffd 427Check some more build configurations.
52a66c2c
DM
428
429 $ sh Configure -Dprefix=/tmp/perl-5.x.y -Uinstallusrbinperl \
a65c7ffd 430 -Duseshrplib -Dusesitecustomize
52a66c2c 431 $ make
a65c7ffd 432 $ make test
7277a900 433
52a66c2c 434XXX think of other configurations that need testing.
7277a900 435
dc0a4df9
DM
436
437=head3 update perlport
7277a900 438
347f5124
RGS
439L<perlport> has a section currently named I<Supported Platforms> that
440indicates which platforms are known to build in the current release.
441If necessary update the list and the indicated version number.
442
6a958a95
DM
443
444
2e831dfd
DM
445=head2 Building a release - on the day
446
b1288acc
DM
447This section describes the actions required to make a release
448that are performed on the actual day.
2e831dfd 449
2e831dfd 450
dc0a4df9 451=head3 re-check earlier actions
2e831dfd 452
dc0a4df9 453Review all the actions in the previous section,
2e831dfd
DM
454L<"Building a release - advance actions"> to ensure they are all done and
455up-to-date.
456
dc0a4df9
DM
457
458=head3 bump version number
8c35d285 459
6a958a95
DM
460For a BLEAD-POINT release, if you did not bump the perl version number as
461part of I<advance actions>, do that now.
04dbb930 462
dc0a4df9
DM
463
464=head3 finalize perldelta
04dbb930 465
04dbb930 466Finalize the perldelta. In particular, fill in the Acknowledgements
548e9a3a 467section, which can be generated with something like:
38195a8c 468
548e9a3a 469 $ perl Porting/acknowledgements.pl v5.15.0..HEAD
ef86391b 470
a0db33fe
DM
471Re-read the perldelta to try to find any embarrassing typos and thinkos;
472remove any C<TODO> or C<XXX> flags; update the "Known Problems" section
473with any serious issues for which fixes are not going to happen now; and
474run through pod and spell checkers, e.g.
2e831dfd 475
c5b87fed
FR
476 $ podchecker -warnings -warnings pod/perldelta.pod
477 $ spell pod/perldelta.pod
2e831dfd 478
a0db33fe
DM
479Also, you may want to generate and view an HTML version of it to check
480formatting, e.g.
2e831dfd 481
3f894c2d 482 $ ./perl -Ilib ext/Pod-Html/bin/pod2html pod/perldelta.pod > /tmp/perldelta.html
2e831dfd 483
38195a8c
DG
484Another good HTML preview option is http://search.cpan.org/pod2html
485
486If you make changes, be sure to commit them.
487
da571fa1
DR
488=for checklist skip BLEAD-POINT MAINT RC
489
a03432f2
KW
490=head3 remove stale perldeltas
491
492For the first RC release that is ONLY for a BLEAD-FINAL, the perldeltas
493from the BLEAD-POINT releases since the previous BLEAD_FINAL should have
494now been consolidated into the current perldelta, and hence are now just
495useless clutter. They can be removed using:
496
497 $ git rm <file1> <file2> ...
498
499For example, for RC0 of 5.16.0:
500
501 $ cd pod
502 $ git rm perldelta515*.pod
503
ace68858
NC
504All mention to them should also be removed. Edit F<pod/perl.pod> to remove
505them from its table of contents, then run F<Porting/pod_rules.pl> to
506propagate your changes there into all the other files that mention them
507(including F<MANIFEST>). You'll need to C<git add> the files that it changes.
a03432f2
KW
508
509Then build a clean perl and do a full test
510
511 $ git status
512 $ git clean -dxf
513 $ ./Configure -Dusedevel -des
514 $ make
515 $ make test
516
517Once all tests pass, commit your changes.
dc0a4df9
DM
518
519=head3 build a clean perl
8c35d285 520
a03432f2
KW
521If you skipped the previous step (removing the stale perldeltas)
522make sure you have a gitwise-clean perl directory (no modified files,
a0db33fe 523unpushed commits etc):
8c35d285 524
a0db33fe 525 $ git status
24c5e187 526 $ git clean -dxf
8c35d285 527
dc0a4df9 528then configure and build perl so that you have a Makefile and porting tools:
8c35d285 529
52a66c2c 530 $ ./Configure -Dusedevel -des && make
8c35d285 531
dc0a4df9 532=head3 update Module::CoreList
8c35d285 533
1bac61bb 534Update C<Module::CoreList> with module version data for the new release.
bfadf2ba 535
6a958a95 536Note that if this is a MAINT release, you should run the following actions
1bac61bb 537from the maint branch, but commit the C<CoreList.pm> changes in
a9d1f3db
LB
538I<blead> and subsequently cherry-pick any releases since the last
539maint release and then your recent commit. XXX need a better example
bfadf2ba 540
a0db33fe 541F<corelist.pl> uses ftp.funet.fi to verify information about dual-lived
bfadf2ba 542modules on CPAN. It can use a full, local CPAN mirror or fall back
e8c01f92
SH
543to C<wget> or C<curl> to fetch only package metadata remotely. (If you're
544on Win32, then installing Cygwin is one way to have commands like C<wget>
545and C<curl> available.)
bfadf2ba
JV
546
547(If you'd prefer to have a full CPAN mirror, see
548http://www.cpan.org/misc/cpan-faq.html#How_mirror_CPAN)
549
a0db33fe 550Then change to your perl checkout, and if necessary,
bfadf2ba 551
595f83ae 552 $ make
bfadf2ba 553
cacc980b 554If this is not the first update for this version (e.g. if it was updated
81fc59ef 555when the version number was originally bumped), first edit
d5bddf6e 556F<dist/Module-CoreList/lib/Module/CoreList.pm> to delete the existing
2ce7d676
RGS
557entries for this version from the C<%released> and C<%version> hashes:
558they will have a key like C<5.010001> for 5.10.1.
52a66c2c
DM
559
560XXX the edit-in-place functionality of Porting/corelist.pl should
561be fixed to handle this automatically.
562
bf8ea215 563Then, If you have a local CPAN mirror, run:
bfadf2ba 564
bfadf2ba
JV
565 $ ./perl -Ilib Porting/corelist.pl ~/my-cpan-mirror
566
567Otherwise, run:
568
bfadf2ba
JV
569 $ ./perl -Ilib Porting/corelist.pl cpan
570
52a66c2c 571This will chug for a while, possibly reporting various warnings about
2a720090 572badly-indexed CPAN modules unrelated to the modules actually in core.
2ce7d676 573Assuming all goes well, it will update
d5bddf6e 574F<dist/Module-CoreList/lib/Module/CoreList.pm>.
bfadf2ba
JV
575
576Check that file over carefully:
577
d5bddf6e 578 $ git diff dist/Module-CoreList/lib/Module/CoreList.pm
bfadf2ba 579
9e83560d
Z
580If this is a .0 Perl version, add the appropriate lines in F<Corelist.pm>
581to alias "5.nnn000" to "5.nnn" in each hash. (If feeling energetic,
582amend F<corelist.pl> to automate this.)
583
da571fa1
DR
584=head4 Bump C<$Module::CoreList::VERSION>
585
00c28750 586If necessary, bump C<$Module::CoreList::VERSION> (there's no need to do this for
bfadf2ba
JV
587every RC; in RC1, bump the version to a new clean number that will
588appear in the final release, and leave as-is for the later RCs and final).
9709cbd8
FC
589It may also happen that C<Module::CoreList> has been modified in blead, and
590hence has a new version number already. (But make sure it is not the same
591number as a CPAN release.)
bfadf2ba
JV
592
593Edit the version number in the new C<< 'Module::CoreList' => 'X.YZ' >>
594entry, as that is likely to reflect the previous version number.
595
00c28750
DR
596=head4 Bump version in Module::CoreList F<Changes>
597
cb9af4c0
AB
598Also edit Module::CoreList's new version number in its F<Changes>
599file.
e8c01f92 600
00c28750
DR
601=head4 Add Module::CoreList version bump to perldelta
602
70855f8b
FC
603Add a perldelta entry for the new Module::CoreList version.
604
da571fa1
DR
605=for checklist skip RC
606
48100be1 607=head4 Update C<%Module::CoreList::released> and C<CAVEATS>
da571fa1 608
a0db33fe 609In addition, if this is a final release (rather than a release candidate):
bfadf2ba
JV
610
611=over 4
612
613=item *
614
615Update this version's entry in the C<%released> hash with today's date.
616
617=item *
618
619Make sure that the script has correctly updated the C<CAVEATS> section
688b7920
A
620(Note, the C<CAVEATS> section is in
621F<dist/Module-CoreList/lib/Module/CoreList.pod>)
bfadf2ba
JV
622
623=back
624
00c28750
DR
625=head4 Commit Module::CoreList changes
626
bfadf2ba 627Finally, commit the new version of Module::CoreList:
6a958a95 628(unless this is for MAINT; in which case commit it to blead first, then
a0db33fe 629cherry-pick it back).
bfadf2ba 630
688b7920 631 $ git commit -m 'Update Module::CoreList for 5.x.y' dist/Module-CoreList/lib/Module/CoreList.pm dist/Module-CoreList/lib/Module/CoreList.pod
bfadf2ba 632
da571fa1 633=for checklist skip RC
dc0a4df9 634
dc0a4df9 635=head3 update perlhist.pod
a0db33fe 636
e8a7a70e 637I<You MUST SKIP this step for a RC release>
a0db33fe 638
e8a7a70e
JV
639Add an entry to F<pod/perlhist.pod> with the release date, e.g.:
640
641 David 5.10.1 2009-Aug-06
a0db33fe
DM
642
643Make sure that the correct pumpking is listed in the left-hand column, and
644if this is the first release under the stewardship of a new pumpking, make
645sure that his or her name is listed in the section entitled
646C<THE KEEPERS OF THE PUMPKIN>.
647
648Be sure to commit your changes:
649
650 $ git commit -m 'add new release to perlhist' pod/perlhist.pod
8c35d285 651
da571fa1 652=for checklist skip BLEAD-POINT
dc0a4df9
DM
653
654=head3 update patchlevel.h
8c35d285 655
6a958a95 656I<You MUST SKIP this step for a BLEAD-POINT release>
d7eb1120 657
a42352ee
DM
658Update F<patchlevel.h> to add a C<-RC1>-or-whatever string; or, if this is
659a final release, remove it. For example:
d7eb1120
DM
660
661 static const char * const local_patches[] = {
662 NULL
663 + ,"RC1"
664 PERL_GIT_UNPUSHED_COMMITS /* do not remove this line */
665
666Be sure to commit your change:
667
668 $ git commit -m 'bump version to RCnnn' patchlevel.h
669
dc0a4df9
DM
670
671=head3 build, test and check a fresh perl
d7eb1120 672
a0db33fe
DM
673Build perl, then make sure it passes its own test suite, and installs:
674
675 $ git clean -xdf
a42352ee
DM
676 $ ./Configure -des -Dprefix=/tmp/perl-5.x.y-pretest
677
678 # or if it's an odd-numbered version:
a0db33fe 679 $ ./Configure -des -Dusedevel -Dprefix=/tmp/perl-5.x.y-pretest
a42352ee 680
a0db33fe
DM
681 $ make test install
682
52a66c2c
DM
683Check that the output of C</tmp/perl-5.x.y-pretest/bin/perl -v> and
684C</tmp/perl-5.x.y-pretest/bin/perl -V> are as expected,
a0db33fe 685especially as regards version numbers, patch and/or RC levels, and @INC
52a66c2c
DM
686paths. Note that as they have been been built from a git working
687directory, they will still identify themselves using git tags and
01725c10
A
688commits. (Note that for an odd-numbered version, perl will install
689itself as C<perl5.x.y>). C<perl -v> will identify itself as:
690
691 This is perl 5, version X, subversion Y (v5.X.Y (v5.X.Z-NNN-deadbeef))
692
693where 5.X.Z is the latest tag, Z the number of commits since this tag,
694and C<< deadbeef >> commit of that tag.
52a66c2c
DM
695
696Then delete the temporary installation.
697
dc0a4df9
DM
698
699=head3 push the work so far
52a66c2c 700
a0db33fe
DM
701Push all your recent commits:
702
703 $ git push origin ....
704
96054f12 705
dc0a4df9 706=head3 tag the release
96054f12 707
e8c01f92 708Tag the release (e.g.):
96054f12 709
b6d23947 710 $ git tag v5.11.0 -m "First release of the v5.11 series!"
e8c01f92 711
6a958a95 712It is B<VERY> important that from this point forward, you not push
f662f3b7
JV
713your git changes to the Perl master repository. If anything goes
714wrong before you publish your newly-created tag, you can delete
715and recreate it. Once you push your tag, we're stuck with it
716and you'll need to use a new version number for your release.
717
dc0a4df9
DM
718
719=head3 build the tarball
a0db33fe 720
0dcf3caa 721Before you run the following, you might want to install 7-Zip (the
0dcb816b 722C<p7zip-full> package under Debian or the C<p7zip> port on MacPorts) or
0dcf3caa
LB
723the AdvanceCOMP suite (e.g. the C<advancecomp> package under Debian,
724or the C<advancecomp> port on macports - 7-Zip on Windows is the
725same code as AdvanceCOMP, so Windows users get the smallest files
726first time). These compress about 5% smaller than gzip and bzip2.
727Over the lifetime of your distribution this will save a lot of
728people a small amount of download time and disk space, which adds
729up.
730
8c35d285
JV
731Create a tarball. Use the C<-s> option to specify a suitable suffix for
732the tarball and directory name:
733
734 $ cd root/of/perl/tree
735 $ make distclean
75a012fe
DM
736 $ git clean -xdf # make sure perl and git agree on files
737 $ git status # and there's nothing lying around
8c35d285 738
8c35d285
JV
739 $ perl Porting/makerel -b -s RC1 # for a release candidate
740 $ perl Porting/makerel -b # for a final release
741
742This creates the directory F<../perl-x.y.z-RC1> or similar, copies all
743the MANIFEST files into it, sets the correct permissions on them,
744adds DOS line endings to some, then tars it up as
745F<../perl-x.y.z-RC1.tar.gz>. With C<-b>, it also creates a C<tar.bz2> file.
746
6480287f
MT
747If you're getting your tarball suffixed with -uncommitted and you're sure
748your changes were all committed, you can override the suffix with:
749
750 $ perl Porting/makerel -b -s ''
96054f12 751
8c35d285
JV
752XXX if we go for extra tags and branches stuff, then add the extra details
753here
754
dc0a4df9 755Finally, clean up the temporary directory, e.g.
a42352ee
DM
756
757 $ rm -rf ../perl-x.y.z-RC1
758
dc0a4df9
DM
759
760=head3 test the tarball
761
00c28750 762Once you have a tarball it's time to test the tarball (not the repository).
dc0a4df9 763
00c28750 764=head4 Copy the tarball to a web server
a42352ee 765
8c35d285
JV
766Copy the tarballs (.gz and possibly .bz2) to a web server somewhere you
767have access to.
768
00c28750 769=head4 Download the tarball to another machine
8c35d285
JV
770
771Download the tarball to some other machine. For a release candidate,
772you really want to test your tarball on two or more different platforms
773and architectures. The #p5p IRC channel on irc.perl.org is a good place
774to find willing victims.
775
00c28750 776=head4 Check that F<Configure> works
8c35d285
JV
777
778Check that basic configuration and tests work on each test machine:
779
780 $ ./Configure -des && make all test
f6af4394 781
00c28750 782=head4 Run the test harness and install
f6af4394 783
8c35d285
JV
784Check that the test harness and install work on each test machine:
785
a42352ee 786 $ make distclean
8c35d285 787 $ ./Configure -des -Dprefix=/install/path && make all test_harness install
a42352ee 788 $ cd /install/path
8c35d285 789
00c28750 790=head4 Check C<perl -v> and C<perl -V>
8c35d285
JV
791
792Check that the output of C<perl -v> and C<perl -V> are as expected,
793especially as regards version numbers, patch and/or RC levels, and @INC
794paths.
795
796Note that the results may be different without a F<.git/> directory,
797which is why you should test from the tarball.
798
00c28750 799=head4 Run the Installation Verification Procedure utility
459fc3ca 800
9651cacc 801 $ ./perl utils/perlivp
459fc3ca
DM
802 ...
803 All tests successful.
804 $
805
00c28750 806=head4 Compare the installed paths to the last release
459fc3ca 807
d60a1044
DM
808Compare the pathnames of all installed files with those of the previous
809release (i.e. against the last installed tarball on this branch which you
810have previously verified using this same procedure). In particular, look
811for files in the wrong place, or files no longer included which should be.
812For example, suppose the about-to-be-released version is 5.10.1 and the
813previous is 5.10.0:
814
815 cd installdir-5.10.0/
816 find . -type f | perl -pe's/5\.10\.0/5.10.1/g' | sort > /tmp/f1
817 cd installdir-5.10.1/
818 find . -type f | sort > /tmp/f2
819 diff -u /tmp/f[12]
820
00c28750 821=head4 Test the CPAN client
d60a1044 822
8c35d285
JV
823Bootstrap the CPAN client on the clean install:
824
16c60e4e 825 $ bin/perl -MCPAN -e "shell"
8c35d285 826
16c60e4e
AB
827If you're running this on Win32 you probably also need a set of Unix
828command-line tools available for CPAN to function correctly without
e8c01f92
SH
829Perl alternatives like LWP installed. Cygwin is an obvious choice.)
830
00c28750 831=head4 Install the Inline module and test it
8c35d285 832
a42352ee
DM
833Try installing a popular CPAN module that's reasonably complex and that
834has dependencies; for example:
8c35d285 835
a42352ee
DM
836 CPAN> install Inline
837 CPAN> quit
8c35d285
JV
838
839Check that your perl can run this:
840
16c60e4e 841 $ bin/perl -lwe "use Inline C => q[int f() { return 42;}]; print f"
a42352ee
DM
842 42
843 $
8c35d285 844
00c28750 845=head4 Bootstrap the CPANPLUS client
8c35d285
JV
846
847Bootstrap the CPANPLUS client on the clean install:
848
75a012fe 849 $ bin/cpanp
8c35d285 850
e8c01f92
SH
851(Again, on Win32 you'll need something like Cygwin installed, but make sure
852that you don't end up with its various F<bin/cpan*> programs being found on
853the PATH before those of the Perl that you're trying to test.)
854
00c28750 855=head4 Install the DBI module with CPANPLUS
8c35d285 856
a42352ee
DM
857 CPAN Terminal> i DBI
858 CPAN Terminal> quit
859 $ bin/perl -MDBI -e 1
75a012fe 860 $
8c35d285 861
00c28750 862=head4 Make sure that perlbug works
8c35d285 863
00c28750 864Test L<perlbug> with the following:
47b1f096 865
a14438df 866 $ bin/perlbug
47b1f096
DM
867 ...
868 Subject: test bug report
869 Local perl administrator [yourself]:
870 Editor [vi]:
871 Module:
872 Category [core]:
873 Severity [low]:
874 (edit report)
875 Action (Send/Display/Edit/Subject/Save to File): f
876 Name of file to save message in [perlbug.rep]:
877 Action (Send/Display/Edit/Subject/Save to File): q
878
879and carefully examine the output (in F<perlbug.rep]>), especially
880the "Locally applied patches" section. If everything appears okay, then
75a012fe
DM
881delete the file, and try it again, this time actually submitting the bug
882report. Check that it shows up, then remember to close it!
47b1f096 883
da571fa1 884=for checklist skip BLEAD-POINT
dc0a4df9
DM
885
886=head3 monitor smokes
47b1f096 887
f6af4394
DM
888Wait for the smoke tests to catch up with the commit which this release is
889based on (or at least the last commit of any consequence).
7277a900 890
f6af4394
DM
891Then check that the smoke tests pass (particularly on Win32). If not, go
892back and fix things.
7277a900 893
6a958a95 894Note that for I<BLEAD-POINT> releases this may not be practical. It takes a
1eefd7d5 895long time for the smokers to catch up, especially the Win32
6a958a95
DM
896smokers. This is why we have a RC cycle for I<MAINT> and I<BLEAD-FINAL>
897releases, but for I<BLEAD-POINT> releases sometimes the best you can do is
898to plead with people on IRC to test stuff on their platforms, fire away,
899and then hope for the best.
7277a900 900
dc0a4df9
DM
901
902=head3 upload to PAUSE
7277a900 903
f6af4394 904Once smoking is okay, upload it to PAUSE. This is the point of no return.
db3f805e
JV
905If anything goes wrong after this point, you will need to re-prepare
906a new release with a new minor version or RC number.
907
a14438df
DM
908 https://pause.perl.org/
909
910(Login, then select 'Upload a file to CPAN')
911
45924287
RS
912If your workstation is not connected to a high-bandwidth,
913high-reliability connection to the Internet, you should probably use the
914"GET URL" feature (rather than "HTTP UPLOAD") to have PAUSE retrieve the
915new release from wherever you put it for testers to find it. This will
916eliminate anxious gnashing of teeth while you wait to see if your
91715 megabyte HTTP upload successfully completes across your slow, twitchy
c27b4e97
SH
918cable modem. You can make use of your home directory on dromedary for
919this purpose: F<http://users.perl5.git.perl.org/~USERNAME> maps to
920F</home/USERNAME/public_html>, where F<USERNAME> is your login account
921on dromedary. I<Remember>: if your upload is partially successful, you
922may need to contact a PAUSE administrator or even bump the version of perl.
45924287 923
a42352ee 924Upload both the .gz and .bz2 versions of the tarball.
f6af4394 925
38195a8c
DG
926Do not proceed any further until you are sure that your tarballs are on
927CPAN. Check your authors directory on one of the "fast" CPAN mirrors
b28f69c2 928(e.g., cpan.hexten.net
38195a8c 929or cpan.cpantesters.org) to confirm that your uploads have been successful.
c27b4e97 930
00c28750
DR
931=for checklist skip RC
932
933=head3 wait for indexing
934
76526317
FR
935I<You MUST SKIP this step for RC>
936
937Wait until you receive notification emails from the PAUSE indexer
938confirming that your uploads have been received. IMPORTANT -- you will
939probably get an email that indexing has failed, due to module permissions.
940This is considered normal.
941
dc0a4df9
DM
942
943=head3 publish tag
210de33e 944
f662f3b7 945Now that you've shipped the new perl release to PAUSE, it's
e8c01f92 946time to publish the tag you created earlier to the public git repo (e.g.):
f662f3b7
JV
947
948 $ git push origin tag v5.11.0
f6af4394 949
da571fa1 950=for checklist skip BLEAD-POINT
dc0a4df9
DM
951
952=head3 disarm patchlevel.h
f6af4394 953
6a958a95 954I<You MUST SKIP this step for BLEAD-POINT release>
113f3f4c 955
a42352ee 956Disarm the F<patchlevel.h> change; for example,
d7eb1120
DM
957
958 static const char * const local_patches[] = {
959 NULL
960 - ,"RC1"
961 PERL_GIT_UNPUSHED_COMMITS /* do not remove this line */
962
963Be sure to commit your change:
964
965 $ git commit -m 'disarm RCnnn bump' patchlevel.h
a14438df 966 $ git push origin ....
d7eb1120 967
2e831dfd 968
dc0a4df9
DM
969
970=head3 announce to p5p
2e831dfd 971
db3f805e 972Mail p5p to announce your new release, with a quote you prepared earlier.
f6af4394 973
098d30ef 974Use the template at Porting/release_announcement_template.txt
dc0a4df9 975
a8cecd9d
RS
976Send a carbon copy to C<noc@metacpan.org>
977
dc0a4df9 978=head3 update epigraphs.pod
f6af4394 979
85531b0a 980Add your quote to F<Porting/epigraphs.pod> and commit it.
606d51b7
Z
981Your release announcement will probably not have reached the web-visible
982archives yet, so you won't be able to include the customary link to the
983release announcement yet.
dc0a4df9 984
b02b3ec7
DR
985=head3 blog about your epigraph
986
987If you have a blog, please consider writing an entry in your blog explaining
988why you chose that particular quote for your epigraph.
989
da571fa1
DR
990=for checklist skip RC
991
dc0a4df9 992=head3 Module::CoreList nagging
85531b0a 993
bc4c40f2 994I<You MUST SKIP this step for RC>
8c35d285 995
75a012fe
DM
996Remind the current maintainer of C<Module::CoreList> to push a new release
997to CPAN.
7277a900 998
da571fa1 999=for checklist skip RC
dc0a4df9
DM
1000
1001=head3 new perldelta
a2cba4bc 1002
bc4c40f2 1003I<You MUST SKIP this step for RC>
7277a900 1004
bcfe7366 1005Create a new perldelta.
5ef3945b 1006
bcfe7366 1007=over 4
8e967a1c 1008
bcfe7366 1009=item *
8e967a1c 1010
bcfe7366 1011Confirm that you have a clean checkout with no local changes.
c5b87fed 1012
bcfe7366 1013=item *
17163f85 1014
bcfe7366 1015Run F<Porting/new-perldelta.pl>
8e967a1c 1016
bcfe7366 1017=item *
17163f85 1018
bcfe7366 1019Run the C<git add> commands it outputs to add new and modified files.
7277a900 1020
bcfe7366 1021=item *
7277a900 1022
bcfe7366 1023Verify that the build still works, by running C<./Configure> and
fd76d40d
SH
1024C<make test_porting>. (On Win32, run C<nmake> and
1025C<nmake test TEST_FILES="porting\*.t ..\lib\diagnostics.t">.)
17163f85 1026
bcfe7366 1027=item *
17163f85 1028
bcfe7366
NC
1029If F<t/porting/podcheck.t> spots errors in the new F<pod/perldelta.pod>,
1030run C<./perl -MTestInit t/porting/podcheck.t | less> for more detail.
1031Skip to the end of its test output to see the options it offers you.
57433fbf 1032
bcfe7366 1033=item *
75a012fe 1034
bcfe7366 1035When C<make test_porting> passes, commit the new perldelta.
75a012fe 1036
bcfe7366 1037=back
75a012fe 1038
21768cb3 1039At this point you may want to compare the commit with a previous bump to
fd76d40d 1040see if they look similar. See commit e3c71926d3 for an example of a
75a012fe 1041previous version bump.
57433fbf 1042
da571fa1 1043=for checklist skip BLEAD-POINT MAINT RC
dc0a4df9
DM
1044
1045=head3 bump version
57433fbf 1046
6a958a95 1047I<You MUST SKIP this step for RC, BLEAD-POINT, MAINT>
dc0a62a1 1048
6a958a95
DM
1049If this was a BLEAD-FINAL release (i.e. the first release of a new maint
1050series, 5.x.0 where x is even), then bump the version in the blead branch
1051in git, e.g. 5.12.0 to 5.13.0.
17163f85 1052
6d5e92cd
FC
1053First, add a new feature bundle to F<regen/feature.pl>, initially by just
1054copying the exiting entry, and bump the file's $VERSION (after the __END__
1055marker); e.g.
17163f85
DM
1056
1057 "5.14" => [qw(switch say state unicode_strings)],
1058 + "5.15" => [qw(switch say state unicode_strings)],
addebd58 1059
57fef7cc
FC
1060Run F<regen/feature.pl> to propagate the changes to F<lib/feature.pm>.
1061
dc0a4df9
DM
1062Then follow the section L<"Bump the version number"> to bump the version
1063in the remaining files and test and commit.
17163f85 1064
17163f85 1065
d5c37431
NC
1066=head3 clean build and test
1067
1068Run a clean build and test to make sure nothing obvious is broken.
1069
1070In particular, F<Porting/perldelta_template.pod> is intentionally exempted
1071from podchecker tests, to avoid false positives about placeholder text.
1072However, once it's copied to F<pod/perldelta.pod> the contents can now
ef4474b5
KW
1073cause test failures. Problems should resolved by doing one of the
1074following:
1075
1076=over
1077
1078=item 1
1079
1080Replace placeholder text with correct text.
1081
1082=item 2
1083
1084If the problem is from a broken placeholder link, you can add it to the
1085array C<@perldelta_ignore_links> in F<t/porting/podcheck.t>. Lines
1086containing such links should be marked with C<XXX> so that they get
1087cleaned up before the next release.
1088
1089=item 3
1090
1091Following the instructions output by F<t/porting/podcheck.t> on how to
1092update its exceptions database.
1093
1094=back
d5c37431 1095
dc0a4df9
DM
1096=head3 push commits
1097
1098Finally, push any commits done above.
1099
1100 $ git push origin ....
1101
da571fa1 1102=for checklist skip BLEAD-POINT MAINT RC
dc0a4df9
DM
1103
1104=head3 create maint branch
17163f85 1105
6a958a95 1106I<You MUST SKIP this step for RC, BLEAD-POINT, MAINT>
17163f85 1107
6a958a95
DM
1108If this was a BLEAD-FINAL release (i.e. the first release of a new maint
1109series, 5.x.0 where x is even), then create a new maint branch based on
1110the commit tagged as the current release.
7277a900 1111
233ca920
JV
1112Assuming you're using git 1.7.x or newer:
1113
17163f85 1114 $ git checkout -b maint-5.12 v5.12.0
233ca920 1115 $ git push origin -u maint-5.12
addebd58 1116
dc0a4df9 1117
da571fa1
DR
1118=for checklist skip BLEAD-POINT MAINT RC
1119
d5722260
DK
1120=head3 make the maint branch available in the APC
1121
1122Clone the new branch into /srv/gitcommon/branches on camel so the APC will
1123receive its changes.
1124
07697565 1125 $ git clone --branch maint-5.14 /gitroot/perl.git \
d5722260 1126 ? /srv/gitcommon/branches/perl-5.14.x
07697565 1127 $ chmod -R g=u /srv/gitcommon/branches/perl-5.14.x
d5722260
DK
1128
1129And nag the sysadmins to make this directory available via rsync.
1130
da571fa1 1131=for checklist skip BLEAD-POINT RC
d5722260 1132
dc0a4df9 1133=head3 copy perldelta.pod to other branches
addebd58 1134
6a958a95 1135I<You MUST SKIP this step for RC, BLEAD-POINT>
8c35d285 1136
c5b87fed 1137Copy the perldelta.pod for this release into the other branches; for
75a012fe 1138example:
7277a900 1139
c5b87fed 1140 $ cp -i ../5.10.x/pod/perldelta.pod pod/perl5101delta.pod # for example
75a012fe
DM
1141 $ git add pod/perl5101delta.pod
1142
0aef0fe5 1143Edit F<pod/perl.pod> to add an entry for the file, e.g.:
75a012fe
DM
1144
1145 perl5101delta Perl changes in version 5.10.1
bc4c40f2 1146
75a012fe 1147Then rebuild various files:
7277a900 1148
75a012fe
DM
1149 $ perl pod/buildtoc --build-all
1150
1151Finally, commit:
1152
1153 $ git commit -a -m 'add perlXXXdelta'
7277a900 1154
dc0a4df9
DM
1155
1156=head3 update perlhist.pod in other branches
7277a900 1157
f6af4394 1158Make sure any recent F<pod/perlhist.pod> entries are copied to
e8a7a70e 1159F<perlhist.pod> on other branches
f6af4394 1160e.g.
7277a900 1161
f6af4394 1162 5.8.9 2008-Dec-14
7277a900 1163
dc0a4df9
DM
1164
1165=head3 bump RT version number
6e40fbf9 1166
7c139051
DR
1167Log into http://rt.perl.org/ and check whether the new version is in the RT
1168fields C<Perl Version> and C<Fixed In>. The easiest way to determine this is
1169to go to L<https://rt.perl.org/rt3/Search/Build.html> and click on the drop
1170downs next to the C<Perl Version> and C<Fixed In> labels.
1171
1172If the new version is not listed there, send an email to C<perlbug-admin at
1173perl.org> requesting this.
dc0a4df9
DM
1174
1175=head3 Relax!
a3738a12 1176
bc4c40f2
JV
1177I<You MUST RETIRE to your preferred PUB, CAFE or SEASIDE VILLA for some
1178much-needed rest and relaxation>.
8c35d285
JV
1179
1180Thanks for releasing perl!
1181
7277a900 1182
b28f69c2
Z
1183=head2 Building a release - the day after
1184
606d51b7
Z
1185=head3 link announcement in epigraphs.pod
1186
1187Add, to your quote to F<Porting/epigraphs.pod>, a link to the release
1188announcement in the web-visible mailing list archive. Commit it.
1189
dc0a4df9
DM
1190=head3 check tarball availability
1191
1192Check various website entries to make sure the that tarball has appeared
1193and is properly indexed:
1194
b28f69c2
Z
1195=over 4
1196
1197=item *
1198
98df743a
Z
1199Check your author directory under L<http://www.cpan.org/authors/id/>
1200to ensure that the tarballs are available on the website.
b28f69c2
Z
1201
1202=item *
1203
98df743a
Z
1204Check C</src> on CPAN (on a fast mirror) to ensure that links to
1205the new tarballs have appeared. There should be links in C</src/5.0>
1206(which is accumulating all new versions), links in C</src> (which shows
1207only the latest version on each branch), and an appropriate mention in
1208C</src/README.html> (which describes the latest versions).
1209
1210These links should appear automatically, some hours after upload.
1211If they don't, or the C<README.html> description is inadequate,
1212ask Ask <ask@perl.org>.
b28f69c2
Z
1213
1214=item *
1215
98df743a
Z
1216Check L<http://www.cpan.org/src/> to ensure that the C</src> updates
1217have been correctly mirrored to the website.
1218If they haven't, ask Ask <ask@perl.org>.
1219
1220=item *
b28f69c2 1221
98df743a
Z
1222Check L<http://search.cpan.org> to see if it has indexed the distribution.
1223It should be visible at a URL like C<http://search.cpan.org/dist/perl-5.10.1/>.
b28f69c2 1224
dc0a4df9 1225=back
b28f69c2 1226
e7b51df1 1227=for checklist skip RC
dc0a4df9
DM
1228
1229=head3 update dev.perl.org
1230
e7b51df1 1231I<You MUST SKIP this step for a RC release>
98df743a 1232
7a664ed5
RS
1233In your C<perlorg> repository, link to the new release. For a new
1234latest-maint release, edit F<docs/shared/tpl/stats.html>. Otherwise,
1235edit F<docs/dev/perl5/index.html>.
1236
1237Then make a pull request to Leo Lapworth. If this fails for some reason
1238and you cannot cajole anybody else into submitting that change, you can
1239mail Leo as last resort.
b28f69c2 1240
7dbb22ac
A
1241This repository can be found on L<github|https://github.com/perlorg/perlweb>.
1242
da571fa1 1243=for checklist end
b28f69c2 1244
7277a900
GS
1245=head1 SOURCE
1246
f6af4394
DM
1247Based on
1248http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2009-05/msg00608.html,
1249plus a whole bunch of other sources, including private correspondence.
7277a900
GS
1250
1251=cut
1252