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