The Module-CoreList on CPAN is now 5.20141002
[perl.git] / Porting / release_managers_guide.pod
1 =encoding utf8
2
3 =head1 NAME
4
5 release_managers_guide - Releasing a new version of perl 5.x
6
7 Note that things change at each release, so there may be new things not
8 covered here, or tools may need updating.
9
10 =head1 MAKING A CHECKLIST
11
12 If you are preparing to do a release, you can run the
13 F<Porting/make-rmg-checklist> script to generate a new version of this
14 document that starts with a checklist for your release.
15
16 This script is run as:
17
18   perl Porting/make-rmg-checklist \
19       --type [BLEAD-POINT or MAINT or ...] > /tmp/rmg.pod
20
21 You can also pass the C<--html> flag to generate an HTML document instead of
22 POD.
23
24   perl Porting/make-rmg-checklist --html \
25       --type [BLEAD-POINT or MAINT or ...] > /tmp/rmg.html
26
27 =head1 SYNOPSIS
28
29 This document describes the series of tasks required - some automatic, some
30 manual - to produce a perl release of some description, be that a release
31 candidate, or final, numbered release of maint or blead.
32
33 The release process has traditionally been executed by the current
34 pumpking. Blead releases from 5.11.0 forward are made each month on the
35 20th by a non-pumpking release engineer.  The release engineer roster
36 and schedule can be found in Porting/release_schedule.pod.
37
38 This document both helps as a check-list for the release engineer
39 and is a base for ideas on how the various tasks could be automated
40 or distributed.
41
42 The checklist of a typical release cycle is as follows:
43
44     (5.10.1 is released, and post-release actions have been done)
45
46     ...time passes...
47
48     a few weeks before the release, a number of steps are performed,
49         including bumping the version to 5.10.2
50
51     ...a few weeks pass...
52
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
58         perldelta.pod
59
60     ... the cycle continues ...
61
62 =head1 DETAILS
63
64 Some of the tasks described below apply to all four types of
65 release of Perl. (blead, RC, final release of maint, final
66 release of blead). Some of these tasks apply only to a subset
67 of these release types.  If a step does not apply to a given
68 type of release, you will see a notation to that effect at
69 the beginning of the step.
70
71 =head2 Release types
72
73 =over 4
74
75 =item Release Candidate (RC)
76
77 A release candidate is an attempt to produce a tarball that is a close as
78 possible to the final release. Indeed, unless critical faults are found
79 during the RC testing, the final release will be identical to the RC
80 barring a few minor fixups (updating the release date in F<perlhist.pod>,
81 removing the RC status from F<patchlevel.h>, etc). If faults are found,
82 then the fixes should be put into a new release candidate, never directly
83 into a final release.
84
85
86 =item Stable/Maint release (MAINT).
87
88 A release with an even version number, and subversion number > 0, such as
89 5.14.1 or 5.14.2.
90
91 At this point you should have a working release candidate with few or no
92 changes since.
93
94 It's essentially the same procedure as for making a release candidate, but
95 with a whole bunch of extra post-release steps.
96
97 Note that for a maint release there are two versions of this guide to
98 consider: the one in the maint branch, and the one in blead. Which one to
99 use is a fine judgement. The blead one will be most up-to-date, while
100 it might describe some steps or new tools that aren't applicable to older
101 maint branches. It is probably best to review both versions of this
102 document, but to most closely follow the steps in the maint version.
103
104 =item A blead point release (BLEAD-POINT)
105
106 A release with an odd version number, such as 5.15.0 or 5.15.1.
107
108 This isn't for production, so it has less stability requirements than for
109 other release types, and isn't preceded by RC releases. Other than that,
110 it is similar to a MAINT release.
111
112 =item Blead final release (BLEAD-FINAL)
113
114 A release with an even version number, and subversion number == 0, such as
115 5.14.0. That is to say, it's the big new release once per year.
116
117 It's essentially the same procedure as for making a release candidate, but
118 with a whole bunch of extra post-release steps, even more than for MAINT.
119
120 =back
121
122 =for checklist begin
123
124 =head2 Prerequisites
125
126 Before you can make an official release of perl, there are a few
127 hoops you need to jump through:
128
129 =head3 PAUSE account with pumpkin status
130
131 Make sure you have a PAUSE account suitable for uploading a perl release.
132 If you don't have a PAUSE account, then request one:
133
134     https://pause.perl.org/pause/query?ACTION=request_id
135
136 Check that your account is allowed to upload perl distros: go to
137 L<https://pause.perl.org/pause/authenquery?ACTION=who_pumpkin> and check that
138 your PAUSE ID is listed there.  If not, ask Andreas KE<0xf6>nig to add your ID
139 to the list of people allowed to upload something called perl.  You can find
140 Andreas' email address at:
141
142     https://pause.perl.org/pause/query?ACTION=pause_04imprint
143
144 =head3 search.cpan.org pumpkin status
145
146 Make sure that search.cpan.org knows that you're allowed to upload
147 perl distros. Contact Graham Barr to make sure that you're on the right
148 list.
149
150 =head3 rt.perl.org update access
151
152 Make sure you have permission to close tickets on L<http://rt.perl.org/>
153 so you can respond to bug report as necessary during your stint.  If you
154 don't, make an account (if you don't have one) and contact the pumpking
155 with your username to get ticket-closing permission.
156
157 =head3 git checkout and commit bit
158
159 You will need a working C<git> installation, checkout of the perl
160 git repository and perl commit bit.  For information about working
161 with perl and git, see F<pod/perlgit.pod>.
162
163 If you are not yet a perl committer, you won't be able to make a
164 release.  Have a chat with whichever evil perl porter tried to talk
165 you into the idea in the first place to figure out the best way to
166 resolve the issue.
167
168 =head3 git clone of https://github.com/perlorg/perlweb
169
170 For updating the L<http://dev.perl.org> web pages, either a Github account or
171 sweet-talking somebody with a Github account into obedience is needed. This
172 is only needed on the day of the release or shortly afterwards.
173
174 =head3 Quotation for release announcement epigraph
175
176 You will need a quotation to use as an epigraph to your release announcement.
177
178 =head2 Building a release - advance actions
179
180 The work of building a release candidate for an even numbered release
181 (BLEAD-FINAL) of perl generally starts several weeks before the first
182 release candidate.  Some of the following steps should be done regularly,
183 but all I<must> be done in the run up to a release.
184
185 =head3 dual-life CPAN module synchronisation
186
187 To see which core distro versions differ from the current CPAN versions:
188
189     $ ./perl -Ilib Porting/core-cpan-diff -x -a
190
191 However, this only checks whether the version recorded in
192 F<Porting/Maintainers.pl> differs from the latest on CPAN.  It doesn't tell you
193 if the code itself has diverged from CPAN.
194
195 You can also run an actual diff of the contents of the modules, comparing core
196 to CPAN, to ensure that there were no erroneous/extraneous changes that need to
197 be dealt with. You do this by not passing the C<-x> option:
198
199     $ ./perl -Ilib Porting/core-cpan-diff -a -o /tmp/corediffs
200
201 Passing C<-u cpan> will probably be helpful, since it limits the search to
202 distributions with 'cpan' upstream source.  (It's OK for blead upstream to
203 differ from CPAN because those dual-life releases usually come I<after> perl
204 is released.)
205
206 See also the C<-d> and C<-v> options for more detail (and the C<-u> option as
207 mentioned above).  You'll probably want to use the C<-c cachedir> option to
208 avoid repeated CPAN downloads and may want to use C<-m file:///mirror/path> if
209 you made a local CPAN mirror. Note that a minicpan mirror won't actually work,
210 but can provide a good first pass to quickly get a list of modules which
211 definitely haven't changed, to avoid having to download absolutely everything.
212
213 For a BLEAD-POINT or BLEAD-FINAL release with 'cpan' upstream, if a CPAN
214 release appears to be ahead of blead, then consider updating it (or asking the
215 relevant porter to do so). (However, if this is a BLEAD-FINAL release or one of
216 the last BLEAD-POINT releases before it and hence blead is in some kind of
217 "code freeze" state (e.g. the sequence might be "contentious changes freeze",
218 then "user-visible changes freeze" and finally "full code freeze") then any
219 CPAN module updates must be subject to the same restrictions, so it may not be
220 possible to update all modules until after the BLEAD-FINAL release.) If blead
221 contains edits to a 'cpan' upstream module, this is naughty but sometimes
222 unavoidable to keep blead tests passing. Make sure the affected file has a
223 CUSTOMIZED entry in F<Porting/Maintainers.pl>.
224
225 If you are making a MAINT release, run C<core-cpan-diff> on both blead and
226 maint, then diff the two outputs. Compare this with what you expect, and if
227 necessary, fix things up. For example, you might think that both blead
228 and maint are synchronised with a particular CPAN module, but one might
229 have some extra changes.
230
231 =head3 How to sync a CPAN module with a cpan/ distro
232
233 =over 4
234
235 =item *
236
237 Fetch the most recent version from CPAN.
238
239 =item *
240
241 Unpack the retrieved tarball. Rename the old directory; rename the new
242 directory to the original name.
243
244 =item *
245
246 Restore any F<.gitignore> file. This can be done by issuing
247 C<git checkout .gitignore> in the F<cpan/Distro> directory.
248
249 =item *
250
251 Remove files we do not need. That is, remove any files that match the
252 entries in C<@IGNORABLE> in F<Porting/Maintainer.pl>, and anything that
253 matches the C<EXCLUDED> section of the distro's entry in the C<%Modules>
254 hash.
255
256 =item *
257
258 Restore any files mentioned in the C<CUSTOMIZED> section, using
259 C<git checkout>. Make any new customizations if necessary. Also,
260 restore any files that are mentioned in C<@IGNORE>, but were checked
261 into the repository anyway.
262
263 =item *
264
265 For any new files in the distro, determine whether they are needed.
266 If not, delete them, and list them in either C<EXCLUDED> or C<@INGORE>.
267 Otherwise, add them to C<MANIFEST>, and run C<git add> to add the files
268 to the repository.
269
270 =item *
271
272 For any files that are gone, remove them from C<MANIFEST>, and use
273 C<git rm> to tell git the files will be gone.
274
275 =item *
276
277 If the C<MANIFEST> file was changed in any of the previous steps, run
278 C<perl Porting/manisort --output MANIFEST.sort; mv MANIFEST.sort MANIFEST>.
279
280 =item *
281
282 For any files that have an execute bit set, either remove the execute
283 bit, or edit F<Porting/exec-bit.txt>
284
285 =item *
286
287 Run C<make> (or C<nmake> on Windows), see if C<perl> compiles.
288
289 =item *
290
291 Run the tests for the package.
292
293 =item *
294
295 Run the tests in F<t/porting>.
296
297 =item *
298
299 Update the C<DISTRIBUTION> entry in F<Porting/Maintainers.pl>.
300
301 =item *
302
303 Run a full configure/build/test cycle.
304
305 =item *
306
307 If everything is ok, commit the changes.
308
309 =back
310
311 For entries with a non-simple C<FILES> section, or with a C<MAP>, you
312 may have to take more steps than listed above.
313
314 F<Porting/sync-with-cpan> is a script that automates most of the steps
315 above; but see the comments at the beginning of the file.  In particular,
316 it has not yet been exercised on Windows, but will certainly require a set
317 of Unix tools such as Cygwin, and steps that run C<make> will need to run
318 C<nmake> instead.
319
320 =head3 dual-life CPAN module stability
321
322 Ensure dual-life CPAN modules are stable, which comes down to:
323
324  for each module that fails its regression tests on $current
325      did it fail identically on $previous?
326      if yes, "SEP" (Somebody Else's Problem)
327      else work out why it failed (a bisect is useful for this)
328
329  attempt to group failure causes
330
331  for each failure cause
332      is that a regression?
333      if yes, figure out how to fix it
334          (more code? revert the code that broke it)
335      else
336          (presumably) it's relying on something un-or-under-documented
337          should the existing behaviour stay?
338              yes - goto "regression"
339              no - note it in perldelta as a significant bugfix
340              (also, try to inform the module's author)
341
342 =head3 monitor smoke tests for failures
343
344 Similarly, monitor the smoking of core tests, and try to fix.  See
345 L<http://doc.procura.nl/smoke/index.html> and L<http://perl5.test-smoke.org/>
346 for a summary. See also
347 L<http://www.nntp.perl.org/group/perl.daily-build.reports/> which has
348 the raw reports.
349
350 Similarly, monitor the smoking of perl for compiler warnings, and try to
351 fix.
352
353 =head3 update perldelta
354
355 Get perldelta in a mostly finished state.
356
357 Read  F<Porting/how_to_write_a_perldelta.pod>, and try to make sure that
358 every section it lists is, if necessary, populated and complete. Copy
359 edit the whole document.
360
361 You won't be able to automatically fill in the "Updated Modules" section until
362 after Module::CoreList is updated (as described below in
363 L<"update Module::CoreList">).
364
365 =head3 Bump the version number
366
367 Do not do this yet for a BLEAD-POINT release! You will do this at the end of
368 the release process.
369
370 Increase the version number (e.g. from 5.12.0 to 5.12.1).
371
372 For a release candidate for a stable perl, this should happen a week or two
373 before the first release candidate to allow sufficient time for testing and
374 smoking with the target version built into the perl executable. For
375 subsequent release candidates and the final release, it is not necessary to
376 bump the version further.
377
378 There is a tool to semi-automate this process:
379
380      $ ./perl -Ilib Porting/bump-perl-version -i 5.10.0 5.10.1
381
382 Remember that this tool is largely just grepping for '5.10.0' or whatever,
383 so it will generate false positives. Be careful not change text like
384 "this was fixed in 5.10.0"!
385
386 Use git status and git diff to select changes you want to keep.
387
388 Be particularly careful with F<INSTALL>, which contains a mixture of
389 C<5.10.0>-type strings, some of which need bumping on every release, and
390 some of which need to be left unchanged.
391 The line in F<INSTALL> about "is binary incompatible with" requires a
392 correct choice of earlier version to declare incompatibility with.
393
394 For the first RC release leading up to a BLEAD-FINAL release, update the
395 description of which releases are now "officially" supported in
396 F<pod/perlpolicy.pod>.
397
398 When doing a BLEAD-POINT or BLEAD-FINAL release, also make sure the
399 C<PERL_API_*> constants in F<patchlevel.h> are in sync with the version
400 you're releasing, unless you're absolutely sure the release you're about to
401 make is 100% binary compatible to an earlier release. When releasing a MAINT
402 perl version, the C<PERL_API_*> constants C<MUST NOT> be changed as we aim
403 to guarantee binary compatibility in maint branches.
404
405 After editing, regenerate uconfig.h (this must be run on a system with a
406 /bin/sh available):
407
408  $ perl regen/uconfig_h.pl
409
410 This might not cause any new changes.
411
412 Test your changes:
413
414  $ git clean -xdf   # careful if you don't have local files to keep!
415  $ ./Configure -des -Dusedevel
416  $ make
417  $ make test
418
419 Commit your changes:
420
421  $ git status
422  $ git diff
423  B<review the delta carefully>
424
425  $ git commit -a -m 'Bump the perl version in various places for 5.x.y'
426
427 At this point you may want to compare the commit with a previous bump to
428 see if they look similar.  See commit f7cf42bb69 for an example of a
429 previous version bump.
430
431 When the version number is bumped, you should also update Module::CoreList
432 (as described below in L<"update Module::CoreList">) to reflect the new
433 version number.
434
435 =head3 update INSTALL
436
437 Review and update INSTALL to account for the change in version number;
438 in particular, the "Coexistence with earlier versions of perl 5" section.
439
440 Be particularly careful with the section "Upgrading from 5.X.Y or earlier".
441 The "X.Y" needs to be changed to the most recent version that we are
442 I<not> binary compatible with.
443
444 For MAINT and BLEAD-FINAL releases, this needs to refer to the last
445 release in the previous development cycle (so for example, for a 5.14.x
446 release, this would be 5.13.11).
447
448 For BLEAD-POINT releases, it needs to refer to the previous BLEAD-POINT
449 release (so for 5.15.3 this would be 5.15.2).
450
451 =head3 Check copyright years
452
453 Check that the copyright years are up to date by running:
454
455  $ ./perl t/porting/copyright.t --now
456
457 Remedy any test failures by editing README or perl.c accordingly (search for
458 the "Copyright"). If updating perl.c, check if the file's own copyright date in
459 the C comment at the top needs updating, as well as the one printed by C<-v>.
460
461 =head3 Check more build configurations
462
463 Try running the full test suite against multiple Perl configurations. Here are
464 some sets of Configure flags you can try:
465
466 =over 4
467
468 =item *
469
470 C<-Duseshrplib -Dusesitecustomize>
471
472 =item *
473
474 C<-Duserelocatableinc>
475
476 =item *
477
478 C<-Dusethreads>
479
480 =back
481
482 If you have multiple compilers on your machine, you might also consider
483 compiling with C<-Dcc=$other_compiler>.
484
485 =head3 update perlport
486
487 L<perlport> has a section currently named I<Supported Platforms> that
488 indicates which platforms are known to build in the current release.
489 If necessary update the list and the indicated version number.
490
491 =head3 check a readonly build
492
493 Even before other prep work, follow the steps in  L<build the tarball> and test
494 it locally.  Because a perl source tarballs sets many files read-only, it could
495 test differently than tests run from the repository.  After you're sure
496 permissions aren't a problem, delete the generated directory and tarballs.
497
498 =head2 Building a release - on the day
499
500 This section describes the actions required to make a release
501 that are performed near to, or on the actual release day.
502
503 =head3 re-check earlier actions
504
505 Review all the actions in the previous section,
506 L<"Building a release - advance actions"> to ensure they are all done and
507 up-to-date.
508
509 =head3 create a release branch
510
511 For BLEAD-POINT releases, making a release from a release branch avoids the
512 need to freeze blead during the release. This is less important for
513 BLEAD-FINAL, MAINT, and RC releases, since blead will already be frozen in
514 those cases. Create the branch by running
515
516   git checkout -b release-5.xx.yy
517
518 =head3 build a clean perl
519
520 Make sure you have a gitwise-clean perl directory (no modified files,
521 unpushed commits etc):
522
523     $ git status
524     $ git clean -dxf
525
526 then configure and build perl so that you have a Makefile and porting tools:
527
528     $ ./Configure -Dusedevel -des && make
529
530 =head3 update Module::CoreList
531
532 =head4 Bump Module::CoreList* $VERSIONs
533
534 If necessary, bump C<$Module::CoreList::VERSION> (there's no need to do this for
535 every RC; in RC1, bump the version to a new clean number that will
536 appear in the final release, and leave as-is for the later RCs and final).
537 It may also happen that C<Module::CoreList> has been modified in blead, and
538 hence has a new version number already.  (But make sure it is not the same
539 number as a CPAN release.)
540
541 C<$Module::CoreList::TieHashDelta::VERSION> and
542 C<$Module::CoreList::Utils::VERSION> should always be equal to
543 C<$Module::CoreList::VERSION>. If necessary, bump those two versions to match
544 before proceeding.
545
546 =head4 Update C<Module::CoreList> with module version data for the new release.
547
548 Note that if this is a MAINT release, you should run the following actions
549 from the maint branch, but commit the C<CoreList.pm> changes in
550 I<blead> and subsequently cherry-pick any releases since the last
551 maint release and then your recent commit.  XXX need a better example
552
553 [ Note that the procedure for handling Module::CoreList in maint branches
554 is a bit complex, and the RMG currently don't describe a full and
555 workable approach. The main issue is keeping Module::CoreList
556 and its version number synchronised across all maint branches, blead and
557 CPAN, while having to bump its version number for every RC release.
558 See this brief p5p thread:
559
560     Message-ID: <20130311174402.GZ2294@iabyn.com>
561
562 If you can devise a workable system, feel free to try it out, and to
563 update the RMG accordingly!
564
565 DAPM May 2013 ]
566
567 F<corelist.pl> uses ftp.funet.fi to verify information about dual-lived
568 modules on CPAN. It can use a full, local CPAN mirror and/or fall back
569 on HTTP::Tiny to fetch package metadata remotely.
570
571 (If you'd prefer to have a full CPAN mirror, see
572 http://www.cpan.org/misc/cpan-faq.html#How_mirror_CPAN)
573
574 Then change to your perl checkout, and if necessary,
575
576     $ make
577
578 Then, If you have a local CPAN mirror, run:
579
580     $ ./perl -Ilib Porting/corelist.pl ~/my-cpan-mirror
581
582 Otherwise, run:
583
584     $ ./perl -Ilib Porting/corelist.pl cpan
585
586 This will chug for a while, possibly reporting various warnings about
587 badly-indexed CPAN modules unrelated to the modules actually in core.
588 Assuming all goes well, it will update
589 F<dist/Module-CoreList/lib/Module/CoreList.pm> and possibly
590 F<dist/Module-CoreList/lib/Module/CoreList.pod> and/or
591 F<dist/Module-CoreList/lib/Module/CoreList/Utils.pm>.
592
593 Check those files over carefully:
594
595     $ git diff dist/Module-CoreList/lib/Module/CoreList.pm
596     $ git diff dist/Module-CoreList/lib/Module/CoreList.pod
597     $ git diff dist/Module-CoreList/lib/Module/CoreList/Utils.pm
598
599 =head4 Bump version in Module::CoreList F<Changes>
600
601 Also edit Module::CoreList's new version number in its F<Changes> file.
602
603 =head4 Add Module::CoreList version bump to perldelta
604
605 Add a perldelta entry for the new Module::CoreList version.
606
607 =for checklist skip RC
608
609 =head4 Update C<%Module::CoreList::released> and C<CAVEATS>
610
611 For any release except an RC:
612
613 =over 4
614
615 =item *
616
617 Update this version's entry in the C<%released> hash with today's date.
618
619 =item *
620
621 Make sure that the script has correctly updated the C<CAVEATS> section
622 (Note, the C<CAVEATS> section is in
623 F<dist/Module-CoreList/lib/Module/CoreList.pod>)
624
625 =back
626
627 =head4 Commit Module::CoreList changes
628
629 Finally, commit the new version of Module::CoreList:
630 (unless this is for MAINT; in which case commit it to blead first, then
631 cherry-pick it back).
632
633     $ git commit -m 'Update Module::CoreList for 5.x.y' dist/Module-CoreList/Changes dist/Module-CoreList/lib/Module/CoreList.pm dist/Module-CoreList/lib/Module/CoreList.pod dist/Module-CoreList/lib/Module/CoreList/Utils.pm
634
635 =head4 Rebuild and test
636
637 Build and test to get the changes into the currently built lib directory and to ensure
638 all tests are passing.
639
640 =head3 finalize perldelta
641
642 Finalize the perldelta.  In particular, fill in the Acknowledgements
643 section, which can be generated with something like:
644
645   $ perl Porting/acknowledgements.pl v5.15.0..HEAD
646
647 Fill in the "New/Updated Modules" sections now that Module::CoreList is updated:
648
649   $ ./perl -Ilib Porting/corelist-perldelta.pl --mode=update pod/perldelta.pod
650
651 Ideally, also fill in a summary of the major changes to each module for which
652 an entry has been added by F<corelist-perldelta.pl>.
653
654 Re-read the perldelta to try to find any embarrassing typos and thinkos;
655 remove any C<TODO> or C<XXX> flags; update the "Known Problems" section
656 with any serious issues for which fixes are not going to happen now; and
657 run through pod and spell checkers, e.g.
658
659     $ podchecker -warnings -warnings pod/perldelta.pod
660     $ spell pod/perldelta.pod
661
662 Also, you may want to generate and view an HTML version of it to check
663 formatting, e.g.
664
665     $ ./perl -Ilib ext/Pod-Html/bin/pod2html pod/perldelta.pod > /tmp/perldelta.html
666
667 Another good HTML preview option is http://search.cpan.org/pod2html
668
669 If you make changes, be sure to commit them.
670
671 =for checklist skip BLEAD-POINT MAINT RC
672
673 =head3 remove stale perldeltas
674
675 For the first RC release that is ONLY for a BLEAD-FINAL, the perldeltas
676 from the BLEAD-POINT releases since the previous BLEAD-FINAL should have
677 now been consolidated into the current perldelta, and hence are now just
678 useless clutter.  They can be removed using:
679
680     $ git rm <file1> <file2> ...
681
682 For example, for RC0 of 5.16.0:
683
684     $ cd pod
685     $ git rm perldelta515*.pod
686
687 =for checklist skip BLEAD-FINAL BLEAD-POINT
688
689 =head3 add recent perldeltas
690
691 For the first RC for a MAINT release, copy in any recent perldeltas from
692 blead that have been added since the last release on this branch. This
693 should include any recent maint releases on branches older than your one,
694 but not newer. For example if you're producing a 5.14.x release, copy any
695 perldeltas from recent 5.10.x, 5.12.x etc maint releases, but not from
696 5.16.x or higher. Remember to
697
698     $ git add <file1> <file2> ...
699
700 =head3 update and commit perldelta files
701
702 If you have added or removed any perldelta files via the previous two
703 steps, then edit F<pod/perl.pod> to add/remove them from its table of
704 contents, then run F<Porting/pod_rules.pl> to propagate your changes there
705 into all the other files that mention them (including F<MANIFEST>). You'll
706 need to C<git add> the files that it changes.
707
708 Then build a clean perl and do a full test
709
710     $ git status
711     $ git clean -dxf
712     $ ./Configure -Dusedevel -des
713     $ make
714     $ make test
715
716 Once all tests pass, commit your changes.
717
718 =head3 build a clean perl
719
720 If you skipped the previous step (adding/removing perldeltas),
721 again, make sure you have a gitwise-clean perl directory (no modified files,
722 unpushed commits etc):
723
724     $ git status
725     $ git clean -dxf
726
727 then configure and build perl so that you have a Makefile and porting tools:
728
729     $ ./Configure -Dusedevel -des && make
730
731 =for checklist skip BLEAD-FINAL BLEAD-POINT
732
733 =head3 synchronise from blead's perlhist.pod
734
735 For the first RC for a MAINT release, copy in the latest
736 F<pod/perlhist.pod> from blead; this will include details of newer
737 releases in all branches. In theory, blead's version should be a strict
738 superset of the one in this branch, but it's probably safest to diff them
739 first to ensure that there's nothing in this branch that was forgotten
740 from blead:
741
742     $ diff pod/perlhist.pod ..../blead/pod/perlhist.pod
743     $ cp  ..../blead/pod/perlhist.pod pod/
744     $ git commit -m 'sync perlhist from blead' pod/perlhist.pod
745
746 =head3 update perlhist.pod
747
748 Add an entry to F<pod/perlhist.pod> with the release date, e.g.:
749
750     David    5.10.1       2009-Aug-06
751
752 List yourself in the left-hand column, and if this is the first release
753 that you've ever done, make sure that your name is listed in the section
754 entitled C<THE KEEPERS OF THE PUMPKIN>.
755
756 I<If you're making a BLEAD-FINAL release>, also update the "SELECTED
757 RELEASE SIZES" section with the output of
758 F<Porting/perlhist_calculate.pl>.
759
760 Be sure to commit your changes:
761
762     $ git commit -m 'add new release to perlhist' pod/perlhist.pod
763
764 =for checklist skip BLEAD-POINT
765
766 =head3 update patchlevel.h
767
768 I<You MUST SKIP this step for a BLEAD-POINT release>
769
770 Update F<patchlevel.h> to add a C<-RC1>-or-whatever string; or, if this is
771 a final release, remove it. For example:
772
773      static const char * const local_patches[] = {
774              NULL
775     +        ,"RC1"
776              PERL_GIT_UNPUSHED_COMMITS /* do not remove this line */
777
778 Be sure to commit your change:
779
780     $ git commit -m 'bump version to RCnnn' patchlevel.h
781
782 =head3 run makemeta to update META files
783
784     $ ./perl -Ilib Porting/makemeta
785
786 Be sure to commit any changes (if applicable):
787
788     $ git status   # any changes?
789     $ git commit -m 'Update META files' META.*
790
791 =head3 build, test and check a fresh perl
792
793 Build perl, then make sure it passes its own test suite, and installs:
794
795     $ git clean -xdf
796     $ ./Configure -des -Dprefix=/tmp/perl-5.x.y-pretest
797
798     # or if it's an odd-numbered version:
799     $ ./Configure -des -Dusedevel -Dprefix=/tmp/perl-5.x.y-pretest
800
801     $ make test install
802
803 Check that the output of C</tmp/perl-5.x.y-pretest/bin/perl -v> and
804 C</tmp/perl-5.x.y-pretest/bin/perl -V> are as expected,
805 especially as regards version numbers, patch and/or RC levels, and @INC
806 paths. Note that as they have been built from a git working
807 directory, they will still identify themselves using git tags and
808 commits. (Note that for an odd-numbered version, perl will install
809 itself as C<perl5.x.y>). C<perl -v> will identify itself as:
810
811  This is perl 5, version X, subversion Y (v5.X.Y (v5.X.Z-NNN-gdeadbeef))
812
813 where 5.X.Z is the latest tag, NNN the number of commits since this tag,
814 and C<< deadbeef >> commit of that tag.
815
816 Then delete the temporary installation.
817
818 =head3 create the release tag
819
820 Create the tag identifying this release (e.g.):
821
822     $ git tag v5.11.0 -m "First release of the v5.11 series!"
823
824 It is B<VERY> important that from this point forward, you not push
825 your git changes to the Perl master repository.  If anything goes
826 wrong before you publish your newly-created tag, you can delete
827 and recreate it.  Once you push your tag, we're stuck with it
828 and you'll need to use a new version number for your release.
829
830 =head3 build the tarball
831
832 Before you run the following, you might want to install 7-Zip (the
833 C<p7zip-full> package under Debian or the C<p7zip> port on MacPorts) or
834 the AdvanceCOMP suite (e.g. the C<advancecomp> package under Debian,
835 or the C<advancecomp> port on macports - 7-Zip on Windows is the
836 same code as AdvanceCOMP, so Windows users get the smallest files
837 first time). These compress about 5% smaller than gzip and bzip2.
838 Over the lifetime of your distribution this will save a lot of
839 people a small amount of download time and disk space, which adds
840 up.
841
842 Create a tarball. Use the C<-s> option to specify a suitable suffix for
843 the tarball and directory name:
844
845  $ cd root/of/perl/tree
846  $ make distclean       # make sure distclean works
847  $ git clean -xdf       # make sure perl and git agree on files
848                         # git clean should not output anything!
849  $ git status           # and there's nothing lying around
850
851  $ perl Porting/makerel -b -s RC1            # for a release candidate
852  $ perl Porting/makerel -b                   # for a final release
853
854 This creates the  directory F<../perl-x.y.z-RC1> or similar, copies all
855 the MANIFEST files into it, sets the correct permissions on them, then
856 tars it up as F<../perl-x.y.z-RC1.tar.gz>. With C<-b>, it also creates a
857 C<tar.bz2> file.
858
859 If you're getting your tarball suffixed with -uncommitted and you're sure
860 your changes were all committed, you can override the suffix with:
861
862     $ perl Porting/makerel -b -s ''
863
864 XXX if we go for extra tags and branches stuff, then add the extra details
865 here
866
867 Finally, clean up the temporary directory, e.g.
868
869     $ rm -rf ../perl-x.y.z-RC1
870
871 =head3 test the tarball
872
873 Once you have a tarball it's time to test the tarball (not the repository).
874
875 =head4 Copy the tarball to a web server
876
877 Copy the tarballs (.gz and possibly .bz2) to a web server somewhere you
878 have access to.
879
880 =head4 Download the tarball to another machine
881
882 Download the tarball to some other machine. For a release candidate,
883 you really want to test your tarball on two or more different platforms
884 and architectures. The #p5p IRC channel on irc.perl.org is a good place
885 to find willing victims.
886
887 =head4 Check that F<Configure> works
888
889 Check that basic configuration and tests work on each test machine:
890
891     $ ./Configure -des && make all test
892
893     # Or for a development release:
894     $ ./Configure -Dusedevel -des && make all test
895
896 =head4 Run the test harness and install
897
898 Check that the test harness and install work on each test machine:
899
900     $ make distclean
901     $ ./Configure -des -Dprefix=/install/path && make all test_harness install
902     $ cd /install/path
903
904 =head4 Check C<perl -v> and C<perl -V>
905
906 Check that the output of C<perl -v> and C<perl -V> are as expected,
907 especially as regards version numbers, patch and/or RC levels, and @INC
908 paths.
909
910 Note that the results may be different without a F<.git/> directory,
911 which is why you should test from the tarball.
912
913 =head4 Run the Installation Verification Procedure utility
914
915     $ ./perl utils/perlivp
916     ...
917     All tests successful.
918     $
919
920 =head4 Compare the installed paths to the last release
921
922 Compare the pathnames of all installed files with those of the previous
923 release (i.e. against the last installed tarball on this branch which you
924 have previously verified using this same procedure). In particular, look
925 for files in the wrong place, or files no longer included which should be.
926 For example, suppose the about-to-be-released version is 5.10.1 and the
927 previous is 5.10.0:
928
929     cd installdir-5.10.0/
930     find . -type f | perl -pe's/5\.10\.0/5.10.1/g' | sort > /tmp/f1
931     cd installdir-5.10.1/
932     find . -type f | sort > /tmp/f2
933     diff -u /tmp/f[12]
934
935 =head4 Bootstrap the CPAN client
936
937 Bootstrap the CPAN client on the clean install:
938
939     $ bin/cpan
940
941     # Or, perhaps:
942     $ bin/cpan5.xx.x
943
944 =head4 Install the Inline module with CPAN and test it
945
946 Try installing a popular CPAN module that's reasonably complex and that
947 has dependencies; for example:
948
949     CPAN> install Inline::C
950     CPAN> quit
951
952 Check that your perl can run this:
953
954     $ bin/perl -lwe "use Inline C => q[int f() { return 42;}]; print f"
955     42
956     $
957
958 =head4 Make sure that perlbug works
959
960 Test L<perlbug> with the following:
961
962     $ bin/perlbug
963     ...
964     Subject: test bug report
965     Local perl administrator [yourself]:
966     Editor [vi]:
967     Module:
968     Category [core]:
969     Severity [low]:
970     (edit report)
971     Action (Send/Display/Edit/Subject/Save to File): f
972     Name of file to save message in [perlbug.rep]:
973     Action (Send/Display/Edit/Subject/Save to File): q
974
975 and carefully examine the output (in F<perlbug.rep]>), especially
976 the "Locally applied patches" section. If everything appears okay, then
977 delete the file, and try it again, this time actually submitting the bug
978 report. Check that it shows up, then remember to close it!
979
980 =for checklist skip BLEAD-POINT
981
982 =head3 monitor smokes
983
984 XXX This is probably irrelevant if working on a release branch, though
985 MAINT or RC might want to push a smoke branch and wait.
986
987 Wait for the smoke tests to catch up with the commit which this release is
988 based on (or at least the last commit of any consequence).
989
990 Then check that the smoke tests pass (particularly on Win32). If not, go
991 back and fix things.
992
993 Note that for I<BLEAD-POINT> releases this may not be practical. It takes a
994 long time for the smokers to catch up, especially the Win32
995 smokers. This is why we have a RC cycle for I<MAINT> and I<BLEAD-FINAL>
996 releases, but for I<BLEAD-POINT> releases sometimes the best you can do is
997 to plead with people on IRC to test stuff on their platforms, fire away,
998 and then hope for the best.
999
1000 =head3 upload to PAUSE
1001
1002 Once smoking is okay, upload it to PAUSE. This is the point of no return.
1003 If anything goes wrong after this point, you will need to re-prepare
1004 a new release with a new minor version or RC number.
1005
1006     https://pause.perl.org/
1007
1008 (Login, then select 'Upload a file to CPAN')
1009
1010 If your workstation is not connected to a high-bandwidth,
1011 high-reliability connection to the Internet, you should probably use the
1012 "GET URL" feature (rather than "HTTP UPLOAD") to have PAUSE retrieve the
1013 new release from wherever you put it for testers to find it.  This will
1014 eliminate anxious gnashing of teeth while you wait to see if your
1015 15 megabyte HTTP upload successfully completes across your slow, twitchy
1016 cable modem.  You can make use of your home directory on dromedary for
1017 this purpose: F<http://users.perl5.git.perl.org/~USERNAME> maps to
1018 F</home/USERNAME/public_html>, where F<USERNAME> is your login account
1019 on dromedary.  I<Remember>: if your upload is partially successful, you
1020 may need to contact a PAUSE administrator or even bump the version of perl.
1021
1022 Upload both the .gz and .bz2 versions of the tarball.
1023
1024 Do not proceed any further until you are sure that your tarballs are on CPAN.
1025 Check your authors directory www.cpan.org (the globally balanced "fast"
1026 mirror) to confirm that your uploads have been successful.
1027
1028 =for checklist skip RC BLEAD-POINT
1029
1030 =head3 wait for indexing
1031
1032 I<You MUST SKIP this step for RC and BLEAD-POINT>
1033
1034 Wait until you receive notification emails from the PAUSE indexer
1035 confirming that your uploads have been received.  IMPORTANT -- you will
1036 probably get an email that indexing has failed, due to module permissions.
1037 This is considered normal.
1038
1039 =for checklist skip BLEAD-POINT
1040
1041 =head3 disarm patchlevel.h
1042
1043 I<You MUST SKIP this step for BLEAD-POINT release>
1044
1045 Disarm the F<patchlevel.h> change; for example,
1046
1047      static const char * const local_patches[] = {
1048              NULL
1049     -        ,"RC1"
1050              PERL_GIT_UNPUSHED_COMMITS /* do not remove this line */
1051
1052 Be sure to commit your change:
1053
1054     $ git commit -m 'disarm RCnnn bump' patchlevel.h
1055
1056 =head3 announce to p5p
1057
1058 Mail p5p to announce your new release, with a quote you prepared earlier.
1059
1060 Use the template at Porting/release_announcement_template.txt
1061
1062 Send a carbon copy to C<noc@metacpan.org>
1063
1064 =head3 merge release branch back to blead
1065
1066 Merge the (local) release branch back into master now, and delete it.
1067
1068   git checkout blead
1069   git pull
1070   git merge release-5.xx.yy
1071   git push
1072   git branch -d release-5.xx.yy
1073
1074 Note: The merge will create a merge commit if other changes have been pushed
1075 to blead while you've been working on your release branch. Do NOT rebase your
1076 branch to avoid the merge commit (as you might normally do when merging a
1077 small branch into blead) since doing so will invalidate the tag that you
1078 created earlier.
1079
1080 =head3 publish the release tag
1081
1082 Now that you've shipped the new perl release to PAUSE and pushed your changes
1083 to the Perl master repository, it's time to publish the tag you created
1084 earlier too (e.g.):
1085
1086     $ git push origin tag v5.11.0
1087
1088 =head3 update epigraphs.pod
1089
1090 Add your quote to F<Porting/epigraphs.pod> and commit it.
1091 You can include the customary link to the release announcement even before your
1092 message reaches the web-visible archives by looking for the X-List-Archive
1093 header in your message after receiving it back via perl5-porters.
1094
1095 =head3 blog about your epigraph
1096
1097 If you have a blog, please consider writing an entry in your blog explaining
1098 why you chose that particular quote for your epigraph.
1099
1100 =for checklist skip RC
1101
1102 =head3 Module::CoreList nagging
1103
1104 I<You MUST SKIP this step for RC>
1105
1106 Remind the current maintainer of C<Module::CoreList> to push a new release
1107 to CPAN.
1108
1109 =for checklist skip RC
1110
1111 =head3 new perldelta
1112
1113 I<You MUST SKIP this step for RC>
1114
1115 Create a new perldelta.
1116
1117 =over 4
1118
1119 =item *
1120
1121 Confirm that you have a clean checkout with no local changes.
1122
1123 =item *
1124
1125 Run F<Porting/new-perldelta.pl>
1126
1127 =item *
1128
1129 Run the C<git add> commands it outputs to add new and modified files.
1130
1131 =item *
1132
1133 Verify that the build still works, by running C<./Configure> and
1134 C<make test_porting>. (On Win32 use the appropriate make utility).
1135
1136 =item *
1137
1138 If F<t/porting/podcheck.t> spots errors in the new F<pod/perldelta.pod>,
1139 run C<./perl -MTestInit t/porting/podcheck.t | less> for more detail.
1140 Skip to the end of its test output to see the options it offers you.
1141
1142 =item *
1143
1144 When C<make test_porting> passes, commit the new perldelta.
1145
1146 =back
1147
1148 At this point you may want to compare the commit with a previous bump to
1149 see if they look similar.  See commit ba03bc34a4 for an example of a
1150 previous version bump.
1151
1152 =for checklist skip MAINT RC
1153
1154 =head3 bump version
1155
1156 I<You MUST SKIP this step for RC and MAINT>
1157
1158 If this was a BLEAD-FINAL release (i.e. the first release of a new maint
1159 series, 5.x.0 where x is even), then bump the version in the blead branch
1160 in git, e.g. 5.12.0 to 5.13.0.
1161
1162 First, add a new feature bundle to F<regen/feature.pl>, initially by just
1163 copying the exiting entry, and bump the file's $VERSION (after the __END__
1164 marker); e.g.
1165
1166          "5.14" => [qw(switch say state unicode_strings)],
1167     +    "5.15" => [qw(switch say state unicode_strings)],
1168
1169 Run F<regen/feature.pl> to propagate the changes to F<lib/feature.pm>.
1170
1171 Then follow the section L<"Bump the version number"> to bump the version
1172 in the remaining files and test and commit.
1173
1174 If this was a BLEAD-POINT release, then just follow the section
1175 L<"Bump the version number">.
1176
1177 After bumping the version, follow the section L<"update INSTALL"> to
1178 ensure all version number references are correct.
1179
1180 (Note: The version is NOT bumped immediately after a MAINT release in order
1181 to avoid confusion and wasted time arising from bug reports relating to
1182 "intermediate versions" such as 5.20.1-and-a-bit: If the report is caused
1183 by a bug that gets fixed in 5.20.2 and this intermediate version already
1184 calls itself 5.20.2 then much time can be wasted in figuring out why there
1185 is a failure from something that "should have been fixed". If the bump is
1186 late then there is a much smaller window of time for such confusing bug
1187 reports to arise. (The opposite problem -- trying to figure out why there
1188 *is* a bug in something calling itself 5.20.1 when in fact the bug was
1189 introduced later -- shouldn't arise for MAINT releases since they should,
1190 in theory, only contain bug fixes but never regressions.))
1191
1192 =head3 clean build and test
1193
1194 Run a clean build and test to make sure nothing obvious is broken.
1195
1196 In particular, F<Porting/perldelta_template.pod> is intentionally exempted
1197 from podchecker tests, to avoid false positives about placeholder text.
1198 However, once it's copied to F<pod/perldelta.pod> the contents can now
1199 cause test failures. Problems should resolved by doing one of the
1200 following:
1201
1202 =over
1203
1204 =item 1
1205
1206 Replace placeholder text with correct text.
1207
1208 =item 2
1209
1210 If the problem is from a broken placeholder link, you can add it to the
1211 array C<@perldelta_ignore_links> in F<t/porting/podcheck.t>.  Lines
1212 containing such links should be marked with C<XXX> so that they get
1213 cleaned up before the next release.
1214
1215 =item 3
1216
1217 Following the instructions output by F<t/porting/podcheck.t> on how to
1218 update its exceptions database.
1219
1220 =back
1221
1222 =head3 push commits
1223
1224 Finally, push any commits done above.
1225
1226     $ git push origin ....
1227
1228 =for checklist skip BLEAD-POINT MAINT RC
1229
1230 =head3 create maint branch
1231
1232 I<You MUST SKIP this step for RC, BLEAD-POINT, MAINT>
1233
1234 If this was a BLEAD-FINAL release (i.e. the first release of a new maint
1235 series, 5.x.0 where x is even), then create a new maint branch based on
1236 the commit tagged as the current release.
1237
1238 Assuming you're using git 1.7.x or newer:
1239
1240     $ git checkout -b maint-5.12 v5.12.0
1241     $ git push origin -u maint-5.12
1242
1243
1244 =for checklist skip BLEAD-POINT MAINT RC
1245
1246 =head3 make the maint branch available in the APC
1247
1248 Clone the new branch into /srv/gitcommon/branches on camel so the APC will
1249 receive its changes.
1250
1251     $ git clone --branch maint-5.14 /gitroot/perl.git \
1252     ?  /srv/gitcommon/branches/perl-5.14.x
1253     $ chmod -R g=u /srv/gitcommon/branches/perl-5.14.x
1254
1255 And nag the sysadmins to make this directory available via rsync.
1256
1257 XXX Who are the sysadmins?  Contact info?
1258
1259 =for checklist skip BLEAD-POINT RC
1260
1261 =head3 copy perldelta.pod to blead
1262
1263 I<You MUST SKIP this step for RC, BLEAD-POINT>
1264
1265 Copy the perldelta.pod for this release into blead; for example:
1266
1267  $ cd ..../blead
1268  $ cp -i ../5.10.x/pod/perldelta.pod pod/perl5101delta.pod  # for example
1269  $ git add pod/perl5101delta.pod
1270
1271 Don't forget to set the NAME correctly in the new file (e.g. perl5101delta
1272 rather than perldelta).
1273
1274 Edit F<pod/perl.pod> to add an entry for the file, e.g.:
1275
1276     perl5101delta               Perl changes in version 5.10.1
1277
1278 Then rebuild various files:
1279
1280     $ perl Porting/pod_rules.pl
1281
1282 Finally, commit and push:
1283
1284     $ git commit -a -m 'add perlXXXdelta'
1285     $ git push origin ....
1286
1287 =for checklist skip BLEAD-POINT
1288
1289 =head3 copy perlhist.pod entries to blead
1290
1291 Make sure any recent F<pod/perlhist.pod> entries are copied to
1292 F<perlhist.pod> on blead.  e.g.
1293
1294           5.8.9         2008-Dec-14
1295
1296 =head3 bump RT version number
1297
1298 Log into http://rt.perl.org/ and check whether the new version is in the RT
1299 fields C<Perl Version> and C<Fixed In>. The easiest way to determine this is to
1300 open up any ticket for modification and check the drop downs next to the
1301 C<Perl Version> and C<Fixed In> labels.
1302
1303 Here, try this link: L<https://rt.perl.org/Ticket/Modify.html?id=10000>
1304
1305 If the new version is not listed there, send an email to C<perlbug-admin at
1306 perl.org> requesting this.
1307
1308 =head3 Relax!
1309
1310 I<You MUST RETIRE to your preferred PUB, CAFE or SEASIDE VILLA for some
1311 much-needed rest and relaxation>.
1312
1313 Thanks for releasing perl!
1314
1315 =head2 Building a release - the day after
1316
1317 =for checklist skip BLEAD-FINAL, MAINT, RC
1318
1319 =head3 update Module::CoreList
1320
1321 I<After a BLEAD-POINT release only>
1322
1323 After Module::CoreList has shipped to CPAN by the maintainer, update
1324 Module::CoreList in the source so that it reflects the new blead
1325 version number:
1326
1327 =over 4
1328
1329 =item *
1330
1331 Update F<Porting/Maintainers.pl> to list the new DISTRIBUTION on CPAN,
1332 which should be identical to what is currently in blead.
1333
1334 =item *
1335
1336 Bump the $VERSION in F<dist/Module-CoreList/lib/Module/CoreList.pm>,
1337 F<dist/Module-CoreList/lib/Module/CoreList/TieHashDelta.pm> and
1338 F<dist/Module-CoreList/lib/Module/CoreList/Utils.pm>.
1339
1340 =item *
1341
1342 If you have a local CPAN mirror, run:
1343
1344     $ ./perl -Ilib Porting/corelist.pl ~/my-cpan-mirror
1345
1346 Otherwise, run:
1347
1348     $ ./perl -Ilib Porting/corelist.pl cpan
1349
1350 This will update F<dist/Module-CoreList/lib/Module/CoreList.pm>,
1351 F<dist/Module-CoreList/lib/Module/CoreList.pod> and
1352 F<dist/Module-CoreList/lib/Module/CoreList/Utils.pm> as it did before,
1353 but this time adding new sections for the next BLEAD-POINT release.
1354
1355 =item *
1356
1357 Add the new $Module::CoreList::VERSION to
1358 F<dist/Module-CoreList/Changes>.
1359
1360 =item *
1361
1362 Update F<pod/perldelta.pod> to mention the upgrade to Module::CoreList.
1363
1364 =item *
1365
1366 Remake perl to get your changed .pm files propagated into F<lib/> and
1367 then run at least the F<dist/Module-CoreList/t/*.t> tests and the
1368 test_porting makefile target to check that they're ok.
1369
1370 =item *
1371
1372 Run
1373
1374     $ ./perl -Ilib -MModule::CoreList -le 'print Module::CoreList->find_version($]) ? "ok" : "not ok"'
1375
1376 and check that it outputs "ok" to prove that Module::CoreList now knows
1377 about blead's current version.
1378
1379 =item *
1380
1381 Commit and push your changes.
1382
1383 =back
1384
1385 =head3 check tarball availability
1386
1387 Check various website entries to make sure the that tarball has appeared
1388 and is properly indexed:
1389
1390 =over 4
1391
1392 =item *
1393
1394 Check your author directory under L<http://www.cpan.org/authors/id/>
1395 to ensure that the tarballs are available on the website.
1396
1397 =item *
1398
1399 Check C</src> on CPAN (on a fast mirror) to ensure that links to
1400 the new tarballs have appeared: There should be links in C</src/5.0>
1401 (which is accumulating all new versions), and (for BLEAD-FINAL and
1402 MAINT only) an appropriate mention in C</src/README.html> (which describes
1403 the latest versions in each stable branch, with links).
1404
1405 The C</src/5.0> links should appear automatically, some hours after upload.
1406 If they don't, or the C</src> description is inadequate,
1407 ask Ask <ask@perl.org>.
1408
1409 =item *
1410
1411 Check L<http://www.cpan.org/src/> to ensure that the C</src> updates
1412 have been correctly mirrored to the website.
1413 If they haven't, ask Ask <ask@perl.org>.
1414
1415 =item *
1416
1417 Check L<http://search.cpan.org> to see if it has indexed the distribution.
1418 It should be visible at a URL like C<http://search.cpan.org/dist/perl-5.10.1/>.
1419
1420 =back
1421
1422 =for checklist skip RC
1423
1424 =head3 update dev.perl.org
1425
1426 I<You MUST SKIP this step for a RC release>
1427
1428 In your C<perlweb> repository, link to the new release.  For a new
1429 latest-maint release, edit F<docs/shared/tpl/stats.html>.  Otherwise,
1430 edit F<docs/dev/perl5/index.html>.
1431
1432 Then make a pull request to Leo Lapworth.  If this fails for some reason
1433 and you cannot cajole anybody else into submitting that change, you can
1434 mail Leo as last resort.
1435
1436 This repository can be found on L<github|https://github.com/perlorg/perlweb>.
1437
1438 =head3 update release manager's guide
1439
1440 Go over your notes from the release (you did take some, right?) and update
1441 F<Porting/release_managers_guide.pod> with any fixes or information that
1442 will make life easier for the next release manager.
1443
1444 =for checklist end
1445
1446 =head1 SOURCE
1447
1448 Based on
1449 http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2009-05/msg00608.html,
1450 plus a whole bunch of other sources, including private correspondence.
1451
1452 =cut
1453