This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Update Porting/release_managers_guide.pod and Porting/makerel
[perl5.git] / Porting / release_managers_guide.pod
1 =head1 NAME
2
3 release_managers_guide - Releasing a new version of perl 5.x
4
5 As of August 2009, this file is mostly complete, although it is missing
6 some detail on doing a major release (e.g. 5.10.0 -> 5.12.0). Note that
7 things change at each release, so there may be new things not covered
8 here, or tools may need updating.
9
10 =head1 SYNOPSIS
11
12 This document describes the series of tasks required - some automatic, some
13 manual - to produce a perl release of some description, be that a snaphot,
14 release candidate, or final, numbered release of maint or blead.
15
16 The release process has traditionally been executed by the current
17 pumpking. Blead releases from 5.11.0 forward are made each month on the
18 20th by a non-pumpking release engineer.  The release engineer roster
19 and schedule can be found in Porting/release_schedule.pod.
20
21 This document both helps as a check-list for the release engineer 
22 and is a base for ideas on how the various tasks could be automated 
23 or distributed.
24
25 The outline of a typical release cycle is as follows:
26
27     (5.10.1 is released, and post-release actions have been done)
28
29     ...time passes...
30
31     an occasional snapshot is released, that still identifies itself as
32         5.10.1
33
34     ...time passes...
35
36     a few weeks before the release, a number of steps are performed,
37         including bumping the version to 5.10.2
38
39     ...a few weeks passes...
40
41     perl-5.10.2-RC1 is released
42
43     perl-5.10.2 is released
44
45     post-release actions are performed, including creating new
46         perl5103delta.pod
47
48     ... the cycle continues ...
49
50 =head1 DETAILS
51
52 Some of the tasks described below apply to all four types of 
53 release of Perl. (snapshot, RC, final release of maint, final 
54 release of blead). Some of these tasks apply only to a subset
55 of these release types.  If a step does not apply to a given 
56 type of release, you will see a notation to that effect at
57 the beginning of the step.
58
59 =head2 Release types
60
61 =over 4
62
63 =item Snapshot
64
65 A snapshot is intended to encourage in-depth testing from time-to-time,
66 for example after a key point in the stabilisation of a branch. It
67 requires fewer steps than a full release, and the version number of perl in
68 the tarball will usually be the same as that of the previous release.
69
70 =item Release Candidate (RC)
71
72 A release candidate is an attempt to produce a tarball that is a close as
73 possible to the final release. Indeed, unless critical faults are found
74 during the RC testing, the final release will be identical to the RC
75 barring a few minor fixups (updating the release date in F<perlhist.pod>,
76 removing the RC status from F<patchlevel.h>, etc). If faults are found,
77 then the fixes should be put into a new release candidate, never directly
78 into a final release.
79
80 =item Stable/Maint release
81
82 At this point you should have a working release candidate with few or no
83 changes since.
84
85 It's essentially the same procedure as for making a release candidate, but
86 with a whole bunch of extra post-release steps.
87
88 =item Blead release
89
90 It's essentially the same procedure as for making a release candidate, but
91 with a whole bunch of extra post-release steps.
92
93 =back
94
95 =head2 Prerequisites
96
97 Before you can make an official release of perl, there are a few
98 hoops you need to jump through:
99
100 =over 4
101
102 =item PAUSE account
103
104 I<SKIP this step for SNAPSHOT>
105
106 Make sure you have a PAUSE account suitable for uploading a perl release.
107 If you don't have a PAUSE account, then request one:
108
109     https://pause.perl.org/pause/query?ACTION=request_id
110
111 Check that your account is allowed to upload perl distros: goto
112 L<https://pause.perl.org/>, login, then select 'upload file to CPAN'; there
113 should be a "For pumpkings only: Send a CC" tickbox.  If not, ask Andreas
114 K├Ânig to add your ID to the list of people allowed to upload something
115 called perl.  You can find Andreas' email address at:
116
117     https://pause.perl.org/pause/query?ACTION=pause_04imprint
118
119 =item search.cpan.org
120
121 Make sure that search.cpan.org knows that you're allowed to upload
122 perl distros. Contact Graham Barr to make sure that you're on the right
123 list.
124
125 =item CPAN mirror
126
127 Some release engineering steps require a full mirror of the CPAN.
128 Work to fall back to using a remote mirror via HTTP is incomplete
129 but ongoing. (No, a minicpan mirror is not sufficient)
130
131 =item git checkout and commit bit
132
133 You will need a working C<git> installation, checkout of the perl
134 git repository and perl commit bit.  For information about working
135 with perl and git, see F<pod/perlrepository.pod>.
136
137 If you are not yet a perl committer, you won't be able to make a
138 release.  Have a chat with whichever evil perl porter tried to talk
139 you into the idea in the first place to figure out the best way to
140 resolve the issue.
141
142
143 =item Quotation for release announcement epigraph
144
145 I<SKIP this step for SNAPSHOT and RC>
146
147 For a numbered blead or maint release of perl, you will need a quotation 
148 to use as an epigraph to your release announcement.  (There's no harm
149 in having one for a snapshot, but it's not required).
150
151
152 =back
153
154
155 =head2 Building a release - advance actions
156
157 The work of building a release candidate for a numbered release of
158 perl generally starts several weeks before the first release candidate.
159 Some of the following steps should be done regularly, but all I<must> be
160 done in the run up to a release.
161
162 =over 4
163
164 =item *
165
166 I<You MAY SKIP this step for SNAPSHOT>
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.
177
178 To see which core distro versions differ from the current CPAN versions:
179
180     $ ./perl -Ilib Porting/core-cpan-diff -x -a
181
182 If you are making a maint release, run C<core-cpan-diff> on both blead and
183 maint, then diff the two outputs. Compare this with what you expect, and if
184 necessary, fix things up. For example, you might think that both blead
185 and maint are synchronised with a particular CPAN module, but one might
186 have some extra changes. 
187
188 =item *
189
190 I<You MAY SKIP this step for SNAPSHOT>
191
192 Ensure dual-life CPAN modules are stable, which comes down to:
193
194     for each module that fails its regression tests on $current
195         did it fail identically on $previous?
196         if yes, "SEP" (Somebody Else's Problem)
197         else work out why it failed (a bisect is useful for this)
198
199     attempt to group failure causes
200
201     for each failure cause
202         is that a regression?
203         if yes, figure out how to fix it
204             (more code? revert the code that broke it)
205         else
206             (presumably) it's relying on something un-or-under-documented
207             should the existing behaviour stay?
208                 yes - goto "regression"
209                 no - note it in perldelta as a significant bugfix
210                 (also, try to inform the module's author)
211
212 =item *
213
214 I<You MAY SKIP this step for SNAPSHOT>
215
216 Similarly, monitor the smoking of core tests, and try to fix.
217
218 =item *
219
220 I<You MAY SKIP this step for SNAPSHOT>
221
222 Similarly, monitor the smoking of perl for compiler warnings, and try to
223 fix.
224
225 =item *
226
227 I<You MAY SKIP this step for SNAPSHOT>
228
229 Run F<Porting/cmpVERSION.pl> to compare the current source tree with the
230 previous version to check for for modules that have identical version
231 numbers but different contents, e.g.:
232
233      $ cd ~/some-perl-root
234      $ ./perl -Ilib Porting/cmpVERSION.pl -xd ~/my_perl-tarballs/perl-5.10.0 .
235
236 then bump the version numbers of any non-dual-life modules that have
237 changed since the previous release, but which still have the old version
238 number. If there is more than one maintenance branch (e.g. 5.8.x, 5.10.x),
239 then compare against both.
240
241 Note that some of the files listed may be generated (e.g. copied from ext/
242 to lib/, or a script like lib/lib_pm.PL is run to produce lib/lib.pm);
243 make sure you edit the correct file!
244
245 Once all version numbers have been bumped, re-run the checks.
246
247 Then run again without the -x option, to check that dual-life modules are
248 also sensible.
249
250      $ ./perl -Ilib Porting/cmpVERSION.pl -d ~/my_perl-tarballs/perl-5.10.0 .
251
252 =item *
253
254 I<You MAY SKIP this step for SNAPSHOT>
255
256 Get perldelta in a mostly finished state.
257
258 Peruse  F<Porting/how_to_write_a_perldelta.pod>, and try to make sure that
259 every section it lists is, if necessary, populated and complete. Copy
260 edit the whole document.
261
262 =item *
263
264 I<You MUST SKIP this step for SNAPSHOT>
265
266 A week or two before the first release candidate, bump the perl version
267 number (e.g. from 5.10.0 to 5.10.1), to allow sufficient time for testing
268 and smoking with the target version built into the perl executable. For
269 subsequent release candidates and the final release, it it not necessary
270 to bump the version further.
271
272 There is a tool to semi-automate this process. It works in two stages.
273 First, it generates a list of suggested changes, which you review and
274 edit; then you feed this list back and it applies the edits. So, first
275 scan the source directory looking for likely candidates. The command line
276 arguments are the old and new version numbers, and -s means scan:
277
278     $ Porting/bump-perl-version -s 5.10.0 5.10.1 > /tmp/scan
279
280 This produces a file containing a list of suggested edits, e.g.:
281
282     NetWare/Makefile
283
284        89: -MODULE_DESC     = "Perl 5.10.0 for NetWare"
285            +MODULE_DESC     = "Perl 5.10.1 for NetWare"
286
287 i.e. in the file F<NetWare/Makefile>, line 89 would be changed as shown.
288 Review the file carefully, and delete any -/+ line pairs that you don't
289 want changing. You can also edit just the C<+> line to change the
290 suggested replacement text. Remember that this tool is largely just
291 grepping for '5.10.0' or whatever, so it will generate false positives. Be
292 careful not change text like "this was fixed in 5.10.0"! Then run:
293
294     $ Porting/bump-perl-version -u < /tmp/scan
295
296 which will update all the files shown.
297
298 Be particularly careful with F<INSTALL>, which contains a mixture of
299 C<5.10.0>-type strings, some of which need bumping on every release, and
300 some of which need to be left unchanged. Also note that this tool
301 currently only detects a single substitution per line: so in particular,
302 this line in README.vms needs special handling:
303
304     rename perl-5^.10^.1.dir perl-5_10_1.dir
305
306 Commit your changes:
307
308     $ git st
309         $ git diff
310           B<review the delta carefully>
311
312     $ git commit -a -m 'Bump the perl version in various places for 5.x.y'
313
314 When the version number is bumped, you should also update Module::CoreList (as
315 described below in L<"Building a release - on the day">) to reflect the new
316 version number.
317
318 =item *
319
320 I<You MUST SKIP this step for SNAPSHOT>
321
322 Review and update INSTALL to account for the change in version number;
323 in particular, the "Coexistence with earlier versions of perl 5" section.
324
325 =item *
326
327 I<You MUST SKIP this step for SNAPSHOT>
328
329 Update the F<Changes> file to contain the git log command which would show
330 all the changes in this release. You will need assume the existence of a
331 not-yet created tag for the forthcoming release; e.g.
332
333     git log ... perl-5.10.0..perl-5.12.0
334
335 Due to warts in the perforce-to-git migration, some branches require extra
336 exclusions to avoid other branches being pulled in. Make sure you have the
337 correct incantation: replace the not-yet-created tag with C<HEAD> and see
338 if C<git log> produces roughly the right number of commits across roughly the
339 right time period (you may find C<git log --pretty=oneline | wc> useful).
340
341 =item *
342
343 Check some more build configurations. The check that setuid builds and
344 installs is for < 5.11.0 only.
345
346     $ sh Configure -Dprefix=/tmp/perl-5.x.y  -Uinstallusrbinperl \
347         -Duseshrplib -Dd_dosuid
348     $ make
349     $ LD_LIBRARY_PATH=`pwd` make test     # or similar for useshrplib
350
351     $ make suidperl
352     $ su -c 'make install'
353     $ ls -l .../bin/sperl
354     -rws--x--x 1 root root 69974 2009-08-22 21:55 .../bin/sperl
355
356 (Then delete the installation directory.)
357
358 XXX think of other configurations that need testing.
359
360 =item *
361
362 I<You MAY SKIP this step for SNAPSHOT>
363
364 Update F<AUTHORS>, using the C<Porting/checkAUTHORS.pl> script, and if
365 necessary, update the script to include new alias mappings for porters
366 already in F<AUTHORS>
367
368         $ git log | perl Porting/checkAUTHORS.pl --acknowledged AUTHORS -
369
370 =back
371
372 =head2 Building a release - on the day
373
374 This section describes the actions required to make a release (or snapshot
375 etc) 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 I<You MAY SKIP this step for SNAPSHOT>
388
389 Re-read the perldelta to try to find any embarrassing typos and thinkos;
390 remove any C<TODO> or C<XXX> flags; update the "Known Problems" section
391 with any serious issues for which fixes are not going to happen now; and
392 run through pod and spell checkers, e.g.
393
394     $ podchecker -warnings -warnings pod/perl5101delta.pod
395     $ spell pod/perl5101delta.pod
396
397 Also, you may want to generate and view an HTML version of it to check
398 formatting, e.g.
399
400     $ perl pod/pod2html pod/perl5101delta.pod > /tmp/perl5101delta.html
401
402 =item *
403
404 Make sure you have a gitwise-clean perl directory (no modified files,
405 unpushed commits etc):
406
407     $ git status
408
409 =item *
410
411 If not already built, Configure and build perl so that you have a Makefile
412 and porting tools:
413
414     $ ./Configure -Dusedevel -des && make
415
416 =item *
417
418 Check that files managed by F<regen.pl> and friends are up to date. From
419 within your working directory:
420
421     $ git status
422     $ make regen
423     $ make regen_perly
424     $ git status
425
426 If any of the files managed by F<regen.pl> have changed, then you should
427 re-make perl to check that it's okay, then commit the updated versions:
428
429     $ git commit -a -m 'make regen; make regen_perly'
430
431 =item *
432
433 Rebuild META.yml:
434
435     $ rm META.yml
436     $ make META.yml
437     $ git diff
438
439 XXX it would be nice to make Porting/makemeta use regen_lib.pl
440 to get the same 'update the file if its changed' functionality
441 we get with 'make regen' etc.
442
443 Commit META.yml if it has changed:
444
445     $ git commit -m 'Update META.yml' META.yml
446
447 =item *
448
449 I<You MUST SKIP this step for SNAPSHOT>
450
451 Update C<Module::Corelist> with module version data for the new release.
452
453 Note that if this is a maint release, you should run the following actions
454 from the maint directory, but commit the C<Corelist.pm> changes in
455 I<blead> and subsequently cherry-pick it.
456
457 F<corelist.pl> uses ftp.funet.fi to verify information about dual-lived
458 modules on CPAN. It can use a full, local CPAN mirror or fall back
459 to C<wget> or C<curl> to fetch only package metadata remotely. (If you're
460 on Win32, then installing Cygwin is one way to have commands like C<wget>
461 and C<curl> available.)
462
463 (If you'd prefer to have a full CPAN mirror, see 
464 http://www.cpan.org/misc/cpan-faq.html#How_mirror_CPAN)
465
466 Then change to your perl checkout, and if necessary,
467
468     $ make perl
469
470 If this not the first update for this version (e.g. if it was updated
471 when the version number was originally bumped), first edit
472 F<dist/Module-CoreList/lib/Module/CoreList.pm> to delete the existing
473 entries for this version from the C<%released> and C<%version> hashes:
474 they will have a key like C<5.010001> for 5.10.1.
475
476 XXX the edit-in-place functionality of Porting/corelist.pl should
477 be fixed to handle this automatically.
478
479 Then, If you have a local CPAN mirror, run:
480
481     $ ./perl -Ilib Porting/corelist.pl ~/my-cpan-mirror
482
483 Otherwise, run:
484
485     $ ./perl -Ilib Porting/corelist.pl cpan
486
487 This will chug for a while, possibly reporting various warnings about
488 badly-indexed CPAN modules unrelated to the modules actually in core.
489 Assuming all goes well, it will update
490 F<dist/Module-CoreList/lib/Module/CoreList.pm>.
491
492 Check that file over carefully:
493
494     $ git diff dist/Module-CoreList/lib/Module/CoreList.pm
495
496 If necessary, bump C<$VERSION> (there's no need to do this for
497 every RC; in RC1, bump the version to a new clean number that will
498 appear in the final release, and leave as-is for the later RCs and final).
499
500 Edit the version number in the new C<< 'Module::CoreList' => 'X.YZ' >>
501 entry, as that is likely to reflect the previous version number.
502
503 Also edit Module::CoreList's new version number in its F<Changes> file and
504 in its F<META.yml> file.
505
506 In addition, if this is a final release (rather than a release candidate):
507
508 =over 4 
509
510 =item *
511
512 Update this version's entry in the C<%released> hash with today's date.
513
514 =item *
515
516 Make sure that the script has correctly updated the C<CAVEATS> section
517
518 =back
519
520 Finally, commit the new version of Module::CoreList:
521 (unless this is for maint; in which case commit it blead first, then
522 cherry-pick it back).
523
524     $ git commit -m 'Update Module::CoreList for 5.x.y' dist/Module-CoreList/lib/Module/CoreList.pm
525
526 =item *
527
528 Check that the manifest is sorted and correct:
529
530     $ make manisort
531     $ make distclean
532     $ git clean -xdf # This shouldn't be necessary if distclean is correct
533     $ perl Porting/manicheck
534     $ git status
535
536         XXX manifest _sorting_ is now checked with make test_porting
537
538 Commit MANIFEST if it has changed:
539
540     $ git commit -m 'Update MANIFEST' MANIFEST
541
542 =item *
543
544 I<You MUST SKIP this step for SNAPSHOT>
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 =item *
560
561 I<You MUST SKIP this step for SNAPSHOT>
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 =item *
576
577 Build perl, then make sure it passes its own test suite, and installs:
578
579     $ git clean -xdf
580     $ ./Configure -des -Dprefix=/tmp/perl-5.x.y-pretest
581
582     # or if it's an odd-numbered version:
583     $ ./Configure -des -Dusedevel -Dprefix=/tmp/perl-5.x.y-pretest
584
585     $ make test install
586
587 =item *
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 =item *
599
600 If this is maint release, make sure F<Porting/mergelog> is saved and
601 committed.
602
603 =item *
604
605 Push all your recent commits:
606
607     $ git push origin ....
608
609
610 =item *
611
612 I<You MUST SKIP this step for SNAPSHOT>
613
614 Tag the release (e.g.):
615
616     $ git tag v5.11.0 -m'First release of the v5.11 series!'
617
618 (Adjust the syntax appropriately if you're working on Win32, i.e. use
619 C<-m "..."> rather than C<-m'...'>.)
620
621 It is VERY important that from this point forward, you not push
622 your git changes to the Perl master repository.  If anything goes
623 wrong before you publish your newly-created tag, you can delete
624 and recreate it.  Once you push your tag, we're stuck with it
625 and you'll need to use a new version number for your release.
626
627 =item *
628
629 Create a tarball. Use the C<-s> option to specify a suitable suffix for
630 the tarball and directory name:
631
632     $ cd root/of/perl/tree
633     $ make distclean
634     $ git clean -xdf            # make sure perl and git agree on files
635     $ git status                # and there's nothing lying around
636
637     $ perl Porting/makerel -b -s `git describe` # for a snapshot
638     $ perl Porting/makerel -b -s RC1            # for a release candidate
639     $ perl Porting/makerel -b                   # for a final release
640
641 This creates the  directory F<../perl-x.y.z-RC1> or similar, copies all
642 the MANIFEST files into it, sets the correct permissions on them,
643 adds DOS line endings to some, then tars it up as
644 F<../perl-x.y.z-RC1.tar.gz>. With C<-b>, it also creates a C<tar.bz2> file.
645
646
647 XXX if we go for extra tags and branches stuff, then add the extra details
648 here
649
650 =item *
651
652 Clean up the temporary directory, e.g.
653
654     $ rm -rf ../perl-x.y.z-RC1
655
656 =item *
657
658 Copy the tarballs (.gz and possibly .bz2) to a web server somewhere you
659 have access to.
660
661 =item *
662
663 Download the tarball to some other machine. For a release candidate, 
664 you really want to test your tarball on two or more different platforms
665 and architectures. The #p5p IRC channel on irc.perl.org is a good place
666 to find willing victims.
667
668 =item *
669
670 Check that basic configuration and tests work on each test machine:
671
672     $ ./Configure -des && make all test
673
674 =item *
675
676 Check that the test harness and install work on each test machine:
677
678     $ make distclean
679     $ ./Configure -des -Dprefix=/install/path && make all test_harness install
680     $ cd /install/path
681
682 =item *
683
684 Check that the output of C<perl -v> and C<perl -V> are as expected,
685 especially as regards version numbers, patch and/or RC levels, and @INC
686 paths. 
687
688 Note that the results may be different without a F<.git/> directory,
689 which is why you should test from the tarball.
690
691 =item *
692
693 Run the Installation Verification Procedure utility:
694
695     $ bin/perlivp
696     ...
697     All tests successful.
698     $
699
700 =item *
701
702 Compare the pathnames of all installed files with those of the previous
703 release (i.e. against the last installed tarball on this branch which you
704 have previously verified using this same procedure). In particular, look
705 for files in the wrong place, or files no longer included which should be.
706 For example, suppose the about-to-be-released version is 5.10.1 and the
707 previous is 5.10.0:
708
709     cd installdir-5.10.0/
710     find . -type f | perl -pe's/5\.10\.0/5.10.1/g' | sort > /tmp/f1
711     cd installdir-5.10.1/
712     find . -type f | sort > /tmp/f2
713     diff -u /tmp/f[12]
714
715 =item *
716
717 Bootstrap the CPAN client on the clean install:
718
719     $ bin/perl -MCPAN -e'shell' 
720
721 (Use C<... -e "shell"> instead on Win32. You probably also need a set of
722 Unix command-line tools available for CPAN to function correctly without
723 Perl alternatives like LWP installed. Cygwin is an obvious choice.)
724
725 =item *
726
727 Try installing a popular CPAN module that's reasonably complex and that
728 has dependencies; for example:
729
730     CPAN> install Inline
731     CPAN> quit
732
733 Check that your perl can run this:
734
735     $ bin/perl -lwe 'use Inline C => "int f() { return 42;} "; print f'
736     42
737     $
738
739 (Use C<... -lwe "use ..."> instead on Win32.)
740
741 =item *
742
743 Bootstrap the CPANPLUS client on the clean install:
744
745     $ bin/cpanp
746
747 (Again, on Win32 you'll need something like Cygwin installed, but make sure
748 that you don't end up with its various F<bin/cpan*> programs being found on
749 the PATH before those of the Perl that you're trying to test.)
750
751 =item *
752
753 Install an XS module, for example:
754
755     CPAN Terminal> i DBI
756     CPAN Terminal> quit
757     $ bin/perl -MDBI -e 1
758     $
759
760 =item *
761
762 I<If you're building a SNAPSHOT, you should STOP HERE>
763
764 =item *
765
766 Check that the C<perlbug> utility works. Try the following:
767
768     $ bin/perlbug
769     ...
770     Subject: test bug report
771     Local perl administrator [yourself]: 
772     Editor [vi]: 
773     Module: 
774     Category [core]: 
775     Severity [low]: 
776     (edit report)
777     Action (Send/Display/Edit/Subject/Save to File): f
778     Name of file to save message in [perlbug.rep]: 
779     Action (Send/Display/Edit/Subject/Save to File): q
780
781 and carefully examine the output (in F<perlbug.rep]>), especially
782 the "Locally applied patches" section. If everything appears okay, then
783 delete the file, and try it again, this time actually submitting the bug
784 report. Check that it shows up, then remember to close it!
785
786 =item *
787
788 Wait for the smoke tests to catch up with the commit which this release is
789 based on (or at least the last commit of any consequence).
790
791 Then check that the smoke tests pass (particularly on Win32). If not, go
792 back and fix things.
793
794
795 =item *
796
797 Once smoking is okay, upload it to PAUSE. This is the point of no return.
798 If anything goes wrong after this point, you will need to re-prepare
799 a new release with a new minor version or RC number.
800
801     https://pause.perl.org/
802
803 (Login, then select 'Upload a file to CPAN')
804
805 If your workstation is not connected to a high-bandwidth,
806 high-reliability connection to the Internet, you should probably use the
807 "GET URL" feature (rather than "HTTP UPLOAD") to have PAUSE retrieve the
808 new release from wherever you put it for testers to find it.  This will
809 eliminate anxious gnashing of teeth while you wait to see if your
810 15 megabyte HTTP upload successfully completes across your slow, twitchy
811 cable modem.  I<Remember>: if your upload is partially successful, you
812 may need to contact a PAUSE administrator or even bump the version of
813 perl.
814
815 Upload both the .gz and .bz2 versions of the tarball.
816
817 =item *
818
819 Now that you've shipped the new perl release to PAUSE, it's
820 time to publish the tag you created earlier to the public git repo (e.g.):
821
822     $ git push origin tag v5.11.0
823
824 =item *
825
826 Disarm the F<patchlevel.h> change; for example,
827
828      static const char * const local_patches[] = {
829              NULL
830     -        ,"RC1"
831              PERL_GIT_UNPUSHED_COMMITS /* do not remove this line */
832
833 Be sure to commit your change:
834
835     $ git commit -m 'disarm RCnnn bump' patchlevel.h
836     $ git push origin ....
837
838
839 =item *
840
841 Mail p5p to announce your new release, with a quote you prepared earlier.
842
843 =item *
844
845 Wait 24 hours or so, then post the announcement to use.perl.org.
846 (if you don't have access rights to post news, ask someone like Rafael to
847 do it for you.)
848
849 =item *
850
851 Ask Jarkko to add the tarball to http://www.cpan.org/src/
852
853 =item *
854
855 I<You MUST SKIP this step for RC, BLEAD>
856
857 Ask Jarkko to update the descriptions of which tarballs are current in
858 http://www.cpan.org/src/README.html, and Rafael to update
859 http://dev.perl.org/perl5/
860
861 =item *
862
863 I<You MUST SKIP this step for RC>
864
865 Remind the current maintainer of C<Module::CoreList> to push a new release
866 to CPAN.
867
868 =item *
869
870 I<You MUST SKIP this step for RC>
871
872 Bump the perlXYZdelta version number.
873
874 First, create a new empty perlNNNdelta.pod file for the current release + 1;
875 see F<Porting/how_to_write_a_perldelta.pod>.
876
877 You should be able to do this by just copying in a skeleton template and
878 then doing a quick fix up of the version numbers, e.g.
879
880     $ cp -i Porting/perldelta_template.pod pod/perl5102delta.pod
881     $ (edit it)
882     $ git add pod/perl5102delta.pod
883
884 Edit F<pod.lst>: add the new entry, flagged as 'D', and unflag the previous
885 entry from being 'D'; for example:
886
887     -D perl5101delta                Perl changes in version 5.10.1
888     +D perl5102delta                Perl changes in version 5.10.2
889     +  perl5101delta                Perl changes in version 5.10.1
890
891 Run C<perl pod/buildtoc --build-all> to update the F<perldelta> version in
892 the following files:
893
894     MANIFEST
895     Makefile.SH
896     pod.lst
897     pod/perl.pod
898     vms/descrip_mms.template
899     win32/Makefile
900     win32/makefile.mk
901     win32/pod.mak
902
903 Then manually edit (F<vms/descrip_mms.template> to bump the version
904 in the following entry:
905
906     [.pod]perldelta.pod : [.pod]perl5101delta.pod
907
908 XXX this previous step needs to fixed to automate it in pod/buildtoc.
909
910 Manually update references to the perlNNNdelta version in these files:
911
912     INSTALL
913     README
914
915 Edit the previous delta file to change the C<NAME> from C<perldelta>
916 to C<perlNNNdelta>.
917
918 These two lists of files probably aren't exhaustive; do a recursive grep
919 on the previous filename to look for suitable candidates that may have
920 been missed.
921
922 Finally, commit:
923
924     $ git commit -a -m 'create perlXXXdelta'
925
926 At this point you may want  to compare the commit with a previous bump to
927 see if they look similar. See commit ca8de22071 for an example of a
928 previous version bump.
929
930 =item *
931
932 I<You MUST SKIP this step for RC, BLEAD>
933
934 If this was a maint release, then edit F<Porting/mergelog> to change
935 all the C<d> (deferred) flags to C<.> (needs review).
936
937 =item *
938
939 I<You MUST SKIP this step for RC, BLEAD>
940
941 If this was a major release (5.x.0), then create a new maint branch 
942 based on the commit tagged as the current release and bump the version 
943 in the blead branch in git, e.g. 5.12.0 to 5.13.0.
944
945 [ XXX probably lots more stuff to do, including perldelta,
946 C<lib/feature.pm> ]
947
948 XXX need a git recipe
949
950 =item *
951
952 I<You MUST SKIP this step for RC, BLEAD>
953
954 Copy the perlNNNdelta.pod for this release into the other branches; for
955 example:
956
957     $ cp -i ../5.10.x/pod/perl5101delta.pod pod/    # for example
958     $ git add pod/perl5101delta.pod
959
960 Edit F<pod.lst> to add an entry for the file, e.g.:
961
962     perl5101delta               Perl changes in version 5.10.1
963
964 Then rebuild various files:
965
966     $ perl pod/buildtoc --build-all
967
968 Finally, commit:
969
970     $ git commit -a -m 'add perlXXXdelta'
971
972 =item *
973
974 Make sure any recent F<pod/perlhist.pod> entries are copied to
975 F<perlhist.pod> on other branches; typically the RC* and final entries,
976 e.g.
977
978           5.8.9-RC1     2008-Nov-10
979           5.8.9-RC2     2008-Dec-06
980           5.8.9         2008-Dec-14
981
982 =item *
983
984 I<You MUST RETIRE to your preferred PUB, CAFE or SEASIDE VILLA for some
985 much-needed rest and relaxation>.
986
987 Thanks for releasing perl!
988
989 =back
990
991 =head1 SOURCE
992
993 Based on
994 http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2009-05/msg00608.html,
995 plus a whole bunch of other sources, including private correspondence.
996
997 =cut
998