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