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