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