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