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