This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
6068c3c6423cdfdd5a574f51bf35b87b3c77573c
[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 As of August 2009, this file is mostly complete, although it is missing
8 some detail on doing a major release (e.g. 5.10.0 -> 5.12.0). Note that
9 things change at each release, so there may be new things not covered
10 here, or tools may need updating.
11
12 =head1 SYNOPSIS
13
14 This document describes the series of tasks required - some automatic, some
15 manual - to produce a perl release of some description, be that a snaphot,
16 release candidate, or final, numbered release of maint or blead.
17
18 The release process has traditionally been executed by the current
19 pumpking. Blead releases from 5.11.0 forward are made each month on the
20 20th by a non-pumpking release engineer.  The release engineer roster
21 and schedule can be found in Porting/release_schedule.pod.
22
23 This document both helps as a check-list for the release engineer 
24 and is a base for ideas on how the various tasks could be automated 
25 or distributed.
26
27 The outline of a typical release cycle is as follows:
28
29     (5.10.1 is released, and post-release actions have been done)
30
31     ...time passes...
32
33     a few weeks before the release, a number of steps are performed,
34         including bumping the version to 5.10.2
35
36     ...a few weeks passes...
37
38     perl-5.10.2-RC1 is released
39
40     perl-5.10.2 is released
41
42     post-release actions are performed, including creating new
43         perldelta.pod
44
45     ... the cycle continues ...
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 =head2 Release types
57
58 =over 4
59
60 =item Release Candidate (RC)
61
62 A release candidate is an attempt to produce a tarball that is a close as
63 possible to the final release. Indeed, unless critical faults are found
64 during the RC testing, the final release will be identical to the RC
65 barring a few minor fixups (updating the release date in F<perlhist.pod>,
66 removing the RC status from F<patchlevel.h>, etc). If faults are found,
67 then the fixes should be put into a new release candidate, never directly
68 into a final release.
69
70
71 =item Stable/Maint release (MAINT).
72
73 A release with an even version number, and subversion number > 0, such as
74 5.14.1 or 5.14.2.
75
76 At this point you should have a working release candidate with few or no
77 changes since.
78
79 It's essentially the same procedure as for making a release candidate, but
80 with a whole bunch of extra post-release steps.
81
82 =item A blead point release (BLEAD-POINT)
83
84 A release with an odd version number, such as 5.15.0 or 5.15.1.
85
86 This isn't for production, so it has less stability requirements than for
87 other release types, and isn't preceded by RC releases. Other than that,
88 it is similar to a MAINT release.
89
90 =item Blead final release (BLEAD-FINAL)
91
92 A release with an even version number, and subversion number == 0, such as
93 5.14.0. That is to say, ite the big new release once per year.
94
95 It's essentially the same procedure as for making a release candidate, but
96 with a whole bunch of extra post-release steps, even more than for MAINT.
97
98 =back
99
100 =head2 Prerequisites
101
102 Before you can make an official release of perl, there are a few
103 hoops you need to jump through:
104
105 =over 4
106
107 =item PAUSE account
108
109 Make sure you have a PAUSE account suitable for uploading a perl release.
110 If you don't have a PAUSE account, then request one:
111
112     https://pause.perl.org/pause/query?ACTION=request_id
113
114 Check that your account is allowed to upload perl distros: go to
115 L<https://pause.perl.org/pause/authenquery?ACTION=who_pumpkin> and check that
116 your PAUSE ID is listed there.  If not, ask Andreas KE<0xf6>nig to add your ID
117 to the list of people allowed to upload something called perl.  You can find
118 Andreas' email address at:
119
120     https://pause.perl.org/pause/query?ACTION=pause_04imprint
121
122 =item search.cpan.org
123
124 Make sure that search.cpan.org knows that you're allowed to upload
125 perl distros. Contact Graham Barr to make sure that you're on the right
126 list.
127
128 =item CPAN mirror
129
130 Some release engineering steps require a full mirror of the CPAN.
131 Work to fall back to using a remote mirror via HTTP is incomplete
132 but ongoing. (No, a minicpan mirror is not sufficient)
133
134 =item git checkout and commit bit
135
136 You will need a working C<git> installation, checkout of the perl
137 git repository and perl commit bit.  For information about working
138 with perl and git, see F<pod/perlgit.pod>.
139
140 If you are not yet a perl committer, you won't be able to make a
141 release.  Have a chat with whichever evil perl porter tried to talk
142 you into the idea in the first place to figure out the best way to
143 resolve the issue.
144
145
146 =item Quotation for release announcement epigraph
147
148 I<SKIP this step for RC>
149
150 For all except an RC release of perl, you will need a quotation
151 to use as an epigraph to your release announcement.
152
153
154 =back
155
156
157 =head2 Building a release - advance actions
158
159 The work of building a release candidate for a numbered release of
160 perl generally starts several weeks before the first release candidate.
161 Some of the following steps should be done regularly, but all I<must> be
162 done in the run up to a release.
163
164 =over 4
165
166 =item *
167
168 Ensure that dual-life CPAN modules are synchronised with CPAN.  Basically,
169 run the following:
170
171     $ ./perl -Ilib Porting/core-cpan-diff -a -o /tmp/corediffs
172
173 to see any inconsistencies between the core and CPAN versions of distros,
174 then fix the core, or cajole CPAN authors as appropriate. See also the
175 C<-d> and C<-v> options for more detail.  You'll probably want to use the
176 C<-c cachedir> option to avoid repeated CPAN downloads and may want to
177 use C<-m file:///mirror/path> if you made a local CPAN mirror.
178
179 To see which core distro versions differ from the current CPAN versions:
180
181     $ ./perl -Ilib Porting/core-cpan-diff -x -a
182
183 If you are making a MAINT release, run C<core-cpan-diff> on both blead and
184 maint, then diff the two outputs. Compare this with what you expect, and if
185 necessary, fix things up. For example, you might think that both blead
186 and maint are synchronised with a particular CPAN module, but one might
187 have some extra changes. 
188
189 =item *
190
191 Ensure dual-life CPAN modules are stable, which comes down to:
192
193     for each module that fails its regression tests on $current
194         did it fail identically on $previous?
195         if yes, "SEP" (Somebody Else's Problem)
196         else work out why it failed (a bisect is useful for this)
197
198     attempt to group failure causes
199
200     for each failure cause
201         is that a regression?
202         if yes, figure out how to fix it
203             (more code? revert the code that broke it)
204         else
205             (presumably) it's relying on something un-or-under-documented
206             should the existing behaviour stay?
207                 yes - goto "regression"
208                 no - note it in perldelta as a significant bugfix
209                 (also, try to inform the module's author)
210
211 =item *
212
213 Similarly, monitor the smoking of core tests, and try to fix.  See
214 L<http://doc.procura.nl/smoke/index.html> for a summary. See also
215 L<http://www.nntp.perl.org/group/perl.daily-build.reports/> which has
216 the raw reports.
217
218 =item *
219
220 Similarly, monitor the smoking of perl for compiler warnings, and try to
221 fix.
222
223 =item *
224
225 Get perldelta in a mostly finished state.
226
227 Read  F<Porting/how_to_write_a_perldelta.pod>, and try to make sure that
228 every section it lists is, if necessary, populated and complete. Copy
229 edit the whole document.
230
231 =item *
232
233 Bump the version number (e.g. from 5.12.0 to 5.12.1).
234
235 For a BLEAD-POINT release, this can happen on the day of the release.  For a
236 release candidate for a stable perl, this should happen a week or two
237 before the first release candidate to allow sufficient time for testing and
238 smoking with the target version built into the perl executable. For
239 subsequent release candidates and the final release, it it not necessary to
240 bump the version further.
241
242 There is a tool to semi-automate this process. It works in two stages.
243 First, it generates a list of suggested changes, which you review and
244 edit; then you feed this list back and it applies the edits. So, first
245 scan the source directory looking for likely candidates. The command line
246 arguments are the old and new version numbers, and -s means scan:
247
248     $ ./perl -Ilib Porting/bump-perl-version -s 5.10.0 5.10.1 > /tmp/scan
249
250 This produces a file containing a list of suggested edits, e.g.:
251
252     NetWare/Makefile
253
254        89: -MODULE_DESC     = "Perl 5.10.0 for NetWare"
255            +MODULE_DESC     = "Perl 5.10.1 for NetWare"
256
257 i.e. in the file F<NetWare/Makefile>, line 89 would be changed as shown.
258 Review the file carefully, and delete any -/+ line pairs that you don't
259 want changing. You can also edit just the C<+> line to change the
260 suggested replacement text. Remember that this tool is largely just
261 grepping for '5.10.0' or whatever, so it will generate false positives. Be
262 careful not change text like "this was fixed in 5.10.0"! Then run:
263
264     $ ./perl -Ilib Porting/bump-perl-version -u < /tmp/scan
265
266 which will update all the files shown.
267
268 Be particularly careful with F<INSTALL>, which contains a mixture of
269 C<5.10.0>-type strings, some of which need bumping on every release, and
270 some of which need to be left unchanged.
271 The line in F<INSTALL> about "is binary incompatible with" requires a
272 correct choice of earlier version to declare incompatibility with.
273
274 Also note that this tool
275 currently only detects a single substitution per line: so in particular,
276 this line in README.vms needs special handling:
277
278     rename perl-5^.10^.1.dir perl-5_10_1.dir
279
280 When doing a BLEAD-POINT or BLEAD-FINAL release, also make sure the
281 C<PERL_API_*> constants in F<patchlevel.h> are in sync with the version
282 you're releasing, unless you're
283 absolutely sure the release you're about to make is 100% binary compatible
284 to an earlier release. When releasing a MAINT perl version, the C<PERL_API_*>
285 constants C<MUST NOT> be changed as we aim to guarantee binary compatibility
286 in maint branches.
287
288 After editing, regenerate uconfig.h (this must be run on a system with a
289 /bin/sh available):
290
291     $ perl regen/uconfig_h.pl
292
293 Test your changes:
294
295     $ git clean -xdf   # careful if you don't have local files to keep!
296     $ ./Configure -des -Dusedevel
297     $ make
298     $ make test
299
300 Commit your changes:
301
302     $ git st
303     $ git diff
304     B<review the delta carefully>
305
306     $ git commit -a -m 'Bump the perl version in various places for 5.x.y'
307
308 When the version number is bumped, you should also update Module::CoreList (as
309 described below in L<"Building a release - on the day">) to reflect the new
310 version number.
311
312 =item *
313
314 Review and update INSTALL to account for the change in version number;
315 in particular, the "Coexistence with earlier versions of perl 5" section.
316
317 Be particularly careful with the section "Upgrading from 5.X.Y or earlier".
318 The "X.Y" needs to be changed to the most recent version that we are
319 I<not> binary compatible with.
320
321 For MAINT and BLEAD-FINAL releases, this needs to refer to the last
322 release in the previous development cycle (so for example, for a 5.14.x
323 release, this would be 5.13.11).
324
325 For BLEAD-POINT releases, it needs to refer to the previous BLEAD-POINT
326 release (so for 5.15.3 this would be 5.15.2).
327
328
329 =item *
330
331 Update the F<Changes> file to contain the git log command which would show
332 all the changes in this release. You will need assume the existence of a
333 not-yet created tag for the forthcoming release; e.g.
334
335     git log ... perl-5.10.0..perl-5.12.0
336
337 Due to warts in the perforce-to-git migration, some branches require extra
338 exclusions to avoid other branches being pulled in. Make sure you have the
339 correct incantation: replace the not-yet-created tag with C<HEAD> and see
340 if C<git log> produces roughly the right number of commits across roughly the
341 right time period (you may find C<git log --pretty=oneline | wc> useful).
342
343 =item *
344
345 Check some more build configurations. The check that setuid builds and
346 installs is for < 5.11.0 only.
347
348     $ sh Configure -Dprefix=/tmp/perl-5.x.y  -Uinstallusrbinperl \
349         -Duseshrplib -Dd_dosuid
350     $ make
351     $ LD_LIBRARY_PATH=`pwd` make test     # or similar for useshrplib
352
353     $ make suidperl
354     $ su -c 'make install'
355     $ ls -l .../bin/sperl
356     -rws--x--x 1 root root 69974 2009-08-22 21:55 .../bin/sperl
357
358 (Then delete the installation directory.)
359
360 XXX think of other configurations that need testing.
361
362 =item *
363
364 L<perlport> has a section currently named I<Supported Platforms> that
365 indicates which platforms are known to build in the current release.
366 If necessary update the list and the indicated version number.
367
368 =back
369
370
371
372 =head2 Building a release - on the day
373
374 This section describes the actions required to make a release
375 that are performed on the actual day.
376
377 =over 4
378
379 =item *
380
381 Review all the items in the previous section,
382 L<"Building a release - advance actions"> to ensure they are all done and
383 up-to-date.
384
385 =item *
386
387 For a BLEAD-POINT release, if you did not bump the perl version number as
388 part of I<advance actions>, do that now.
389
390 =item *
391
392 Finalize the perldelta.  In particular, fill in the Acknowledgements
393 section.  You can generate a list of contributors with checkAUTHORS.pl.
394 For example:
395
396   $ git log --pretty=fuller v5.13.${last}..HEAD | \
397     perl Porting/checkAUTHORS.pl --who -
398
399 Look at the previous L<perldelta> for how to write the opening
400 paragraph of the Acknowledgements section. To get the amount of
401 changed files and number of lines use this command:
402
403   $ git diff --shortstat v5.13.${last}..HEAD | \
404     ./perl -Ilib -nE 'my ($files, $insert, $delete) = /(\d+)/ga; say "$files files and ", $insert + $delete, " lines changed"'
405
406 Making sure to round off the number of lines changed.
407
408 Re-read the perldelta to try to find any embarrassing typos and thinkos;
409 remove any C<TODO> or C<XXX> flags; update the "Known Problems" section
410 with any serious issues for which fixes are not going to happen now; and
411 run through pod and spell checkers, e.g.
412
413     $ podchecker -warnings -warnings pod/perldelta.pod
414     $ spell pod/perldelta.pod
415
416 Also, you may want to generate and view an HTML version of it to check
417 formatting, e.g.
418
419     $ ./perl -Ilib ext/Pod-Html/pod2html pod/perldelta.pod > /tmp/perldelta.html
420
421 Another good HTML preview option is http://search.cpan.org/pod2html
422
423 If you make changes, be sure to commit them.
424
425 =item *
426
427 Make sure you have a gitwise-clean perl directory (no modified files,
428 unpushed commits etc):
429
430     $ git status
431     $ git clean -dxf
432
433 =item *
434
435 Configure and build perl so that you have a Makefile and porting tools:
436
437     $ ./Configure -Dusedevel -des && make
438
439 =item *
440
441 Update C<Module::CoreList> with module version data for the new release.
442
443 Note that if this is a MAINT release, you should run the following actions
444 from the maint branch, but commit the C<CoreList.pm> changes in
445 I<blead> and subsequently cherry-pick it.  XXX need a better example
446
447 F<corelist.pl> uses ftp.funet.fi to verify information about dual-lived
448 modules on CPAN. It can use a full, local CPAN mirror or fall back
449 to C<wget> or C<curl> to fetch only package metadata remotely. (If you're
450 on Win32, then installing Cygwin is one way to have commands like C<wget>
451 and C<curl> available.)
452
453 (If you'd prefer to have a full CPAN mirror, see 
454 http://www.cpan.org/misc/cpan-faq.html#How_mirror_CPAN)
455
456 Then change to your perl checkout, and if necessary,
457
458     $ make
459
460 If this not the first update for this version (e.g. if it was updated
461 when the version number was originally bumped), first edit
462 F<dist/Module-CoreList/lib/Module/CoreList.pm> to delete the existing
463 entries for this version from the C<%released> and C<%version> hashes:
464 they will have a key like C<5.010001> for 5.10.1.
465
466 XXX the edit-in-place functionality of Porting/corelist.pl should
467 be fixed to handle this automatically.
468
469 Then, If you have a local CPAN mirror, run:
470
471     $ ./perl -Ilib Porting/corelist.pl ~/my-cpan-mirror
472
473 Otherwise, run:
474
475     $ ./perl -Ilib Porting/corelist.pl cpan
476
477 This will chug for a while, possibly reporting various warnings about
478 badly-indexed CPAN modules unrelated to the modules actually in core.
479 Assuming all goes well, it will update
480 F<dist/Module-CoreList/lib/Module/CoreList.pm>.
481
482 Check that file over carefully:
483
484     $ git diff dist/Module-CoreList/lib/Module/CoreList.pm
485
486 If necessary, bump C<$VERSION> (there's no need to do this for
487 every RC; in RC1, bump the version to a new clean number that will
488 appear in the final release, and leave as-is for the later RCs and final).
489
490 Edit the version number in the new C<< 'Module::CoreList' => 'X.YZ' >>
491 entry, as that is likely to reflect the previous version number.
492
493 Also edit Module::CoreList's new version number in its F<Changes>
494 file.
495
496 Add a perldelta entry for the new Module::CoreList version.
497
498 You should also add the version you're about to release to the
499 L<Module::CoreList/CAVEATS> section which enumerates the perl releases
500 that Module::CoreList covers.
501
502 In addition, if this is a final release (rather than a release candidate):
503
504 =over 4 
505
506 =item *
507
508 Update this version's entry in the C<%released> hash with today's date.
509
510 =item *
511
512 Make sure that the script has correctly updated the C<CAVEATS> section
513
514 =back
515
516 Finally, commit the new version of Module::CoreList:
517 (unless this is for MAINT; in which case commit it to blead first, then
518 cherry-pick it back).
519
520     $ git commit -m 'Update Module::CoreList for 5.x.y' dist/Module-CoreList/lib/Module/CoreList.pm
521
522 =item *
523
524 Check that the manifest is sorted and correct:
525
526     $ make distclean
527     $ git clean -xdf # This shouldn't be necessary if distclean is correct
528     $ perl Porting/manicheck
529
530 If manicheck turns up anything wrong, update MANIFEST and begin this step again.
531
532     $ ./configure -des -Dusedevel
533     $ make test_porting
534     $ git commit -m 'Update MANIFEST' MANIFEST
535
536 =item *
537
538 Add an entry to F<pod/perlhist.pod> with the current date, e.g.:
539
540     David    5.10.1-RC1    2009-Aug-06
541
542 Make sure that the correct pumpking is listed in the left-hand column, and
543 if this is the first release under the stewardship of a new pumpking, make
544 sure that his or her name is listed in the section entitled
545 C<THE KEEPERS OF THE PUMPKIN>.
546
547 Be sure to commit your changes:
548
549     $ git commit -m 'add new release to perlhist' pod/perlhist.pod
550
551 =item *
552
553 I<You MUST SKIP this step for a BLEAD-POINT release>
554
555 Update F<patchlevel.h> to add a C<-RC1>-or-whatever string; or, if this is
556 a final release, remove it. For example:
557
558      static const char * const local_patches[] = {
559              NULL
560     +        ,"RC1"
561              PERL_GIT_UNPUSHED_COMMITS /* do not remove this line */
562
563 Be sure to commit your change:
564
565     $ git commit -m 'bump version to RCnnn' patchlevel.h
566
567 =item *
568
569 Build perl, then make sure it passes its own test suite, and installs:
570
571     $ git clean -xdf
572     $ ./Configure -des -Dprefix=/tmp/perl-5.x.y-pretest
573
574     # or if it's an odd-numbered version:
575     $ ./Configure -des -Dusedevel -Dprefix=/tmp/perl-5.x.y-pretest
576
577     $ make test install
578
579 =item *
580
581 Check that the output of C</tmp/perl-5.x.y-pretest/bin/perl -v> and
582 C</tmp/perl-5.x.y-pretest/bin/perl -V> are as expected,
583 especially as regards version numbers, patch and/or RC levels, and @INC
584 paths. Note that as they have been been built from a git working
585 directory, they will still identify themselves using git tags and
586 commits.
587
588 Then delete the temporary installation.
589
590 =item *
591
592 Push all your recent commits:
593
594     $ git push origin ....
595
596
597 =item *
598
599 Tag the release (e.g.):
600
601     $ git tag v5.11.0 -m "First release of the v5.11 series!"
602
603 It is B<VERY> important that from this point forward, you not push
604 your git changes to the Perl master repository.  If anything goes
605 wrong before you publish your newly-created tag, you can delete
606 and recreate it.  Once you push your tag, we're stuck with it
607 and you'll need to use a new version number for your release.
608
609 =item *
610
611 Create a tarball. Use the C<-s> option to specify a suitable suffix for
612 the tarball and directory name:
613
614     $ cd root/of/perl/tree
615     $ make distclean
616     $ git clean -xdf            # make sure perl and git agree on files
617     $ git status                # and there's nothing lying around
618
619     $ perl Porting/makerel -b -s RC1            # for a release candidate
620     $ perl Porting/makerel -b                   # for a final release
621
622 This creates the  directory F<../perl-x.y.z-RC1> or similar, copies all
623 the MANIFEST files into it, sets the correct permissions on them,
624 adds DOS line endings to some, then tars it up as
625 F<../perl-x.y.z-RC1.tar.gz>. With C<-b>, it also creates a C<tar.bz2> file.
626
627 If you're getting your tarball suffixed with -uncommitted and you're sure
628 your changes were all committed, you can override the suffix with:
629
630     $ perl Porting/makerel -b -s ''
631
632 XXX if we go for extra tags and branches stuff, then add the extra details
633 here
634
635 Optionally, you might want to compress your tarball more. Unix F<gzip>
636 doesn't actually produce the smallest possible DEFLATE output. If you have the
637 AdvanceCOMP suite (e.g. the C<advancecomp> port on macports), you can run
638
639     $ advdef -z -4 ../perl-x.y.z-RC1.tar.gz
640
641 which will probably shrink your tarball by about 5%. Over the lifetime of
642 your distribution this will save a lot of people a small amount of download
643 time and disk space, which adds up.
644
645 (7-Zip on Windows is the same code as AdvanceCOMP, so Windows users get the
646 smallest files first time)
647
648 =item *
649
650 Clean up the temporary directory, e.g.
651
652     $ rm -rf ../perl-x.y.z-RC1
653
654 =item *
655
656 Copy the tarballs (.gz and possibly .bz2) to a web server somewhere you
657 have access to.
658
659 =item *
660
661 Download the tarball to some other machine. For a release candidate, 
662 you really want to test your tarball on two or more different platforms
663 and architectures. The #p5p IRC channel on irc.perl.org is a good place
664 to find willing victims.
665
666 =item *
667
668 Check that basic configuration and tests work on each test machine:
669
670     $ ./Configure -des && make all test
671
672 =item *
673
674 Check that the test harness and install work on each test machine:
675
676     $ make distclean
677     $ ./Configure -des -Dprefix=/install/path && make all test_harness install
678     $ cd /install/path
679
680 =item *
681
682 Check that the output of C<perl -v> and C<perl -V> are as expected,
683 especially as regards version numbers, patch and/or RC levels, and @INC
684 paths. 
685
686 Note that the results may be different without a F<.git/> directory,
687 which is why you should test from the tarball.
688
689 =item *
690
691 Run the Installation Verification Procedure utility:
692
693     $ ./perl utils/perlivp
694     ...
695     All tests successful.
696     $
697
698 =item *
699
700 Compare the pathnames of all installed files with those of the previous
701 release (i.e. against the last installed tarball on this branch which you
702 have previously verified using this same procedure). In particular, look
703 for files in the wrong place, or files no longer included which should be.
704 For example, suppose the about-to-be-released version is 5.10.1 and the
705 previous is 5.10.0:
706
707     cd installdir-5.10.0/
708     find . -type f | perl -pe's/5\.10\.0/5.10.1/g' | sort > /tmp/f1
709     cd installdir-5.10.1/
710     find . -type f | sort > /tmp/f2
711     diff -u /tmp/f[12]
712
713 =item *
714
715 Bootstrap the CPAN client on the clean install:
716
717     $ bin/perl -MCPAN -e "shell"
718
719 If you're running this on Win32 you probably also need a set of Unix
720 command-line tools available for CPAN to function correctly without
721 Perl alternatives like LWP installed. Cygwin is an obvious choice.)
722
723 =item *
724
725 Try installing a popular CPAN module that's reasonably complex and that
726 has dependencies; for example:
727
728     CPAN> install Inline
729     CPAN> quit
730
731 Check that your perl can run this:
732
733     $ bin/perl -lwe "use Inline C => q[int f() { return 42;}]; print f"
734     42
735     $
736
737 =item *
738
739 Bootstrap the CPANPLUS client on the clean install:
740
741     $ bin/cpanp
742
743 (Again, on Win32 you'll need something like Cygwin installed, but make sure
744 that you don't end up with its various F<bin/cpan*> programs being found on
745 the PATH before those of the Perl that you're trying to test.)
746
747 =item *
748
749 Install an XS module, for example:
750
751     CPAN Terminal> i DBI
752     CPAN Terminal> quit
753     $ bin/perl -MDBI -e 1
754     $
755
756 =item *
757
758 Check that the L<perlbug> utility works. Try the following:
759
760     $ bin/perlbug
761     ...
762     Subject: test bug report
763     Local perl administrator [yourself]: 
764     Editor [vi]: 
765     Module: 
766     Category [core]: 
767     Severity [low]: 
768     (edit report)
769     Action (Send/Display/Edit/Subject/Save to File): f
770     Name of file to save message in [perlbug.rep]: 
771     Action (Send/Display/Edit/Subject/Save to File): q
772
773 and carefully examine the output (in F<perlbug.rep]>), especially
774 the "Locally applied patches" section. If everything appears okay, then
775 delete the file, and try it again, this time actually submitting the bug
776 report. Check that it shows up, then remember to close it!
777
778 =item *
779
780 Wait for the smoke tests to catch up with the commit which this release is
781 based on (or at least the last commit of any consequence).
782
783 Then check that the smoke tests pass (particularly on Win32). If not, go
784 back and fix things.
785
786 Note that for I<BLEAD-POINT> releases this may not be practical. It takes a
787 long time for the smokers to catch up, especially the Win32
788 smokers. This is why we have a RC cycle for I<MAINT> and I<BLEAD-FINAL>
789 releases, but for I<BLEAD-POINT> releases sometimes the best you can do is
790 to plead with people on IRC to test stuff on their platforms, fire away,
791 and then hope for the best.
792
793 =item *
794
795 Once smoking is okay, upload it to PAUSE. This is the point of no return.
796 If anything goes wrong after this point, you will need to re-prepare
797 a new release with a new minor version or RC number.
798
799     https://pause.perl.org/
800
801 (Login, then select 'Upload a file to CPAN')
802
803 If your workstation is not connected to a high-bandwidth,
804 high-reliability connection to the Internet, you should probably use the
805 "GET URL" feature (rather than "HTTP UPLOAD") to have PAUSE retrieve the
806 new release from wherever you put it for testers to find it.  This will
807 eliminate anxious gnashing of teeth while you wait to see if your
808 15 megabyte HTTP upload successfully completes across your slow, twitchy
809 cable modem.  You can make use of your home directory on dromedary for
810 this purpose: F<http://users.perl5.git.perl.org/~USERNAME> maps to
811 F</home/USERNAME/public_html>, where F<USERNAME> is your login account
812 on dromedary.  I<Remember>: if your upload is partially successful, you
813 may need to contact a PAUSE administrator or even bump the version of perl.
814
815 Upload both the .gz and .bz2 versions of the tarball.
816
817 Wait until you receive notification emails from the PAUSE indexer
818 confirming that your uploads have been received.  IMPORTANT -- you will
819 probably get an email that indexing has failed, due to module permissions.
820 This is considered normal.
821
822 Do not proceed any further until you are sure that your tarballs are on
823 CPAN.  Check your authors directory on one of the "fast" CPAN mirrors
824 (e.g., cpan.hexten.net
825 or cpan.cpantesters.org) to confirm that your uploads have been successful.
826
827 =item *
828
829 Now that you've shipped the new perl release to PAUSE, it's
830 time to publish the tag you created earlier to the public git repo (e.g.):
831
832     $ git push origin tag v5.11.0
833
834 =item *
835
836 I<You MUST SKIP this step for BLEAD-POINT release>
837
838 Disarm the F<patchlevel.h> change; for example,
839
840      static const char * const local_patches[] = {
841              NULL
842     -        ,"RC1"
843              PERL_GIT_UNPUSHED_COMMITS /* do not remove this line */
844
845 Be sure to commit your change:
846
847     $ git commit -m 'disarm RCnnn bump' patchlevel.h
848     $ git push origin ....
849
850
851 =item *
852
853 Mail p5p to announce your new release, with a quote you prepared earlier.
854
855 =item *
856
857 Add your quote to F<Porting/epigraphs.pod> and commit it.
858
859 =item *
860
861 I<You MUST SKIP this step for RC>
862
863 Remind the current maintainer of C<Module::CoreList> to push a new release
864 to CPAN.
865
866 =item *
867
868 I<You MUST SKIP this step for RC>
869
870 Create a new perldelta.
871
872 B<Note>: currently, the buildtoc below must be run in a I<built> perl source
873 directory, as at least one of the pod files it expects to find is
874 autogenerated: perluniprops.pod. But you can't build perl if you've added
875 the new perldelta file and not updated toc. So, make sure you have a built
876 perl (with a pod/perluniprops.pod file) now, I<>before> continuing.
877
878 First, update the F<pod/.gitignore> file  to ignore the next
879 release's generated F<pod/perlNNNdelta.pod> file rather than this release's
880 one which we are about to set in stone (where NNN is the perl version number
881 without the dots. i.e. 5135 for 5.13.5).
882
883     $ (edit pod/.gitignore )
884     $ git add pod/.gitignore
885
886 Then, move the existing F<pod/perldelta.pod> to F<pod/perlNNNdelta.pod>,
887 and edit the moved delta file to change the C<NAME> from C<perldelta> to
888 C<perlNNNdelta>.  For example, assuming you just released 5.10.1, and are
889 about to create the 5.10.2 perldelta:
890
891     $ rm  pod/perl5101delta.pod # remove the auto-generated file, if any
892     $ git mv pod/perldelta.pod pod/perl5101delta.pod
893     $ (edit pod/perl5101delta.pod to retitle)
894     $ git add pod/perl5101delta.pod
895
896 Then create a new empty perldelta.pod file for the new release; see
897 F<Porting/how_to_write_a_perldelta.pod>. You should be able to do this by
898 just copying in a skeleton template and then doing a quick fix up of the
899 version numbers.  Then commit the move and the new file.
900
901     $ cp -i Porting/perldelta_template.pod pod/perldelta.pod
902     $ (edit pod/perldelta.pod)
903     $ git add pod/perldelta.pod
904     $ git commit -m 'create perldelta for 5.10.2'
905
906 =item *
907
908 Now you need to update various tables of contents related to perldelta,
909 most of which can be generated automatically.
910
911 Edit F<pod.lst>: add the new entry, flagged as 'd', and unflag the previous
912 entry from being 'd'; for example:
913
914     -d perl5101delta                Perl changes in version 5.10.1
915     +d perl5102delta                Perl changes in version 5.10.2
916     +  perl5101delta                Perl changes in version 5.10.1
917
918 Manually create a temporary link to the new delta file; normally this is
919 done from the Makefile, but the Makefile is updated by buildtoc, and
920 buildtoc won't run without the file there:
921
922     $ ln -s perldelta.pod pod/perl5102delta.pod
923
924 Run C<perl pod/buildtoc --build-all> to update the F<perldelta> version in
925 the following files:
926
927     MANIFEST
928     Makefile.SH
929     pod/perl.pod
930     vms/descrip_mms.template
931     win32/Makefile
932     win32/makefile.mk
933     win32/pod.mak
934
935 Finally, commit:
936
937     $ git commit -a -m 'update TOC for perlNNNdelta'
938
939 At this point you may want  to compare the commit with a previous bump to
940 see if they look similar. See commit 8891dd8d for an example of a
941 previous version bump.
942
943 =item *
944
945 I<You MUST SKIP this step for RC, BLEAD-POINT, MAINT>
946
947 If this was a BLEAD-FINAL release (i.e. the first release of a new maint
948 series, 5.x.0 where x is even), then bump the version in the blead branch
949 in git, e.g. 5.12.0 to 5.13.0.
950
951 First, add a new feature bundle to F<lib/feature.pm>, initially by just
952 copying the exiting entry, and bump the file's $VERSION; e.g.
953
954          "5.14" => [qw(switch say state unicode_strings)],
955     +    "5.15" => [qw(switch say state unicode_strings)],
956
957 Then follow the item "Bump the version number" in the section
958 L<"Building a release - advance actions"> to bump the version in the
959 remaining files and test and commit.
960
961 Finally, push the changes.
962
963 =item *
964
965 I<You MUST SKIP this step for RC, BLEAD-POINT, MAINT>
966
967 If this was a BLEAD-FINAL release (i.e. the first release of a new maint
968 series, 5.x.0 where x is even), then create a new maint branch based on
969 the commit tagged as the current release.
970
971 Assuming you're using git 1.7.x or newer:
972
973     $ git checkout -b maint-5.12 v5.12.0
974     $ git push origin -u maint-5.12
975
976 =item *
977
978 I<You MUST SKIP this step for RC, BLEAD-POINT>
979
980 Copy the perldelta.pod for this release into the other branches; for
981 example:
982
983     $ cp -i ../5.10.x/pod/perldelta.pod pod/perl5101delta.pod    # for example
984     $ git add pod/perl5101delta.pod
985
986 Edit F<pod.lst> to add an entry for the file, e.g.:
987
988     perl5101delta               Perl changes in version 5.10.1
989
990 Then rebuild various files:
991
992     $ perl pod/buildtoc --build-all
993
994 Finally, commit:
995
996     $ git commit -a -m 'add perlXXXdelta'
997
998 =item *
999
1000 Make sure any recent F<pod/perlhist.pod> entries are copied to
1001 F<perlhist.pod> on other branches; typically the RC* and final entries,
1002 e.g.
1003
1004           5.8.9-RC1     2008-Nov-10
1005           5.8.9-RC2     2008-Dec-06
1006           5.8.9         2008-Dec-14
1007
1008 =item *
1009
1010 If necessary, send an email to C<perlbug-admin at perl.org> requesting
1011 that new version numbers be added to the RT fields C<Perl Version> and
1012 C<Fixed In>.
1013
1014 =item *
1015
1016 I<You MUST RETIRE to your preferred PUB, CAFE or SEASIDE VILLA for some
1017 much-needed rest and relaxation>.
1018
1019 Thanks for releasing perl!
1020
1021 =back
1022
1023 =head2 Building a release - the day after
1024
1025 =over 4
1026
1027 =item *
1028
1029 Check your author directory under L<http://www.cpan.org/authors/id/>
1030 to ensure that the tarballs are available on the website.
1031
1032 =item *
1033
1034 Check C</src> on CPAN (on a fast mirror) to ensure that links to
1035 the new tarballs have appeared.  There should be links in C</src/5.0>
1036 (which is accumulating all new versions), links in C</src> (which shows
1037 only the latest version on each branch), and an appropriate mention in
1038 C</src/README.html> (which describes the latest versions).
1039
1040 These links should appear automatically, some hours after upload.
1041 If they don't, or the C<README.html> description is inadequate,
1042 ask Ask <ask@perl.org>.
1043
1044 =item *
1045
1046 Check L<http://www.cpan.org/src/> to ensure that the C</src> updates
1047 have been correctly mirrored to the website.
1048 If they haven't, ask Ask <ask@perl.org>.
1049
1050 =item *
1051
1052 Check L<http://search.cpan.org> to see if it has indexed the distribution.
1053 It should be visible at a URL like C<http://search.cpan.org/dist/perl-5.10.1/>.
1054
1055 =item *
1056
1057 I<This step ONLY for STABLE>
1058
1059 Ask Rafael to update L<http://dev.perl.org/perl5/>.
1060
1061 =back
1062
1063 =head1 SOURCE
1064
1065 Based on
1066 http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2009-05/msg00608.html,
1067 plus a whole bunch of other sources, including private correspondence.
1068
1069 =cut
1070