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