This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Eliminate a couple more suidperl and sperl references.
[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 =head1 MAKING A CHECKLIST
11
12 If you are preparing to do a release, you can run the
13 F<Porting/make-rmg-checklist> script to generate a new version of this
14 document that starts with a checklist for your release.
15
16 This script is run as:
17
18   perl Porting/make-rmg-checklist \
19       --type [BLEAD-POINT or MAINT or ...] > /tmp/rmg.pod
20
21 You can also pass the C<--html> flag to generate an HTML document instead of
22 POD.
23
24   perl Porting/make-rmg-checklist --html \
25       --type [BLEAD-POINT or MAINT or ...] > /tmp/rmg.html
26
27 =head1 SYNOPSIS
28
29 This document describes the series of tasks required - some automatic, some
30 manual - to produce a perl release of some description, be that a release
31 candidate, or final, numbered release of maint or blead.
32
33 The release process has traditionally been executed by the current
34 pumpking. Blead releases from 5.11.0 forward are made each month on the
35 20th by a non-pumpking release engineer.  The release engineer roster
36 and schedule can be found in Porting/release_schedule.pod.
37
38 This document both helps as a check-list for the release engineer 
39 and is a base for ideas on how the various tasks could be automated 
40 or distributed.
41
42 The checklist of a typical release cycle is as follows:
43
44     (5.10.1 is released, and post-release actions have been done)
45
46     ...time passes...
47
48     a few weeks before the release, a number of steps are performed,
49         including bumping the version to 5.10.2
50
51     ...a few weeks passes...
52
53     perl-5.10.2-RC1 is released
54
55     perl-5.10.2 is released
56
57     post-release actions are performed, including creating new
58         perldelta.pod
59
60     ... the cycle continues ...
61
62
63 =head1 DETAILS
64
65 Some of the tasks described below apply to all four types of
66 release of Perl. (blead, RC, final release of maint, final
67 release of blead). Some of these tasks apply only to a subset
68 of these release types.  If a step does not apply to a given 
69 type of release, you will see a notation to that effect at
70 the beginning of the step.
71
72
73 =head2 Release types
74
75 =over 4
76
77 =item Release Candidate (RC)
78
79 A release candidate is an attempt to produce a tarball that is a close as
80 possible to the final release. Indeed, unless critical faults are found
81 during the RC testing, the final release will be identical to the RC
82 barring a few minor fixups (updating the release date in F<perlhist.pod>,
83 removing the RC status from F<patchlevel.h>, etc). If faults are found,
84 then the fixes should be put into a new release candidate, never directly
85 into a final release.
86
87
88 =item Stable/Maint release (MAINT).
89
90 A release with an even version number, and subversion number > 0, such as
91 5.14.1 or 5.14.2.
92
93 At this point you should have a working release candidate with few or no
94 changes since.
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.
98
99 =item A blead point release (BLEAD-POINT)
100
101 A release with an odd version number, such as 5.15.0 or 5.15.1.
102
103 This isn't for production, so it has less stability requirements than for
104 other release types, and isn't preceded by RC releases. Other than that,
105 it is similar to a MAINT release.
106
107 =item Blead final release (BLEAD-FINAL)
108
109 A release with an even version number, and subversion number == 0, such as
110 5.14.0. That is to say, it's the big new release once per year.
111
112 It's essentially the same procedure as for making a release candidate, but
113 with a whole bunch of extra post-release steps, even more than for MAINT.
114
115 =back
116
117 =for checklist begin
118
119 =head2 Prerequisites
120
121 Before you can make an official release of perl, there are a few
122 hoops you need to jump through:
123
124 =head3 PAUSE account with pumpkin status
125
126 Make sure you have a PAUSE account suitable for uploading a perl release.
127 If you don't have a PAUSE account, then request one:
128
129     https://pause.perl.org/pause/query?ACTION=request_id
130
131 Check that your account is allowed to upload perl distros: go to
132 L<https://pause.perl.org/pause/authenquery?ACTION=who_pumpkin> and check that
133 your PAUSE ID is listed there.  If not, ask Andreas KE<0xf6>nig to add your ID
134 to the list of people allowed to upload something called perl.  You can find
135 Andreas' email address at:
136
137     https://pause.perl.org/pause/query?ACTION=pause_04imprint
138
139 =head3 search.cpan.org pumpkin status
140
141 Make sure that search.cpan.org knows that you're allowed to upload
142 perl distros. Contact Graham Barr to make sure that you're on the right
143 list.
144
145 =head3 git checkout and commit bit
146
147 You will need a working C<git> installation, checkout of the perl
148 git repository and perl commit bit.  For information about working
149 with perl and git, see F<pod/perlgit.pod>.
150
151 If you are not yet a perl committer, you won't be able to make a
152 release.  Have a chat with whichever evil perl porter tried to talk
153 you into the idea in the first place to figure out the best way to
154 resolve the issue.
155
156 =for checklist skip RC
157
158 =head3 Quotation for release announcement epigraph
159
160 I<SKIP this step for RC>
161
162 For all except an RC release of perl, you will need a quotation
163 to use as an epigraph to your release announcement.
164
165 =head2 Building a release - advance actions
166
167 The work of building a release candidate for a numbered release of
168 perl generally starts several weeks before the first release candidate.
169 Some of the following steps should be done regularly, but all I<must> be
170 done in the run up to a release.
171
172
173 =head3 dual-life CPAN module synchronisation
174
175 Ensure that dual-life CPAN modules are synchronised with CPAN.  Basically,
176 run the following:
177
178     $ ./perl -Ilib Porting/core-cpan-diff -a -o /tmp/corediffs
179
180 to see any inconsistencies between the core and CPAN versions of distros,
181 then fix the core, or cajole CPAN authors as appropriate. See also the
182 C<-d> and C<-v> options for more detail.  You'll probably want to use the
183 C<-c cachedir> option to avoid repeated CPAN downloads and may want to
184 use C<-m file:///mirror/path> if you made a local CPAN mirror.
185
186 To see which core distro versions differ from the current CPAN versions:
187
188     $ ./perl -Ilib Porting/core-cpan-diff -x -a
189
190 If you are making a MAINT release, run C<core-cpan-diff> on both blead and
191 maint, then diff the two outputs. Compare this with what you expect, and if
192 necessary, fix things up. For example, you might think that both blead
193 and maint are synchronised with a particular CPAN module, but one might
194 have some extra changes. 
195
196
197 =head3 dual-life CPAN module stability
198
199 Ensure dual-life CPAN modules are stable, which comes down to:
200
201     for each module that fails its regression tests on $current
202         did it fail identically on $previous?
203         if yes, "SEP" (Somebody Else's Problem)
204         else work out why it failed (a bisect is useful for this)
205
206     attempt to group failure causes
207
208     for each failure cause
209         is that a regression?
210         if yes, figure out how to fix it
211             (more code? revert the code that broke it)
212         else
213             (presumably) it's relying on something un-or-under-documented
214             should the existing behaviour stay?
215                 yes - goto "regression"
216                 no - note it in perldelta as a significant bugfix
217                 (also, try to inform the module's author)
218
219
220 =head3 monitor smoke tests for failures
221
222 Similarly, monitor the smoking of core tests, and try to fix.  See
223 L<http://doc.procura.nl/smoke/index.html> for a summary. See also
224 L<http://www.nntp.perl.org/group/perl.daily-build.reports/> which has
225 the raw reports.
226
227 Similarly, monitor the smoking of perl for compiler warnings, and try to
228 fix.
229
230
231 =head3 update perldelta
232
233 Get perldelta in a mostly finished state.
234
235 Read  F<Porting/how_to_write_a_perldelta.pod>, and try to make sure that
236 every section it lists is, if necessary, populated and complete. Copy
237 edit the whole document.
238
239
240 =head3 Bump the version number
241
242 Increase the version number (e.g. from 5.12.0 to 5.12.1).
243
244 For a BLEAD-POINT release, this can happen on the day of the release.  For a
245 release candidate for a stable perl, this should happen a week or two
246 before the first release candidate to allow sufficient time for testing and
247 smoking with the target version built into the perl executable. For
248 subsequent release candidates and the final release, it it not necessary to
249 bump the version further.
250
251 There is a tool to semi-automate this process:
252
253      $ ./perl -Ilib Porting/bump-perl-version -i 5.10.0 5.10.1
254
255 Remember that this tool is largely just grepping for '5.10.0' or whatever,
256 so it will generate false positives. Be careful not change text like
257 "this was fixed in 5.10.0"!
258
259 Use git status and git diff to select changes you want to keep.
260
261 Be particularly careful with F<INSTALL>, which contains a mixture of
262 C<5.10.0>-type strings, some of which need bumping on every release, and
263 some of which need to be left unchanged.
264 The line in F<INSTALL> about "is binary incompatible with" requires a
265 correct choice of earlier version to declare incompatibility with.
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 status
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.
323
324     $ sh Configure -Dprefix=/tmp/perl-5.x.y  -Uinstallusrbinperl \
325         -Duseshrplib -Dusesitecustomize
326     $ make
327     $ make test
328
329 XXX think of other configurations that need testing.
330
331
332 =head3 update perlport
333
334 L<perlport> has a section currently named I<Supported Platforms> that
335 indicates which platforms are known to build in the current release.
336 If necessary update the list and the indicated version number.
337
338
339
340 =head2 Building a release - on the day
341
342 This section describes the actions required to make a release
343 that are performed on the actual day.
344
345
346 =head3 re-check earlier actions
347
348 Review all the actions in the previous section,
349 L<"Building a release - advance actions"> to ensure they are all done and
350 up-to-date.
351
352
353 =head3 bump version number
354
355 For a BLEAD-POINT release, if you did not bump the perl version number as
356 part of I<advance actions>, do that now.
357
358
359 =head3 finalize perldelta
360
361 Finalize the perldelta.  In particular, fill in the Acknowledgements
362 section, which can be generated with something like:
363
364   $ perl Porting/acknowledgements.pl v5.15.0..HEAD
365
366 Re-read the perldelta to try to find any embarrassing typos and thinkos;
367 remove any C<TODO> or C<XXX> flags; update the "Known Problems" section
368 with any serious issues for which fixes are not going to happen now; and
369 run through pod and spell checkers, e.g.
370
371     $ podchecker -warnings -warnings pod/perldelta.pod
372     $ spell pod/perldelta.pod
373
374 Also, you may want to generate and view an HTML version of it to check
375 formatting, e.g.
376
377     $ ./perl -Ilib ext/Pod-Html/bin/pod2html pod/perldelta.pod > /tmp/perldelta.html
378
379 Another good HTML preview option is http://search.cpan.org/pod2html
380
381 If you make changes, be sure to commit them.
382
383 =for checklist skip BLEAD-POINT MAINT RC
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.  Edit F<pod/perl.pod> to remove
400 them from its table of contents, then run F<Porting/pod_rules.pl> to
401 propagate your changes there into all the other files that mention them
402 (including F<MANIFEST>). You'll need to C<git add> the files that it changes.
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 =head4 Bump C<$Module::CoreList::VERSION>
476
477 If necessary, bump C<$Module::CoreList::VERSION> (there's no need to do this for
478 every RC; in RC1, bump the version to a new clean number that will
479 appear in the final release, and leave as-is for the later RCs and final).
480 It may also happen that C<Module::CoreList> has been modified in blead, and
481 hence has a new version number already.  (But make sure it is not the same
482 number as a CPAN release.)
483
484 Edit the version number in the new C<< 'Module::CoreList' => 'X.YZ' >>
485 entry, as that is likely to reflect the previous version number.
486
487 =head4 Bump version in Module::CoreList F<Changes>
488
489 Also edit Module::CoreList's new version number in its F<Changes>
490 file.
491
492 =head4 Add Module::CoreList version bump to perldelta
493
494 Add a perldelta entry for the new Module::CoreList version.
495
496 =for checklist skip RC
497
498 =head4 Update C<%Module::CoreList::release> and C<CAVEATS>
499
500 In addition, if this is a final release (rather than a release candidate):
501
502 =over 4 
503
504 =item *
505
506 Update this version's entry in the C<%released> hash with today's date.
507
508 =item *
509
510 Make sure that the script has correctly updated the C<CAVEATS> section
511
512 =back
513
514 =head4 Commit Module::CoreList changes
515
516 Finally, commit the new version of Module::CoreList:
517 (unless this is for MAINT; in which case commit it to blead first, then
518 cherry-pick it back).
519
520     $ git commit -m 'Update Module::CoreList for 5.x.y' dist/Module-CoreList/lib/Module/CoreList.pm
521
522 =for checklist skip RC
523
524 =head3 update perlhist.pod
525
526 I<You MUST SKIP this step for a RC release>
527
528 Add an entry to F<pod/perlhist.pod> with the release date, e.g.:
529
530     David    5.10.1       2009-Aug-06
531
532 Make sure that the correct pumpking is listed in the left-hand column, and
533 if this is the first release under the stewardship of a new pumpking, make
534 sure that his or her name is listed in the section entitled
535 C<THE KEEPERS OF THE PUMPKIN>.
536
537 Be sure to commit your changes:
538
539     $ git commit -m 'add new release to perlhist' pod/perlhist.pod
540
541 =for checklist skip BLEAD-POINT
542
543 =head3 update patchlevel.h
544
545 I<You MUST SKIP this step for a BLEAD-POINT release>
546
547 Update F<patchlevel.h> to add a C<-RC1>-or-whatever string; or, if this is
548 a final release, remove it. For example:
549
550      static const char * const local_patches[] = {
551              NULL
552     +        ,"RC1"
553              PERL_GIT_UNPUSHED_COMMITS /* do not remove this line */
554
555 Be sure to commit your change:
556
557     $ git commit -m 'bump version to RCnnn' patchlevel.h
558
559
560 =head3 build, test and check a fresh perl
561
562 Build perl, then make sure it passes its own test suite, and installs:
563
564     $ git clean -xdf
565     $ ./Configure -des -Dprefix=/tmp/perl-5.x.y-pretest
566
567     # or if it's an odd-numbered version:
568     $ ./Configure -des -Dusedevel -Dprefix=/tmp/perl-5.x.y-pretest
569
570     $ make test install
571
572 Check that the output of C</tmp/perl-5.x.y-pretest/bin/perl -v> and
573 C</tmp/perl-5.x.y-pretest/bin/perl -V> are as expected,
574 especially as regards version numbers, patch and/or RC levels, and @INC
575 paths. Note that as they have been been built from a git working
576 directory, they will still identify themselves using git tags and
577 commits.
578
579 Then delete the temporary installation.
580
581
582 =head3 push the work so far
583
584 Push all your recent commits:
585
586     $ git push origin ....
587
588
589 =head3 tag the release
590
591 Tag the release (e.g.):
592
593     $ git tag v5.11.0 -m "First release of the v5.11 series!"
594
595 It is B<VERY> important that from this point forward, you not push
596 your git changes to the Perl master repository.  If anything goes
597 wrong before you publish your newly-created tag, you can delete
598 and recreate it.  Once you push your tag, we're stuck with it
599 and you'll need to use a new version number for your release.
600
601
602 =head3 build the tarball
603
604 Before you run the following, you might want to install 7-Zip (the
605 C<p7zip-full> package under Debian or the C<p7zip> port on MacPorts) or
606 the AdvanceCOMP suite (e.g. the C<advancecomp> package under Debian,
607 or the C<advancecomp> port on macports - 7-Zip on Windows is the
608 same code as AdvanceCOMP, so Windows users get the smallest files
609 first time). These compress about 5% smaller than gzip and bzip2.
610 Over the lifetime of your distribution this will save a lot of
611 people a small amount of download time and disk space, which adds
612 up.
613
614 Create a tarball. Use the C<-s> option to specify a suitable suffix for
615 the tarball and directory name:
616
617     $ cd root/of/perl/tree
618     $ make distclean
619     $ git clean -xdf            # make sure perl and git agree on files
620     $ git status                # and there's nothing lying around
621
622     $ perl Porting/makerel -b -s RC1            # for a release candidate
623     $ perl Porting/makerel -b                   # for a final release
624
625 This creates the  directory F<../perl-x.y.z-RC1> or similar, copies all
626 the MANIFEST files into it, sets the correct permissions on them,
627 adds DOS line endings to some, then tars it up as
628 F<../perl-x.y.z-RC1.tar.gz>. With C<-b>, it also creates a C<tar.bz2> file.
629
630 If you're getting your tarball suffixed with -uncommitted and you're sure
631 your changes were all committed, you can override the suffix with:
632
633     $ perl Porting/makerel -b -s ''
634
635 XXX if we go for extra tags and branches stuff, then add the extra details
636 here
637
638 Finally, clean up the temporary directory, e.g.
639
640     $ rm -rf ../perl-x.y.z-RC1
641
642
643 =head3 test the tarball
644
645 Once you have a tarball it's time to test the tarball (not the repository).
646
647 =head4 Copy the tarball to a web server
648
649 Copy the tarballs (.gz and possibly .bz2) to a web server somewhere you
650 have access to.
651
652 =head4 Download the tarball to another machine
653
654 Download the tarball to some other machine. For a release candidate, 
655 you really want to test your tarball on two or more different platforms
656 and architectures. The #p5p IRC channel on irc.perl.org is a good place
657 to find willing victims.
658
659 =head4 Check that F<Configure> works
660
661 Check that basic configuration and tests work on each test machine:
662
663     $ ./Configure -des && make all test
664
665 =head4 Run the test harness and install
666
667 Check that the test harness and install work on each test machine:
668
669     $ make distclean
670     $ ./Configure -des -Dprefix=/install/path && make all test_harness install
671     $ cd /install/path
672
673 =head4 Check C<perl -v> and C<perl -V>
674
675 Check that the output of C<perl -v> and C<perl -V> are as expected,
676 especially as regards version numbers, patch and/or RC levels, and @INC
677 paths. 
678
679 Note that the results may be different without a F<.git/> directory,
680 which is why you should test from the tarball.
681
682 =head4 Run the Installation Verification Procedure utility
683
684     $ ./perl utils/perlivp
685     ...
686     All tests successful.
687     $
688
689 =head4 Compare the installed paths to the last release
690
691 Compare the pathnames of all installed files with those of the previous
692 release (i.e. against the last installed tarball on this branch which you
693 have previously verified using this same procedure). In particular, look
694 for files in the wrong place, or files no longer included which should be.
695 For example, suppose the about-to-be-released version is 5.10.1 and the
696 previous is 5.10.0:
697
698     cd installdir-5.10.0/
699     find . -type f | perl -pe's/5\.10\.0/5.10.1/g' | sort > /tmp/f1
700     cd installdir-5.10.1/
701     find . -type f | sort > /tmp/f2
702     diff -u /tmp/f[12]
703
704 =head4 Test the CPAN client
705
706 Bootstrap the CPAN client on the clean install:
707
708     $ bin/perl -MCPAN -e "shell"
709
710 If you're running this on Win32 you probably also need a set of Unix
711 command-line tools available for CPAN to function correctly without
712 Perl alternatives like LWP installed. Cygwin is an obvious choice.)
713
714 =head4 Install the Inline module and test it
715
716 Try installing a popular CPAN module that's reasonably complex and that
717 has dependencies; for example:
718
719     CPAN> install Inline
720     CPAN> quit
721
722 Check that your perl can run this:
723
724     $ bin/perl -lwe "use Inline C => q[int f() { return 42;}]; print f"
725     42
726     $
727
728 =head4 Bootstrap the CPANPLUS client
729
730 Bootstrap the CPANPLUS client on the clean install:
731
732     $ bin/cpanp
733
734 (Again, on Win32 you'll need something like Cygwin installed, but make sure
735 that you don't end up with its various F<bin/cpan*> programs being found on
736 the PATH before those of the Perl that you're trying to test.)
737
738 =head4 Install the DBI module with CPANPLUS
739
740     CPAN Terminal> i DBI
741     CPAN Terminal> quit
742     $ bin/perl -MDBI -e 1
743     $
744
745 =head4 Make sure that perlbug works
746
747 Test L<perlbug> with the following:
748
749     $ bin/perlbug
750     ...
751     Subject: test bug report
752     Local perl administrator [yourself]: 
753     Editor [vi]: 
754     Module: 
755     Category [core]: 
756     Severity [low]: 
757     (edit report)
758     Action (Send/Display/Edit/Subject/Save to File): f
759     Name of file to save message in [perlbug.rep]: 
760     Action (Send/Display/Edit/Subject/Save to File): q
761
762 and carefully examine the output (in F<perlbug.rep]>), especially
763 the "Locally applied patches" section. If everything appears okay, then
764 delete the file, and try it again, this time actually submitting the bug
765 report. Check that it shows up, then remember to close it!
766
767 =for checklist skip BLEAD-POINT
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 Do not proceed any further until you are sure that your tarballs are on
810 CPAN.  Check your authors directory on one of the "fast" CPAN mirrors
811 (e.g., cpan.hexten.net
812 or cpan.cpantesters.org) to confirm that your uploads have been successful.
813
814 =for checklist skip RC
815
816 =head3 wait for indexing
817
818 I<You MUST SKIP this step for RC>
819
820 Wait until you receive notification emails from the PAUSE indexer
821 confirming that your uploads have been received.  IMPORTANT -- you will
822 probably get an email that indexing has failed, due to module permissions.
823 This is considered normal.
824
825
826 =head3 publish tag
827
828 Now that you've shipped the new perl release to PAUSE, it's
829 time to publish the tag you created earlier to the public git repo (e.g.):
830
831     $ git push origin tag v5.11.0
832
833 =for checklist skip BLEAD-POINT
834
835 =head3 disarm patchlevel.h
836
837 I<You MUST SKIP this step for BLEAD-POINT release>
838
839 Disarm the F<patchlevel.h> change; for example,
840
841      static const char * const local_patches[] = {
842              NULL
843     -        ,"RC1"
844              PERL_GIT_UNPUSHED_COMMITS /* do not remove this line */
845
846 Be sure to commit your change:
847
848     $ git commit -m 'disarm RCnnn bump' patchlevel.h
849     $ git push origin ....
850
851
852
853 =head3 announce to p5p
854
855 Mail p5p to announce your new release, with a quote you prepared earlier.
856
857 Use the template at Porting/release_announcement_template.txt
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 blog about your epigraph
867
868 If you have a blog, please consider writing an entry in your blog explaining
869 why you chose that particular quote for your epigraph.
870
871 =for checklist skip RC
872
873 =head3 Module::CoreList nagging
874
875 I<You MUST SKIP this step for RC>
876
877 Remind the current maintainer of C<Module::CoreList> to push a new release
878 to CPAN.
879
880 =for checklist skip RC
881
882 =head3 new perldelta
883
884 I<You MUST SKIP this step for RC>
885
886 Create a new perldelta.
887
888 =over 4
889
890 =item *
891
892 Confirm that you have a clean checkout with no local changes.
893
894 =item *
895
896 Run F<Porting/new-perldelta.pl>
897
898 =item *
899
900 Run the C<git add> commands it outputs to add new and modified files.
901
902 =item *
903
904 Verify that the build still works, by running C<./Configure> and
905 C<make test_porting>. (On Win32, run C<nmake> and
906 C<nmake test TEST_FILES="porting\*.t ..\lib\diagnostics.t">.)
907
908 =item *
909
910 If F<t/porting/podcheck.t> spots errors in the new F<pod/perldelta.pod>,
911 run C<./perl -MTestInit t/porting/podcheck.t | less> for more detail.
912 Skip to the end of its test output to see the options it offers you.
913
914 =item *
915
916 When C<make test_porting> passes, commit the new perldelta.
917
918 =back
919
920 At this point you may want to compare the commit with a previous bump to
921 see if they look similar.  See commit e3c71926d3 for an example of a
922 previous version bump.
923
924 =for checklist skip BLEAD-POINT MAINT RC
925
926 =head3 bump version
927
928 I<You MUST SKIP this step for RC, BLEAD-POINT, MAINT>
929
930 If this was a BLEAD-FINAL release (i.e. the first release of a new maint
931 series, 5.x.0 where x is even), then bump the version in the blead branch
932 in git, e.g. 5.12.0 to 5.13.0.
933
934 First, add a new feature bundle to F<lib/feature.pm>, initially by just
935 copying the exiting entry, and bump the file's $VERSION; e.g.
936
937          "5.14" => [qw(switch say state unicode_strings)],
938     +    "5.15" => [qw(switch say state unicode_strings)],
939
940 Then follow the section L<"Bump the version number"> to bump the version
941 in the remaining files and test and commit.
942
943
944 =head3 clean build and test
945
946 Run a clean build and test to make sure nothing obvious is broken.
947
948 In particular, F<Porting/perldelta_template.pod> is intentionally exempted
949 from podchecker tests, to avoid false positives about placeholder text.
950 However, once it's copied to F<pod/perldelta.pod> the contents can now
951 cause test failures. Problems should resolved by doing one of the
952 following:
953
954 =over
955
956 =item 1
957
958 Replace placeholder text with correct text.
959
960 =item 2
961
962 If the problem is from a broken placeholder link, you can add it to the
963 array C<@perldelta_ignore_links> in F<t/porting/podcheck.t>.  Lines
964 containing such links should be marked with C<XXX> so that they get
965 cleaned up before the next release.
966
967 =item 3
968
969 Following the instructions output by F<t/porting/podcheck.t> on how to
970 update its exceptions database.
971
972 =back
973
974 =head3 push commits
975
976 Finally, push any commits done above.
977
978     $ git push origin ....
979
980 =for checklist skip BLEAD-POINT MAINT RC
981
982 =head3 create maint branch
983
984 I<You MUST SKIP this step for RC, BLEAD-POINT, MAINT>
985
986 If this was a BLEAD-FINAL release (i.e. the first release of a new maint
987 series, 5.x.0 where x is even), then create a new maint branch based on
988 the commit tagged as the current release.
989
990 Assuming you're using git 1.7.x or newer:
991
992     $ git checkout -b maint-5.12 v5.12.0
993     $ git push origin -u maint-5.12
994
995
996 =for checklist skip BLEAD-POINT MAINT RC
997
998 =head3 make the maint branch available in the APC
999
1000 Clone the new branch into /srv/gitcommon/branches on camel so the APC will
1001 receive its changes.
1002
1003     $ git clone --branch maint-5.14 /gitroot/perl.git \
1004     ?  /srv/gitcommon/branches/perl-5.14.x
1005     $ chmod -R g=u /srv/gitcommon/branches/perl-5.14.x
1006
1007 And nag the sysadmins to make this directory available via rsync.
1008
1009 =for checklist skip BLEAD-POINT RC
1010
1011 =head3 copy perldelta.pod to other branches
1012
1013 I<You MUST SKIP this step for RC, BLEAD-POINT>
1014
1015 Copy the perldelta.pod for this release into the other branches; for
1016 example:
1017
1018     $ cp -i ../5.10.x/pod/perldelta.pod pod/perl5101delta.pod    # for example
1019     $ git add pod/perl5101delta.pod
1020
1021 Edit F<pod/perl.pod> to add an entry for the file, e.g.:
1022
1023     perl5101delta               Perl changes in version 5.10.1
1024
1025 Then rebuild various files:
1026
1027     $ perl pod/buildtoc --build-all
1028
1029 Finally, commit:
1030
1031     $ git commit -a -m 'add perlXXXdelta'
1032
1033
1034 =head3 update perlhist.pod in other branches
1035
1036 Make sure any recent F<pod/perlhist.pod> entries are copied to
1037 F<perlhist.pod> on other branches
1038 e.g.
1039
1040           5.8.9         2008-Dec-14
1041
1042
1043 =head3 bump RT version number
1044
1045 Log into http://rt.perl.org/ and check whether the new version is in the RT
1046 fields C<Perl Version> and C<Fixed In>. The easiest way to determine this is
1047 to go to L<https://rt.perl.org/rt3/Search/Build.html> and click on the drop
1048 downs next to the C<Perl Version> and C<Fixed In> labels.
1049
1050 If the new version is not listed there, send an email to C<perlbug-admin at
1051 perl.org> requesting this.
1052
1053 =head3 Relax!
1054
1055 I<You MUST RETIRE to your preferred PUB, CAFE or SEASIDE VILLA for some
1056 much-needed rest and relaxation>.
1057
1058 Thanks for releasing perl!
1059
1060
1061 =head2 Building a release - the day after
1062
1063 =head3 link announcement in epigraphs.pod
1064
1065 Add, to your quote to F<Porting/epigraphs.pod>, a link to the release
1066 announcement in the web-visible mailing list archive.  Commit it.
1067
1068 =head3 check tarball availability
1069
1070 Check various website entries to make sure the that tarball has appeared
1071 and is properly indexed:
1072
1073 =over 4
1074
1075 =item *
1076
1077 Check your author directory under L<http://www.cpan.org/authors/id/>
1078 to ensure that the tarballs are available on the website.
1079
1080 =item *
1081
1082 Check C</src> on CPAN (on a fast mirror) to ensure that links to
1083 the new tarballs have appeared.  There should be links in C</src/5.0>
1084 (which is accumulating all new versions), links in C</src> (which shows
1085 only the latest version on each branch), and an appropriate mention in
1086 C</src/README.html> (which describes the latest versions).
1087
1088 These links should appear automatically, some hours after upload.
1089 If they don't, or the C<README.html> description is inadequate,
1090 ask Ask <ask@perl.org>.
1091
1092 =item *
1093
1094 Check L<http://www.cpan.org/src/> to ensure that the C</src> updates
1095 have been correctly mirrored to the website.
1096 If they haven't, ask Ask <ask@perl.org>.
1097
1098 =item *
1099
1100 Check L<http://search.cpan.org> to see if it has indexed the distribution.
1101 It should be visible at a URL like C<http://search.cpan.org/dist/perl-5.10.1/>.
1102
1103 =back
1104
1105
1106 =head3 update dev.perl.org
1107
1108 I<This step ONLY for BLEAD-FINAL and MAINT>
1109
1110 Ask Leo Lapworth to update the front page of L<http://dev.perl.org/perl5/> to
1111 link to this new release. If you're feeling ambitious, you can fork
1112 L<https://github.com/perlorg/perlweb> and edit the
1113 F<docs/dev/perl5/index.html> file, then make a pull request.
1114
1115 =for checklist end
1116
1117 =head1 SOURCE
1118
1119 Based on
1120 http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2009-05/msg00608.html,
1121 plus a whole bunch of other sources, including private correspondence.
1122
1123 =cut
1124