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