This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
No need for empty =for checklist element
[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 =head1 SYNOPSIS
25
26 This document describes the series of tasks required - some automatic, some
27 manual - to produce a perl release of some description, be that a release
28 candidate, or final, numbered release of maint or blead.
29
30 The release process has traditionally been executed by the current
31 pumpking. Blead releases from 5.11.0 forward are made each month on the
32 20th by a non-pumpking release engineer.  The release engineer roster
33 and schedule can be found in Porting/release_schedule.pod.
34
35 This document both helps as a check-list for the release engineer 
36 and is a base for ideas on how the various tasks could be automated 
37 or distributed.
38
39 The checklist of a typical release cycle is as follows:
40
41     (5.10.1 is released, and post-release actions have been done)
42
43     ...time passes...
44
45     a few weeks before the release, a number of steps are performed,
46         including bumping the version to 5.10.2
47
48     ...a few weeks passes...
49
50     perl-5.10.2-RC1 is released
51
52     perl-5.10.2 is released
53
54     post-release actions are performed, including creating new
55         perldelta.pod
56
57     ... the cycle continues ...
58
59
60 =head1 DETAILS
61
62 Some of the tasks described below apply to all four types of
63 release of Perl. (blead, RC, final release of maint, final
64 release of blead). Some of these tasks apply only to a subset
65 of these release types.  If a step does not apply to a given 
66 type of release, you will see a notation to that effect at
67 the beginning of the step.
68
69
70 =head2 Release types
71
72 =over 4
73
74 =item Release Candidate (RC)
75
76 A release candidate is an attempt to produce a tarball that is a close as
77 possible to the final release. Indeed, unless critical faults are found
78 during the RC testing, the final release will be identical to the RC
79 barring a few minor fixups (updating the release date in F<perlhist.pod>,
80 removing the RC status from F<patchlevel.h>, etc). If faults are found,
81 then the fixes should be put into a new release candidate, never directly
82 into a final release.
83
84
85 =item Stable/Maint release (MAINT).
86
87 A release with an even version number, and subversion number > 0, such as
88 5.14.1 or 5.14.2.
89
90 At this point you should have a working release candidate with few or no
91 changes since.
92
93 It's essentially the same procedure as for making a release candidate, but
94 with a whole bunch of extra post-release steps.
95
96 =item A blead point release (BLEAD-POINT)
97
98 A release with an odd version number, such as 5.15.0 or 5.15.1.
99
100 This isn't for production, so it has less stability requirements than for
101 other release types, and isn't preceded by RC releases. Other than that,
102 it is similar to a MAINT release.
103
104 =item Blead final release (BLEAD-FINAL)
105
106 A release with an even version number, and subversion number == 0, such as
107 5.14.0. That is to say, it's the big new release once per year.
108
109 It's essentially the same procedure as for making a release candidate, but
110 with a whole bunch of extra post-release steps, even more than for MAINT.
111
112 =back
113
114 =for checklist begin
115
116 =head2 Prerequisites
117
118 Before you can make an official release of perl, there are a few
119 hoops you need to jump through:
120
121 =head3 PAUSE account
122
123 Make sure you have a PAUSE account suitable for uploading a perl release.
124 If you don't have a PAUSE account, then request one:
125
126     https://pause.perl.org/pause/query?ACTION=request_id
127
128 Check that your account is allowed to upload perl distros: go to
129 L<https://pause.perl.org/pause/authenquery?ACTION=who_pumpkin> and check that
130 your PAUSE ID is listed there.  If not, ask Andreas KE<0xf6>nig to add your ID
131 to the list of people allowed to upload something called perl.  You can find
132 Andreas' email address at:
133
134     https://pause.perl.org/pause/query?ACTION=pause_04imprint
135
136 =head3 search.cpan.org
137
138 Make sure that search.cpan.org knows that you're allowed to upload
139 perl distros. Contact Graham Barr to make sure that you're on the right
140 list.
141
142 =head3 CPAN mirror
143
144 Some release engineering steps require a full mirror of the CPAN.
145 Work to fall back to using a remote mirror via HTTP is incomplete
146 but ongoing. (No, a minicpan mirror is not sufficient)
147
148 =head3 git checkout and commit bit
149
150 You will need a working C<git> installation, checkout of the perl
151 git repository and perl commit bit.  For information about working
152 with perl and git, see F<pod/perlgit.pod>.
153
154 If you are not yet a perl committer, you won't be able to make a
155 release.  Have a chat with whichever evil perl porter tried to talk
156 you into the idea in the first place to figure out the best way to
157 resolve the issue.
158
159 =for checklist skip RC
160
161 =head3 Quotation for release announcement epigraph
162
163 I<SKIP this step for RC>
164
165 For all except an RC release of perl, you will need a quotation
166 to use as an epigraph to your release announcement.
167
168 =back
169
170 =head2 Building a release - advance actions
171
172 The work of building a release candidate for a numbered release of
173 perl generally starts several weeks before the first release candidate.
174 Some of the following steps should be done regularly, but all I<must> be
175 done in the run up to a release.
176
177
178 =head3 dual-life CPAN module synchronisation
179
180 Ensure that dual-life CPAN modules are synchronised with CPAN.  Basically,
181 run the following:
182
183     $ ./perl -Ilib Porting/core-cpan-diff -a -o /tmp/corediffs
184
185 to see any inconsistencies between the core and CPAN versions of distros,
186 then fix the core, or cajole CPAN authors as appropriate. See also the
187 C<-d> and C<-v> options for more detail.  You'll probably want to use the
188 C<-c cachedir> option to avoid repeated CPAN downloads and may want to
189 use C<-m file:///mirror/path> if you made a local CPAN mirror.
190
191 To see which core distro versions differ from the current CPAN versions:
192
193     $ ./perl -Ilib Porting/core-cpan-diff -x -a
194
195 If you are making a MAINT release, run C<core-cpan-diff> on both blead and
196 maint, then diff the two outputs. Compare this with what you expect, and if
197 necessary, fix things up. For example, you might think that both blead
198 and maint are synchronised with a particular CPAN module, but one might
199 have some extra changes. 
200
201
202 =head3 dual-life CPAN module stability
203
204 Ensure dual-life CPAN modules are stable, which comes down to:
205
206     for each module that fails its regression tests on $current
207         did it fail identically on $previous?
208         if yes, "SEP" (Somebody Else's Problem)
209         else work out why it failed (a bisect is useful for this)
210
211     attempt to group failure causes
212
213     for each failure cause
214         is that a regression?
215         if yes, figure out how to fix it
216             (more code? revert the code that broke it)
217         else
218             (presumably) it's relying on something un-or-under-documented
219             should the existing behaviour stay?
220                 yes - goto "regression"
221                 no - note it in perldelta as a significant bugfix
222                 (also, try to inform the module's author)
223
224
225 =head3 smoking
226
227 Similarly, monitor the smoking of core tests, and try to fix.  See
228 L<http://doc.procura.nl/smoke/index.html> for a summary. See also
229 L<http://www.nntp.perl.org/group/perl.daily-build.reports/> which has
230 the raw reports.
231
232 Similarly, monitor the smoking of perl for compiler warnings, and try to
233 fix.
234
235
236 =head3 perldelta
237
238 Get perldelta in a mostly finished state.
239
240 Read  F<Porting/how_to_write_a_perldelta.pod>, and try to make sure that
241 every section it lists is, if necessary, populated and complete. Copy
242 edit the whole document.
243
244
245 =head3 Bump the version number
246
247 Increase the version number (e.g. from 5.12.0 to 5.12.1).
248
249 For a BLEAD-POINT release, this can happen on the day of the release.  For a
250 release candidate for a stable perl, this should happen a week or two
251 before the first release candidate to allow sufficient time for testing and
252 smoking with the target version built into the perl executable. For
253 subsequent release candidates and the final release, it it not necessary to
254 bump the version further.
255
256 There is a tool to semi-automate this process:
257
258      $ ./perl -Ilib Porting/bump-perl-version -i 5.10.0 5.10.1
259
260 Remember that this tool is largely just grepping for '5.10.0' or whatever,
261 so it will generate false positives. Be careful not change text like
262 "this was fixed in 5.10.0"!
263
264 Use git status and git diff to select changes you want to keep.
265
266 Be particularly careful with F<INSTALL>, which contains a mixture of
267 C<5.10.0>-type strings, some of which need bumping on every release, and
268 some of which need to be left unchanged.
269 The line in F<INSTALL> about "is binary incompatible with" requires a
270 correct choice of earlier version to declare incompatibility with.
271
272 When doing a BLEAD-POINT or BLEAD-FINAL release, also make sure the
273 C<PERL_API_*> constants in F<patchlevel.h> are in sync with the version
274 you're releasing, unless you're
275 absolutely sure the release you're about to make is 100% binary compatible
276 to an earlier release. When releasing a MAINT perl version, the C<PERL_API_*>
277 constants C<MUST NOT> be changed as we aim to guarantee binary compatibility
278 in maint branches.
279
280 After editing, regenerate uconfig.h (this must be run on a system with a
281 /bin/sh available):
282
283     $ perl regen/uconfig_h.pl
284
285 Test your changes:
286
287     $ git clean -xdf   # careful if you don't have local files to keep!
288     $ ./Configure -des -Dusedevel
289     $ make
290     $ make test
291
292 Commit your changes:
293
294     $ git status
295     $ git diff
296     B<review the delta carefully>
297
298     $ git commit -a -m 'Bump the perl version in various places for 5.x.y'
299
300 At this point you may want to compare the commit with a previous bump to
301 see if they look similar.  See commit 8891dd8d for an example of a
302 previous version bump.
303
304 When the version number is bumped, you should also update Module::CoreList
305 (as described below in L<"update Module::CoreList">) to reflect the new
306 version number.
307
308
309 =head3 update INSTALL
310
311 Review and update INSTALL to account for the change in version number;
312 in particular, the "Coexistence with earlier versions of perl 5" section.
313
314 Be particularly careful with the section "Upgrading from 5.X.Y or earlier".
315 The "X.Y" needs to be changed to the most recent version that we are
316 I<not> binary compatible with.
317
318 For MAINT and BLEAD-FINAL releases, this needs to refer to the last
319 release in the previous development cycle (so for example, for a 5.14.x
320 release, this would be 5.13.11).
321
322 For BLEAD-POINT releases, it needs to refer to the previous BLEAD-POINT
323 release (so for 5.15.3 this would be 5.15.2).
324
325 =head3 Check more build configurations
326
327 Check some more build configurations. The check that setuid builds and
328 installs is for < 5.11.0 only.
329
330     $ sh Configure -Dprefix=/tmp/perl-5.x.y  -Uinstallusrbinperl \
331         -Duseshrplib -Dd_dosuid
332     $ make
333     $ LD_LIBRARY_PATH=`pwd` make test     # or similar for useshrplib
334
335     $ make suidperl
336     $ su -c 'make install'
337     $ ls -l .../bin/sperl
338     -rws--x--x 1 root root 69974 2009-08-22 21:55 .../bin/sperl
339
340 (Then delete the installation directory.)
341
342 XXX think of other configurations that need testing.
343
344
345 =head3 update perlport
346
347 L<perlport> has a section currently named I<Supported Platforms> that
348 indicates which platforms are known to build in the current release.
349 If necessary update the list and the indicated version number.
350
351
352
353 =head2 Building a release - on the day
354
355 This section describes the actions required to make a release
356 that are performed on the actual day.
357
358
359 =head3 re-check earlier actions
360
361 Review all the actions in the previous section,
362 L<"Building a release - advance actions"> to ensure they are all done and
363 up-to-date.
364
365
366 =head3 bump version number
367
368 For a BLEAD-POINT release, if you did not bump the perl version number as
369 part of I<advance actions>, do that now.
370
371
372 =head3 finalize perldelta
373
374 Finalize the perldelta.  In particular, fill in the Acknowledgements
375 section, which can be generated with something like:
376
377   $ perl Porting/acknowledgements.pl v5.15.0..HEAD
378
379 Re-read the perldelta to try to find any embarrassing typos and thinkos;
380 remove any C<TODO> or C<XXX> flags; update the "Known Problems" section
381 with any serious issues for which fixes are not going to happen now; and
382 run through pod and spell checkers, e.g.
383
384     $ podchecker -warnings -warnings pod/perldelta.pod
385     $ spell pod/perldelta.pod
386
387 Also, you may want to generate and view an HTML version of it to check
388 formatting, e.g.
389
390     $ ./perl -Ilib ext/Pod-Html/bin/pod2html pod/perldelta.pod > /tmp/perldelta.html
391
392 Another good HTML preview option is http://search.cpan.org/pod2html
393
394 If you make changes, be sure to commit them.
395
396 =for checklist skip BLEAD-POINT MAINT RC
397
398 =head3 remove stale perldeltas
399
400 For the first RC release that is ONLY for a BLEAD-FINAL, the perldeltas
401 from the BLEAD-POINT releases since the previous BLEAD_FINAL should have
402 now been consolidated into the current perldelta, and hence are now just
403 useless clutter.  They can be removed using:
404
405     $ git rm <file1> <file2> ...
406
407 For example, for RC0 of 5.16.0:
408
409     $ cd pod
410     $ git rm perldelta515*.pod
411
412 All mention to them should also be removed.  Edit F<pod/perl.pod> to remove
413 them from its table of contents, then run F<Porting/pod_rules.pl> to
414 propagate your changes there into all the other files that mention them
415 (including F<MANIFEST>). You'll need to C<git add> the files that it changes.
416
417 Then build a clean perl and do a full test
418
419     $ git status
420     $ git clean -dxf
421     $ ./Configure -Dusedevel -des
422     $ make
423     $ make test
424
425 Once all tests pass, commit your changes.
426
427 =head3 build a clean perl
428
429 If you skipped the previous step (removing the stale perldeltas)
430 make sure you have a gitwise-clean perl directory (no modified files,
431 unpushed commits etc):
432
433     $ git status
434     $ git clean -dxf
435
436 then configure and build perl so that you have a Makefile and porting tools:
437
438     $ ./Configure -Dusedevel -des && make
439
440 =head3 update Module::CoreList
441
442 Update C<Module::CoreList> with module version data for the new release.
443
444 Note that if this is a MAINT release, you should run the following actions
445 from the maint branch, but commit the C<CoreList.pm> changes in
446 I<blead> and subsequently cherry-pick any releases since the last
447 maint release and then your recent commit.  XXX need a better example
448
449 F<corelist.pl> uses ftp.funet.fi to verify information about dual-lived
450 modules on CPAN. It can use a full, local CPAN mirror or fall back
451 to C<wget> or C<curl> to fetch only package metadata remotely. (If you're
452 on Win32, then installing Cygwin is one way to have commands like C<wget>
453 and C<curl> available.)
454
455 (If you'd prefer to have a full CPAN mirror, see 
456 http://www.cpan.org/misc/cpan-faq.html#How_mirror_CPAN)
457
458 Then change to your perl checkout, and if necessary,
459
460     $ make
461
462 If this is not the first update for this version (e.g. if it was updated
463 when the version number was originally bumped), first edit
464 F<dist/Module-CoreList/lib/Module/CoreList.pm> to delete the existing
465 entries for this version from the C<%released> and C<%version> hashes:
466 they will have a key like C<5.010001> for 5.10.1.
467
468 XXX the edit-in-place functionality of Porting/corelist.pl should
469 be fixed to handle this automatically.
470
471 Then, If you have a local CPAN mirror, run:
472
473     $ ./perl -Ilib Porting/corelist.pl ~/my-cpan-mirror
474
475 Otherwise, run:
476
477     $ ./perl -Ilib Porting/corelist.pl cpan
478
479 This will chug for a while, possibly reporting various warnings about
480 badly-indexed CPAN modules unrelated to the modules actually in core.
481 Assuming all goes well, it will update
482 F<dist/Module-CoreList/lib/Module/CoreList.pm>.
483
484 Check that file over carefully:
485
486     $ git diff dist/Module-CoreList/lib/Module/CoreList.pm
487
488 =head4 Bump C<$Module::CoreList::VERSION>
489
490 If necessary, bump C<$VERSION> (there's no need to do this for
491 every RC; in RC1, bump the version to a new clean number that will
492 appear in the final release, and leave as-is for the later RCs and final).
493 It may also happen that C<Module::CoreList> has been modified in blead, and
494 hence has a new version number already.  (But make sure it is not the same
495 number as a CPAN release.)
496
497 Edit the version number in the new C<< 'Module::CoreList' => 'X.YZ' >>
498 entry, as that is likely to reflect the previous version number.
499
500 Also edit Module::CoreList's new version number in its F<Changes>
501 file.
502
503 Add a perldelta entry for the new Module::CoreList version.
504
505 =for checklist skip RC
506
507 =head4 Update C<%Module::CoreList::release> and C<CAVEATS>
508
509 In addition, if this is a final release (rather than a release candidate):
510
511 =over 4 
512
513 =item *
514
515 Update this version's entry in the C<%released> hash with today's date.
516
517 =item *
518
519 Make sure that the script has correctly updated the C<CAVEATS> section
520
521 =back
522
523 Finally, commit the new version of Module::CoreList:
524 (unless this is for MAINT; in which case commit it to blead first, then
525 cherry-pick it back).
526
527     $ git commit -m 'Update Module::CoreList for 5.x.y' dist/Module-CoreList/lib/Module/CoreList.pm
528
529 =for checklist skip RC
530
531 =head3 update perlhist.pod
532
533 I<You MUST SKIP this step for a RC release>
534
535 Add an entry to F<pod/perlhist.pod> with the release date, e.g.:
536
537     David    5.10.1       2009-Aug-06
538
539 Make sure that the correct pumpking is listed in the left-hand column, and
540 if this is the first release under the stewardship of a new pumpking, make
541 sure that his or her name is listed in the section entitled
542 C<THE KEEPERS OF THE PUMPKIN>.
543
544 Be sure to commit your changes:
545
546     $ git commit -m 'add new release to perlhist' pod/perlhist.pod
547
548 =for checklist skip BLEAD-POINT
549
550 =head3 update patchlevel.h
551
552 I<You MUST SKIP this step for a BLEAD-POINT release>
553
554 Update F<patchlevel.h> to add a C<-RC1>-or-whatever string; or, if this is
555 a final release, remove it. For example:
556
557      static const char * const local_patches[] = {
558              NULL
559     +        ,"RC1"
560              PERL_GIT_UNPUSHED_COMMITS /* do not remove this line */
561
562 Be sure to commit your change:
563
564     $ git commit -m 'bump version to RCnnn' patchlevel.h
565
566
567 =head3 build, test and check a fresh perl
568
569 Build perl, then make sure it passes its own test suite, and installs:
570
571     $ git clean -xdf
572     $ ./Configure -des -Dprefix=/tmp/perl-5.x.y-pretest
573
574     # or if it's an odd-numbered version:
575     $ ./Configure -des -Dusedevel -Dprefix=/tmp/perl-5.x.y-pretest
576
577     $ make test install
578
579 Check that the output of C</tmp/perl-5.x.y-pretest/bin/perl -v> and
580 C</tmp/perl-5.x.y-pretest/bin/perl -V> are as expected,
581 especially as regards version numbers, patch and/or RC levels, and @INC
582 paths. Note that as they have been been built from a git working
583 directory, they will still identify themselves using git tags and
584 commits.
585
586 Then delete the temporary installation.
587
588
589 =head3 push the work so far
590
591 Push all your recent commits:
592
593     $ git push origin ....
594
595
596 =head3 tag the release
597
598 Tag the release (e.g.):
599
600     $ git tag v5.11.0 -m "First release of the v5.11 series!"
601
602 It is B<VERY> important that from this point forward, you not push
603 your git changes to the Perl master repository.  If anything goes
604 wrong before you publish your newly-created tag, you can delete
605 and recreate it.  Once you push your tag, we're stuck with it
606 and you'll need to use a new version number for your release.
607
608
609 =head3 build the tarball
610
611 Before you run the following, you might want to install 7-Zip (the
612 C<p7zip-full> package under Debian or the C<p7zip> port on MacPorts) or
613 the AdvanceCOMP suite (e.g. the C<advancecomp> package under Debian,
614 or the C<advancecomp> port on macports - 7-Zip on Windows is the
615 same code as AdvanceCOMP, so Windows users get the smallest files
616 first time). These compress about 5% smaller than gzip and bzip2.
617 Over the lifetime of your distribution this will save a lot of
618 people a small amount of download time and disk space, which adds
619 up.
620
621 Create a tarball. Use the C<-s> option to specify a suitable suffix for
622 the tarball and directory name:
623
624     $ cd root/of/perl/tree
625     $ make distclean
626     $ git clean -xdf            # make sure perl and git agree on files
627     $ git status                # and there's nothing lying around
628
629     $ perl Porting/makerel -b -s RC1            # for a release candidate
630     $ perl Porting/makerel -b                   # for a final release
631
632 This creates the  directory F<../perl-x.y.z-RC1> or similar, copies all
633 the MANIFEST files into it, sets the correct permissions on them,
634 adds DOS line endings to some, then tars it up as
635 F<../perl-x.y.z-RC1.tar.gz>. With C<-b>, it also creates a C<tar.bz2> file.
636
637 If you're getting your tarball suffixed with -uncommitted and you're sure
638 your changes were all committed, you can override the suffix with:
639
640     $ perl Porting/makerel -b -s ''
641
642 XXX if we go for extra tags and branches stuff, then add the extra details
643 here
644
645 Finally, clean up the temporary directory, e.g.
646
647     $ rm -rf ../perl-x.y.z-RC1
648
649
650 =head3 test the tarball
651
652 =over 4
653
654 =item *
655
656 Copy the tarballs (.gz and possibly .bz2) to a web server somewhere you
657 have access to.
658
659 =item *
660
661 Download the tarball to some other machine. For a release candidate, 
662 you really want to test your tarball on two or more different platforms
663 and architectures. The #p5p IRC channel on irc.perl.org is a good place
664 to find willing victims.
665
666 =item *
667
668 Check that basic configuration and tests work on each test machine:
669
670     $ ./Configure -des && make all test
671
672 =item *
673
674 Check that the test harness and install work on each test machine:
675
676     $ make distclean
677     $ ./Configure -des -Dprefix=/install/path && make all test_harness install
678     $ cd /install/path
679
680 =item *
681
682 Check that the output of C<perl -v> and C<perl -V> are as expected,
683 especially as regards version numbers, patch and/or RC levels, and @INC
684 paths. 
685
686 Note that the results may be different without a F<.git/> directory,
687 which is why you should test from the tarball.
688
689 =item *
690
691 Run the Installation Verification Procedure utility:
692
693     $ ./perl utils/perlivp
694     ...
695     All tests successful.
696     $
697
698 =item *
699
700 Compare the pathnames of all installed files with those of the previous
701 release (i.e. against the last installed tarball on this branch which you
702 have previously verified using this same procedure). In particular, look
703 for files in the wrong place, or files no longer included which should be.
704 For example, suppose the about-to-be-released version is 5.10.1 and the
705 previous is 5.10.0:
706
707     cd installdir-5.10.0/
708     find . -type f | perl -pe's/5\.10\.0/5.10.1/g' | sort > /tmp/f1
709     cd installdir-5.10.1/
710     find . -type f | sort > /tmp/f2
711     diff -u /tmp/f[12]
712
713 =item *
714
715 Bootstrap the CPAN client on the clean install:
716
717     $ bin/perl -MCPAN -e "shell"
718
719 If you're running this on Win32 you probably also need a set of Unix
720 command-line tools available for CPAN to function correctly without
721 Perl alternatives like LWP installed. Cygwin is an obvious choice.)
722
723 =item *
724
725 Try installing a popular CPAN module that's reasonably complex and that
726 has dependencies; for example:
727
728     CPAN> install Inline
729     CPAN> quit
730
731 Check that your perl can run this:
732
733     $ bin/perl -lwe "use Inline C => q[int f() { return 42;}]; print f"
734     42
735     $
736
737 =item *
738
739 Bootstrap the CPANPLUS client on the clean install:
740
741     $ bin/cpanp
742
743 (Again, on Win32 you'll need something like Cygwin installed, but make sure
744 that you don't end up with its various F<bin/cpan*> programs being found on
745 the PATH before those of the Perl that you're trying to test.)
746
747 =item *
748
749 Install an XS module, for example:
750
751     CPAN Terminal> i DBI
752     CPAN Terminal> quit
753     $ bin/perl -MDBI -e 1
754     $
755
756 =item *
757
758 Check that the L<perlbug> utility works. Try the following:
759
760     $ bin/perlbug
761     ...
762     Subject: test bug report
763     Local perl administrator [yourself]: 
764     Editor [vi]: 
765     Module: 
766     Category [core]: 
767     Severity [low]: 
768     (edit report)
769     Action (Send/Display/Edit/Subject/Save to File): f
770     Name of file to save message in [perlbug.rep]: 
771     Action (Send/Display/Edit/Subject/Save to File): q
772
773 and carefully examine the output (in F<perlbug.rep]>), especially
774 the "Locally applied patches" section. If everything appears okay, then
775 delete the file, and try it again, this time actually submitting the bug
776 report. Check that it shows up, then remember to close it!
777
778 =back
779
780 =for checklist skip BLEAD-POINT
781
782 =head3 monitor smokes
783
784 Wait for the smoke tests to catch up with the commit which this release is
785 based on (or at least the last commit of any consequence).
786
787 Then check that the smoke tests pass (particularly on Win32). If not, go
788 back and fix things.
789
790 Note that for I<BLEAD-POINT> releases this may not be practical. It takes a
791 long time for the smokers to catch up, especially the Win32
792 smokers. This is why we have a RC cycle for I<MAINT> and I<BLEAD-FINAL>
793 releases, but for I<BLEAD-POINT> releases sometimes the best you can do is
794 to plead with people on IRC to test stuff on their platforms, fire away,
795 and then hope for the best.
796
797
798 =head3 upload to PAUSE
799
800 Once smoking is okay, upload it to PAUSE. This is the point of no return.
801 If anything goes wrong after this point, you will need to re-prepare
802 a new release with a new minor version or RC number.
803
804     https://pause.perl.org/
805
806 (Login, then select 'Upload a file to CPAN')
807
808 If your workstation is not connected to a high-bandwidth,
809 high-reliability connection to the Internet, you should probably use the
810 "GET URL" feature (rather than "HTTP UPLOAD") to have PAUSE retrieve the
811 new release from wherever you put it for testers to find it.  This will
812 eliminate anxious gnashing of teeth while you wait to see if your
813 15 megabyte HTTP upload successfully completes across your slow, twitchy
814 cable modem.  You can make use of your home directory on dromedary for
815 this purpose: F<http://users.perl5.git.perl.org/~USERNAME> maps to
816 F</home/USERNAME/public_html>, where F<USERNAME> is your login account
817 on dromedary.  I<Remember>: if your upload is partially successful, you
818 may need to contact a PAUSE administrator or even bump the version of perl.
819
820 Upload both the .gz and .bz2 versions of the tarball.
821
822 Do not proceed any further until you are sure that your tarballs are on
823 CPAN.  Check your authors directory on one of the "fast" CPAN mirrors
824 (e.g., cpan.hexten.net
825 or cpan.cpantesters.org) to confirm that your uploads have been successful.
826
827 I<You MUST SKIP this step for RC>
828
829 Wait until you receive notification emails from the PAUSE indexer
830 confirming that your uploads have been received.  IMPORTANT -- you will
831 probably get an email that indexing has failed, due to module permissions.
832 This is considered normal.
833
834
835 =head3 publish tag
836
837 Now that you've shipped the new perl release to PAUSE, it's
838 time to publish the tag you created earlier to the public git repo (e.g.):
839
840     $ git push origin tag v5.11.0
841
842 =for checklist skip BLEAD-POINT
843
844 =head3 disarm patchlevel.h
845
846 I<You MUST SKIP this step for BLEAD-POINT release>
847
848 Disarm the F<patchlevel.h> change; for example,
849
850      static const char * const local_patches[] = {
851              NULL
852     -        ,"RC1"
853              PERL_GIT_UNPUSHED_COMMITS /* do not remove this line */
854
855 Be sure to commit your change:
856
857     $ git commit -m 'disarm RCnnn bump' patchlevel.h
858     $ git push origin ....
859
860
861
862 =head3 announce to p5p
863
864 Mail p5p to announce your new release, with a quote you prepared earlier.
865
866 Use the template at Porting/release_announcement_template.txt
867
868 =head3 update epigraphs.pod
869
870 Add your quote to F<Porting/epigraphs.pod> and commit it.
871 Your release announcement will probably not have reached the web-visible
872 archives yet, so you won't be able to include the customary link to the
873 release announcement yet.
874
875 =head3 blog about your epigraph
876
877 If you have a blog, please consider writing an entry in your blog explaining
878 why you chose that particular quote for your epigraph.
879
880 =for checklist skip RC
881
882 =head3 Module::CoreList nagging
883
884 I<You MUST SKIP this step for RC>
885
886 Remind the current maintainer of C<Module::CoreList> to push a new release
887 to CPAN.
888
889 =for checklist skip RC
890
891 =head3 new perldelta
892
893 I<You MUST SKIP this step for RC>
894
895 Create a new perldelta.
896
897 =over 4
898
899 =item *
900
901 Confirm that you have a clean checkout with no local changes.
902
903 =item *
904
905 Run F<Porting/new-perldelta.pl>
906
907 =item *
908
909 Run the C<git add> commands it outputs to add new and modified files.
910
911 =item *
912
913 Verify that the build still works, by running C<./Configure> and
914 C<make test_porting>. (On Win32, run C<nmake> and
915 C<nmake test TEST_FILES="porting\*.t ..\lib\diagnostics.t">.)
916
917 =item *
918
919 If F<t/porting/podcheck.t> spots errors in the new F<pod/perldelta.pod>,
920 run C<./perl -MTestInit t/porting/podcheck.t | less> for more detail.
921 Skip to the end of its test output to see the options it offers you.
922
923 =item *
924
925 When C<make test_porting> passes, commit the new perldelta.
926
927 =back
928
929 At this point you may want to compare the commit with a previous bump to
930 see if they look similar.  See commit e3c71926d3 for an example of a
931 previous version bump.
932
933 =for checklist skip BLEAD-POINT MAINT RC
934
935 =head3 bump version
936
937 I<You MUST SKIP this step for RC, BLEAD-POINT, MAINT>
938
939 If this was a BLEAD-FINAL release (i.e. the first release of a new maint
940 series, 5.x.0 where x is even), then bump the version in the blead branch
941 in git, e.g. 5.12.0 to 5.13.0.
942
943 First, add a new feature bundle to F<lib/feature.pm>, initially by just
944 copying the exiting entry, and bump the file's $VERSION; e.g.
945
946          "5.14" => [qw(switch say state unicode_strings)],
947     +    "5.15" => [qw(switch say state unicode_strings)],
948
949 Then follow the section L<"Bump the version number"> to bump the version
950 in the remaining files and test and commit.
951
952
953 =head3 clean build and test
954
955 Run a clean build and test to make sure nothing obvious is broken.
956
957 In particular, F<Porting/perldelta_template.pod> is intentionally exempted
958 from podchecker tests, to avoid false positives about placeholder text.
959 However, once it's copied to F<pod/perldelta.pod> the contents can now
960 cause test failures. Problems should resolved by doing one of the
961 following:
962
963 =over
964
965 =item 1
966
967 Replace placeholder text with correct text.
968
969 =item 2
970
971 If the problem is from a broken placeholder link, you can add it to the
972 array C<@perldelta_ignore_links> in F<t/porting/podcheck.t>.  Lines
973 containing such links should be marked with C<XXX> so that they get
974 cleaned up before the next release.
975
976 =item 3
977
978 Following the instructions output by F<t/porting/podcheck.t> on how to
979 update its exceptions database.
980
981 =back
982
983 =head3 push commits
984
985 Finally, push any commits done above.
986
987     $ git push origin ....
988
989 =for checklist skip BLEAD-POINT MAINT RC
990
991 =head3 create maint branch
992
993 I<You MUST SKIP this step for RC, BLEAD-POINT, MAINT>
994
995 If this was a BLEAD-FINAL release (i.e. the first release of a new maint
996 series, 5.x.0 where x is even), then create a new maint branch based on
997 the commit tagged as the current release.
998
999 Assuming you're using git 1.7.x or newer:
1000
1001     $ git checkout -b maint-5.12 v5.12.0
1002     $ git push origin -u maint-5.12
1003
1004
1005 =for checklist skip BLEAD-POINT MAINT RC
1006
1007 =head3 make the maint branch available in the APC
1008
1009 Clone the new branch into /srv/gitcommon/branches on camel so the APC will
1010 receive its changes.
1011
1012     $ git clone --branch maint-5.14 /gitroot/perl.git \
1013     ?  /srv/gitcommon/branches/perl-5.14.x
1014     $ chmod -R g=u /srv/gitcommon/branches/perl-5.14.x
1015
1016 And nag the sysadmins to make this directory available via rsync.
1017
1018 =for checklist skip BLEAD-POINT RC
1019
1020 =head3 copy perldelta.pod to other branches
1021
1022 I<You MUST SKIP this step for RC, BLEAD-POINT>
1023
1024 Copy the perldelta.pod for this release into the other branches; for
1025 example:
1026
1027     $ cp -i ../5.10.x/pod/perldelta.pod pod/perl5101delta.pod    # for example
1028     $ git add pod/perl5101delta.pod
1029
1030 Edit F<pod/perl.pod> to add an entry for the file, e.g.:
1031
1032     perl5101delta               Perl changes in version 5.10.1
1033
1034 Then rebuild various files:
1035
1036     $ perl pod/buildtoc --build-all
1037
1038 Finally, commit:
1039
1040     $ git commit -a -m 'add perlXXXdelta'
1041
1042
1043 =head3 update perlhist.pod in other branches
1044
1045 Make sure any recent F<pod/perlhist.pod> entries are copied to
1046 F<perlhist.pod> on other branches
1047 e.g.
1048
1049           5.8.9         2008-Dec-14
1050
1051
1052 =head3 bump RT version number
1053
1054 Log into http://rt.perl.org/ and check whether the new version is in the RT
1055 fields C<Perl Version> and C<Fixed In>. The easiest way to determine this is
1056 to go to L<https://rt.perl.org/rt3/Search/Build.html> and click on the drop
1057 downs next to the C<Perl Version> and C<Fixed In> labels.
1058
1059 If the new version is not listed there, send an email to C<perlbug-admin at
1060 perl.org> requesting this.
1061
1062 =head3 Relax!
1063
1064 I<You MUST RETIRE to your preferred PUB, CAFE or SEASIDE VILLA for some
1065 much-needed rest and relaxation>.
1066
1067 Thanks for releasing perl!
1068
1069
1070 =head2 Building a release - the day after
1071
1072 =head3 link announcement in epigraphs.pod
1073
1074 Add, to your quote to F<Porting/epigraphs.pod>, a link to the release
1075 announcement in the web-visible mailing list archive.  Commit it.
1076
1077 =head3 check tarball availability
1078
1079 Check various website entries to make sure the that tarball has appeared
1080 and is properly indexed:
1081
1082 =over 4
1083
1084 =item *
1085
1086 Check your author directory under L<http://www.cpan.org/authors/id/>
1087 to ensure that the tarballs are available on the website.
1088
1089 =item *
1090
1091 Check C</src> on CPAN (on a fast mirror) to ensure that links to
1092 the new tarballs have appeared.  There should be links in C</src/5.0>
1093 (which is accumulating all new versions), links in C</src> (which shows
1094 only the latest version on each branch), and an appropriate mention in
1095 C</src/README.html> (which describes the latest versions).
1096
1097 These links should appear automatically, some hours after upload.
1098 If they don't, or the C<README.html> description is inadequate,
1099 ask Ask <ask@perl.org>.
1100
1101 =item *
1102
1103 Check L<http://www.cpan.org/src/> to ensure that the C</src> updates
1104 have been correctly mirrored to the website.
1105 If they haven't, ask Ask <ask@perl.org>.
1106
1107 =item *
1108
1109 Check L<http://search.cpan.org> to see if it has indexed the distribution.
1110 It should be visible at a URL like C<http://search.cpan.org/dist/perl-5.10.1/>.
1111
1112 =back
1113
1114
1115 =head3 update dev.perl.org
1116
1117 I<This step ONLY for BLEAD-FINAL and MAINT>
1118
1119 Ask Leo Lapworth to update L<http://dev.perl.org/perl5/>.
1120
1121 =for checklist end
1122
1123 =head1 SOURCE
1124
1125 Based on
1126 http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2009-05/msg00608.html,
1127 plus a whole bunch of other sources, including private correspondence.
1128
1129 =cut
1130