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