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