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