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