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