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