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