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