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