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