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