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