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