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