This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
few rmg nits
[perl5.git] / Porting / release_managers_guide.pod
1 =encoding utf8
2
3 =head1 NAME
4
5 release_managers_guide - Releasing a new version of perl 5.x
6
7 Note that things change at each release, so there may be new things not
8 covered here, or tools may need updating.
9
10 =head1 MAKING A CHECKLIST
11
12 If you are preparing to do a release, you can run the
13 F<Porting/make-rmg-checklist> script to generate a new version of this
14 document that starts with a checklist for your release.
15
16 This script is run as:
17
18   perl Porting/make-rmg-checklist \
19       --type [BLEAD-POINT or MAINT or ...] > /tmp/rmg.pod
20
21 You can also pass the C<--html> flag to generate an HTML document instead of
22 POD.
23
24   perl Porting/make-rmg-checklist --html \
25       --type [BLEAD-POINT or MAINT or ...] > /tmp/rmg.html
26
27 =head1 SYNOPSIS
28
29 This document describes the series of tasks required - some automatic, some
30 manual - to produce a perl release of some description, be that a release
31 candidate, or final, numbered release of maint or blead.
32
33 The release process has traditionally been executed by the current
34 pumpking. Blead releases from 5.11.0 forward are made each month on the
35 20th by a non-pumpking release engineer.  The release engineer roster
36 and schedule can be found in Porting/release_schedule.pod.
37
38 This document both helps as a check-list for the release engineer 
39 and is a base for ideas on how the various tasks could be automated 
40 or distributed.
41
42 The checklist of a typical release cycle is as follows:
43
44     (5.10.1 is released, and post-release actions have been done)
45
46     ...time passes...
47
48     a few weeks before the release, a number of steps are performed,
49         including bumping the version to 5.10.2
50
51     ...a few weeks passes...
52
53     perl-5.10.2-RC1 is released
54
55     perl-5.10.2 is released
56
57     post-release actions are performed, including creating new
58         perldelta.pod
59
60     ... the cycle continues ...
61
62
63 =head1 DETAILS
64
65 Some of the tasks described below apply to all four types of
66 release of Perl. (blead, RC, final release of maint, final
67 release of blead). Some of these tasks apply only to a subset
68 of these release types.  If a step does not apply to a given 
69 type of release, you will see a notation to that effect at
70 the beginning of the step.
71
72
73 =head2 Release types
74
75 =over 4
76
77 =item Release Candidate (RC)
78
79 A release candidate is an attempt to produce a tarball that is a close as
80 possible to the final release. Indeed, unless critical faults are found
81 during the RC testing, the final release will be identical to the RC
82 barring a few minor fixups (updating the release date in F<perlhist.pod>,
83 removing the RC status from F<patchlevel.h>, etc). If faults are found,
84 then the fixes should be put into a new release candidate, never directly
85 into a final release.
86
87
88 =item Stable/Maint release (MAINT).
89
90 A release with an even version number, and subversion number > 0, such as
91 5.14.1 or 5.14.2.
92
93 At this point you should have a working release candidate with few or no
94 changes since.
95
96 It's essentially the same procedure as for making a release candidate, but
97 with a whole bunch of extra post-release steps.
98
99 =item A blead point release (BLEAD-POINT)
100
101 A release with an odd version number, such as 5.15.0 or 5.15.1.
102
103 This isn't for production, so it has less stability requirements than for
104 other release types, and isn't preceded by RC releases. Other than that,
105 it is similar to a MAINT release.
106
107 =item Blead final release (BLEAD-FINAL)
108
109 A release with an even version number, and subversion number == 0, such as
110 5.14.0. That is to say, it's the big new release once per year.
111
112 It's essentially the same procedure as for making a release candidate, but
113 with a whole bunch of extra post-release steps, even more than for MAINT.
114
115 =back
116
117 =for checklist begin
118
119 =head2 Prerequisites
120
121 Before you can make an official release of perl, there are a few
122 hoops you need to jump through:
123
124 =head3 PAUSE account with pumpkin status
125
126 Make sure you have a PAUSE account suitable for uploading a perl release.
127 If you don't have a PAUSE account, then request one:
128
129     https://pause.perl.org/pause/query?ACTION=request_id
130
131 Check that your account is allowed to upload perl distros: go to
132 L<https://pause.perl.org/pause/authenquery?ACTION=who_pumpkin> and check that
133 your PAUSE ID is listed there.  If not, ask Andreas KE<0xf6>nig to add your ID
134 to the list of people allowed to upload something called perl.  You can find
135 Andreas' email address at:
136
137     https://pause.perl.org/pause/query?ACTION=pause_04imprint
138
139 =head3 search.cpan.org pumpkin status
140
141 Make sure that search.cpan.org knows that you're allowed to upload
142 perl distros. Contact Graham Barr to make sure that you're on the right
143 list.
144
145 =head3 rt.perl.org update access
146
147 Make sure you have permission to close tickets on L<http://rt.perl.org/>
148 so you can respond to bug report as necessary during your stint.  If you
149 don't, make an account (if you don't have one) and contact the pumpking
150 with your username to get ticket-closing permission.
151
152 =head3 git checkout and commit bit
153
154 You will need a working C<git> installation, checkout of the perl
155 git repository and perl commit bit.  For information about working
156 with perl and git, see F<pod/perlgit.pod>.
157
158 If you are not yet a perl committer, you won't be able to make a
159 release.  Have a chat with whichever evil perl porter tried to talk
160 you into the idea in the first place to figure out the best way to
161 resolve the issue.
162
163 =head3 git clone of https://github.com/perlorg/perlweb
164
165 For updating the L<http://dev.perl.org> web pages, either a Github account or
166 sweet-talking somebody with a Github account into obedience is needed. This
167 is only needed on the day of the release or shortly afterwards.
168
169 =for checklist skip RC
170
171 =head3 Quotation for release announcement epigraph
172
173 I<SKIP this step for RC>
174
175 For all except an RC release of perl, you will need a quotation
176 to use as an epigraph to your release announcement.
177
178 =head2 Building a release - advance actions
179
180 The work of building a release candidate for an even numbered release
181 (BLEAD-FINAL) of perl generally starts several weeks before the first
182 release candidate.  Some of the following steps should be done regularly,
183 but all I<must> be done in the run up to a release.
184
185 =head3 dual-life CPAN module synchronisation
186
187 To see which core distro versions differ from the current CPAN versions:
188
189     $ ./perl -Ilib Porting/core-cpan-diff -x -a
190
191 Passing C<-u cpan> (and maybe C<-u undef>) will probably be helpful, since
192 those are the only types of distributions that you can actually affect as a
193 perl release manager (as opposed to a CPAN module maintainer).
194
195 You can also run an actual diff of the contents of the modules, comparing core
196 to CPAN, to ensure that there were no erroneous/extraneous changes that need to
197 be dealt with. You do this by not passing the C<-x> option:
198
199     $ ./perl -Ilib Porting/core-cpan-diff -a -o /tmp/corediffs
200
201 then fix the core, or cajole CPAN authors as appropriate. See also the C<-d>
202 and C<-v> options for more detail (and the C<-u> option as mentioned above).
203 You'll probably want to use the C<-c cachedir> option to avoid repeated CPAN
204 downloads and may want to use C<-m file:///mirror/path> if you made a local
205 CPAN mirror. Note that a minicpan mirror won't actually work, but can provide a
206 good first pass to quickly get a list of modules which definitely haven't
207 changed, to avoid having to download absolutely everything.
208
209 If you are making a MAINT release, run C<core-cpan-diff> on both blead and
210 maint, then diff the two outputs. Compare this with what you expect, and if
211 necessary, fix things up. For example, you might think that both blead
212 and maint are synchronised with a particular CPAN module, but one might
213 have some extra changes. 
214
215 =head3 How to sync a CPAN module with a cpan/ distro
216
217 =over 4
218
219 =item *
220
221 Fetch the most recent version from CPAN.
222
223 =item *
224
225 Unpack the retrieved tarball. Rename the old directory; rename the new
226 directory to the original name.
227
228 =item *
229
230 Restore any F<.gitignore> file. This can be done by issuing
231 C<git checkout .gitignore> in the F<cpan/Distro> directory.
232
233 =item *
234
235 Remove files we do not need. That is, remove any files that match the
236 entries in C<@IGNORE> in F<Porting/Maintainer.pl>, and anything that 
237 matches the C<EXCLUDED> section of the distro's entry in the C<%Modules>
238 hash.
239
240 =item *
241
242 Restore any files mentioned in the C<CUSTOMIZED> section, using
243 C<git checkout>. Make any new customizations if necessary. Also,
244 restore any files that are mentioned in C<@IGNORE>, but were checked
245 in in the repository anyway.
246
247 =item *
248
249 For any new files in the distro, determine whether they are needed.
250 If not, delete them, and list them in either C<EXCLUDED> or C<@INGORE>.
251 Otherwise, add them to C<MANIFEST>, and run C<git add> to add the files
252 to the repository.
253
254 =item *
255
256 For any files that are gone, remove them from C<MANIFEST>, and use
257 C<git rm> to tell git the files will be gone.
258
259 =item *
260
261 If the C<MANIFEST> file was changed in any of the previous steps, run
262 C<perl Porting/manisort --output MANIFEST.sort; mv MANIFEST.sort MANIFEST>.
263
264 =item *
265
266 For any files that have an execute bit set, either remove the execute
267 bit, or edit F<Porting/exec-bit.txt>
268
269 =item *
270
271 Run C<make>, see if C<perl> compiles.
272
273 =item *
274
275 Run the tests for the package.
276
277 =item *
278
279 Run the tests in F<t/porting>.
280
281 =item *
282
283 Update the C<DISTRIBUTION> entry in F<Porting/Maintainers.pl>.
284
285 =item *
286
287 Run a full configure/build/test cycle.
288
289 =item *
290
291 If everything is ok, commit the changes.
292
293 =back
294
295 For entries with a non-simple C<FILES> section, or with a C<MAP>, you
296 may have to take more steps than listed above.
297
298 F<Porting/sync-with-cpan> is a script that automates most of the steps
299 above; but see the comments at the beginning of the file.
300
301
302 =head3 dual-life CPAN module stability
303
304 Ensure dual-life CPAN modules are stable, which comes down to:
305
306     for each module that fails its regression tests on $current
307         did it fail identically on $previous?
308         if yes, "SEP" (Somebody Else's Problem)
309         else work out why it failed (a bisect is useful for this)
310
311     attempt to group failure causes
312
313     for each failure cause
314         is that a regression?
315         if yes, figure out how to fix it
316             (more code? revert the code that broke it)
317         else
318             (presumably) it's relying on something un-or-under-documented
319             should the existing behaviour stay?
320                 yes - goto "regression"
321                 no - note it in perldelta as a significant bugfix
322                 (also, try to inform the module's author)
323
324
325 =head3 monitor smoke tests for failures
326
327 Similarly, monitor the smoking of core tests, and try to fix.  See
328 L<http://doc.procura.nl/smoke/index.html> for a summary. See also
329 L<http://www.nntp.perl.org/group/perl.daily-build.reports/> which has
330 the raw reports.
331
332 Similarly, monitor the smoking of perl for compiler warnings, and try to
333 fix.
334
335
336 =head3 update perldelta
337
338 Get perldelta in a mostly finished state.
339
340 Read  F<Porting/how_to_write_a_perldelta.pod>, and try to make sure that
341 every section it lists is, if necessary, populated and complete. Copy
342 edit the whole document.
343
344
345 =head3 Bump the version number
346
347 Increase the version number (e.g. from 5.12.0 to 5.12.1).
348
349 For a BLEAD-POINT release, this can happen on the day of the release.  For a
350 release candidate for a stable perl, this should happen a week or two
351 before the first release candidate to allow sufficient time for testing and
352 smoking with the target version built into the perl executable. For
353 subsequent release candidates and the final release, it it not necessary to
354 bump the version further.
355
356 There is a tool to semi-automate this process:
357
358      $ ./perl -Ilib Porting/bump-perl-version -i 5.10.0 5.10.1
359
360 Remember that this tool is largely just grepping for '5.10.0' or whatever,
361 so it will generate false positives. Be careful not change text like
362 "this was fixed in 5.10.0"!
363
364 Use git status and git diff to select changes you want to keep.
365
366 Be particularly careful with F<INSTALL>, which contains a mixture of
367 C<5.10.0>-type strings, some of which need bumping on every release, and
368 some of which need to be left unchanged.
369 The line in F<INSTALL> about "is binary incompatible with" requires a
370 correct choice of earlier version to declare incompatibility with.
371
372 When doing a BLEAD-POINT or BLEAD-FINAL release, also make sure the
373 C<PERL_API_*> constants in F<patchlevel.h> are in sync with the version
374 you're releasing, unless you're
375 absolutely sure the release you're about to make is 100% binary compatible
376 to an earlier release. When releasing a MAINT perl version, the C<PERL_API_*>
377 constants C<MUST NOT> be changed as we aim to guarantee binary compatibility
378 in maint branches.
379
380 After editing, regenerate uconfig.h (this must be run on a system with a
381 /bin/sh available):
382
383     $ perl regen/uconfig_h.pl
384
385 This might not cause any new changes.
386
387 Test your changes:
388
389     $ git clean -xdf   # careful if you don't have local files to keep!
390     $ ./Configure -des -Dusedevel
391     $ make
392     $ make test
393
394 Commit your changes:
395
396     $ git status
397     $ git diff
398     B<review the delta carefully>
399
400     $ git commit -a -m 'Bump the perl version in various places for 5.x.y'
401
402 At this point you may want to compare the commit with a previous bump to
403 see if they look similar.  See commit 8891dd8d for an example of a
404 previous version bump.
405
406 When the version number is bumped, you should also update Module::CoreList
407 (as described below in L<"update Module::CoreList">) to reflect the new
408 version number.
409
410
411 =head3 update INSTALL
412
413 Review and update INSTALL to account for the change in version number;
414 in particular, the "Coexistence with earlier versions of perl 5" section.
415
416 Be particularly careful with the section "Upgrading from 5.X.Y or earlier".
417 The "X.Y" needs to be changed to the most recent version that we are
418 I<not> binary compatible with.
419
420 For MAINT and BLEAD-FINAL releases, this needs to refer to the last
421 release in the previous development cycle (so for example, for a 5.14.x
422 release, this would be 5.13.11).
423
424 For BLEAD-POINT releases, it needs to refer to the previous BLEAD-POINT
425 release (so for 5.15.3 this would be 5.15.2).
426
427 =head3 Check more build configurations
428
429 Check some more build configurations.
430
431     $ sh Configure -Dprefix=/tmp/perl-5.x.y  -Uinstallusrbinperl \
432         -Duseshrplib -Dusesitecustomize
433     $ make
434     $ make test
435
436 XXX think of other configurations that need testing.
437
438
439 =head3 update perlport
440
441 L<perlport> has a section currently named I<Supported Platforms> that
442 indicates which platforms are known to build in the current release.
443 If necessary update the list and the indicated version number.
444
445
446
447 =head2 Building a release - on the day
448
449 This section describes the actions required to make a release
450 that are performed on the actual day.
451
452
453 =head3 re-check earlier actions
454
455 Review all the actions in the previous section,
456 L<"Building a release - advance actions"> to ensure they are all done and
457 up-to-date.
458
459
460 =head3 bump version number
461
462 For a BLEAD-POINT release, if you did not bump the perl version number as
463 part of I<advance actions>, do that now.
464
465
466 =head3 finalize perldelta
467
468 Finalize the perldelta.  In particular, fill in the Acknowledgements
469 section, which can be generated with something like:
470
471   $ perl Porting/acknowledgements.pl v5.15.0..HEAD
472
473 Re-read the perldelta to try to find any embarrassing typos and thinkos;
474 remove any C<TODO> or C<XXX> flags; update the "Known Problems" section
475 with any serious issues for which fixes are not going to happen now; and
476 run through pod and spell checkers, e.g.
477
478     $ podchecker -warnings -warnings pod/perldelta.pod
479     $ spell pod/perldelta.pod
480
481 Also, you may want to generate and view an HTML version of it to check
482 formatting, e.g.
483
484     $ ./perl -Ilib ext/Pod-Html/bin/pod2html pod/perldelta.pod > /tmp/perldelta.html
485
486 Another good HTML preview option is http://search.cpan.org/pod2html
487
488 If you make changes, be sure to commit them.
489
490 =for checklist skip BLEAD-POINT MAINT RC
491
492 =head3 remove stale perldeltas
493
494 For the first RC release that is ONLY for a BLEAD-FINAL, the perldeltas
495 from the BLEAD-POINT releases since the previous BLEAD_FINAL should have
496 now been consolidated into the current perldelta, and hence are now just
497 useless clutter.  They can be removed using:
498
499     $ git rm <file1> <file2> ...
500
501 For example, for RC0 of 5.16.0:
502
503     $ cd pod
504     $ git rm perldelta515*.pod
505
506 All mention to them should also be removed.  Edit F<pod/perl.pod> to remove
507 them from its table of contents, then run F<Porting/pod_rules.pl> to
508 propagate your changes there into all the other files that mention them
509 (including F<MANIFEST>). You'll need to C<git add> the files that it changes.
510
511 Then build a clean perl and do a full test
512
513     $ git status
514     $ git clean -dxf
515     $ ./Configure -Dusedevel -des
516     $ make
517     $ make test
518
519 Once all tests pass, commit your changes.
520
521 =head3 build a clean perl
522
523 If you skipped the previous step (removing the stale perldeltas)
524 make sure you have a gitwise-clean perl directory (no modified files,
525 unpushed commits etc):
526
527     $ git status
528     $ git clean -dxf
529
530 then configure and build perl so that you have a Makefile and porting tools:
531
532     $ ./Configure -Dusedevel -des && make
533
534 =head3 update Module::CoreList
535
536 Update C<Module::CoreList> with module version data for the new release.
537
538 Note that if this is a MAINT release, you should run the following actions
539 from the maint branch, but commit the C<CoreList.pm> changes in
540 I<blead> and subsequently cherry-pick any releases since the last
541 maint release and then your recent commit.  XXX need a better example
542
543 F<corelist.pl> uses ftp.funet.fi to verify information about dual-lived
544 modules on CPAN. It can use a full, local CPAN mirror or fall back
545 to C<wget> or C<curl> to fetch only package metadata remotely. (If you're
546 on Win32, then installing Cygwin is one way to have commands like C<wget>
547 and C<curl> available.)
548
549 (If you'd prefer to have a full CPAN mirror, see 
550 http://www.cpan.org/misc/cpan-faq.html#How_mirror_CPAN)
551
552 Then change to your perl checkout, and if necessary,
553
554     $ make
555
556 If this is not the first update for this version (e.g. if it was updated
557 when the version number was originally bumped), first edit
558 F<dist/Module-CoreList/lib/Module/CoreList.pm> to delete the existing
559 entries for this version from the C<%released> and C<%version> hashes:
560 they will have a key like C<5.010001> for 5.10.1.
561
562 XXX the edit-in-place functionality of Porting/corelist.pl should
563 be fixed to handle this automatically.
564
565 Then, If you have a local CPAN mirror, run:
566
567     $ ./perl -Ilib Porting/corelist.pl ~/my-cpan-mirror
568
569 Otherwise, run:
570
571     $ ./perl -Ilib Porting/corelist.pl cpan
572
573 This will chug for a while, possibly reporting various warnings about
574 badly-indexed CPAN modules unrelated to the modules actually in core.
575 Assuming all goes well, it will update
576 F<dist/Module-CoreList/lib/Module/CoreList.pm>.
577
578 Check that file over carefully:
579
580     $ git diff dist/Module-CoreList/lib/Module/CoreList.pm
581
582 If this is a .0 Perl version, add the appropriate lines in F<Corelist.pm>
583 to alias "5.nnn000" to "5.nnn" in each hash.  (If feeling energetic,
584 amend F<corelist.pl> to automate this.)
585
586 =head4 Bump C<$Module::CoreList::VERSION>
587
588 If necessary, bump C<$Module::CoreList::VERSION> (there's no need to do this for
589 every RC; in RC1, bump the version to a new clean number that will
590 appear in the final release, and leave as-is for the later RCs and final).
591 It may also happen that C<Module::CoreList> has been modified in blead, and
592 hence has a new version number already.  (But make sure it is not the same
593 number as a CPAN release.)
594
595 Edit the version number in the new C<< 'Module::CoreList' => 'X.YZ' >>
596 entry, as that is likely to reflect the previous version number.
597
598 =head4 Bump version in Module::CoreList F<Changes>
599
600 Also edit Module::CoreList's new version number in its F<Changes>
601 file.
602
603 =head4 Add Module::CoreList version bump to perldelta
604
605 Add a perldelta entry for the new Module::CoreList version.
606
607 =for checklist skip RC
608
609 =head4 Update C<%Module::CoreList::released> and C<CAVEATS>
610
611 In addition, if this is a final release (rather than a release candidate):
612
613 =over 4 
614
615 =item *
616
617 Update this version's entry in the C<%released> hash with today's date.
618
619 =item *
620
621 Make sure that the script has correctly updated the C<CAVEATS> section
622 (Note, the C<CAVEATS> section is in
623 F<dist/Module-CoreList/lib/Module/CoreList.pod>)
624
625 =back
626
627 =head4 Commit Module::CoreList changes
628
629 Finally, commit the new version of Module::CoreList:
630 (unless this is for MAINT; in which case commit it to blead first, then
631 cherry-pick it back).
632
633     $ git commit -m 'Update Module::CoreList for 5.x.y' dist/Module-CoreList/lib/Module/CoreList.pm dist/Module-CoreList/lib/Module/CoreList.pod
634
635 =for checklist skip RC
636
637 =head3 update perlhist.pod
638
639 I<You MUST SKIP this step for a RC release>
640
641 Add an entry to F<pod/perlhist.pod> with the release date, e.g.:
642
643     David    5.10.1       2009-Aug-06
644
645 Make sure that the correct pumpking is listed in the left-hand column, and
646 if this is the first release under the stewardship of a new pumpking, make
647 sure that his or her name is listed in the section entitled
648 C<THE KEEPERS OF THE PUMPKIN>.
649
650 Be sure to commit your changes:
651
652     $ git commit -m 'add new release to perlhist' pod/perlhist.pod
653
654 =for checklist skip BLEAD-POINT
655
656 =head3 update patchlevel.h
657
658 I<You MUST SKIP this step for a BLEAD-POINT release>
659
660 Update F<patchlevel.h> to add a C<-RC1>-or-whatever string; or, if this is
661 a final release, remove it. For example:
662
663      static const char * const local_patches[] = {
664              NULL
665     +        ,"RC1"
666              PERL_GIT_UNPUSHED_COMMITS /* do not remove this line */
667
668 Be sure to commit your change:
669
670     $ git commit -m 'bump version to RCnnn' patchlevel.h
671
672
673 =head3 build, test and check a fresh perl
674
675 Build perl, then make sure it passes its own test suite, and installs:
676
677     $ git clean -xdf
678     $ ./Configure -des -Dprefix=/tmp/perl-5.x.y-pretest
679
680     # or if it's an odd-numbered version:
681     $ ./Configure -des -Dusedevel -Dprefix=/tmp/perl-5.x.y-pretest
682
683     $ make test install
684
685 Check that the output of C</tmp/perl-5.x.y-pretest/bin/perl -v> and
686 C</tmp/perl-5.x.y-pretest/bin/perl -V> are as expected,
687 especially as regards version numbers, patch and/or RC levels, and @INC
688 paths. Note that as they have been been built from a git working
689 directory, they will still identify themselves using git tags and
690 commits. (Note that for an odd-numbered version, perl will install
691 itself as C<perl5.x.y>). C<perl -v> will identify itself as:
692
693  This is perl 5, version X, subversion Y (v5.X.Y (v5.X.Z-NNN-gdeadbeef))
694
695 where 5.X.Z is the latest tag, NNN the number of commits since this tag,
696 and C<< deadbeef >> commit of that tag.
697
698 Then delete the temporary installation.
699
700
701 =head3 push the work so far
702
703 Push all your recent commits:
704
705     $ git push origin ....
706
707
708 =head3 tag the release
709
710 Tag the release (e.g.):
711
712     $ git tag v5.11.0 -m "First release of the v5.11 series!"
713
714 It is B<VERY> important that from this point forward, you not push
715 your git changes to the Perl master repository.  If anything goes
716 wrong before you publish your newly-created tag, you can delete
717 and recreate it.  Once you push your tag, we're stuck with it
718 and you'll need to use a new version number for your release.
719
720
721 =head3 build the tarball
722
723 Before you run the following, you might want to install 7-Zip (the
724 C<p7zip-full> package under Debian or the C<p7zip> port on MacPorts) or
725 the AdvanceCOMP suite (e.g. the C<advancecomp> package under Debian,
726 or the C<advancecomp> port on macports - 7-Zip on Windows is the
727 same code as AdvanceCOMP, so Windows users get the smallest files
728 first time). These compress about 5% smaller than gzip and bzip2.
729 Over the lifetime of your distribution this will save a lot of
730 people a small amount of download time and disk space, which adds
731 up.
732
733 Create a tarball. Use the C<-s> option to specify a suitable suffix for
734 the tarball and directory name:
735
736     $ cd root/of/perl/tree
737     $ make distclean
738     $ git clean -xdf            # make sure perl and git agree on files
739     $ git status                # and there's nothing lying around
740
741     $ perl Porting/makerel -b -s RC1            # for a release candidate
742     $ perl Porting/makerel -b                   # for a final release
743
744 This creates the  directory F<../perl-x.y.z-RC1> or similar, copies all
745 the MANIFEST files into it, sets the correct permissions on them,
746 adds DOS line endings to some, then tars it up as
747 F<../perl-x.y.z-RC1.tar.gz>. With C<-b>, it also creates a C<tar.bz2> file.
748
749 If you're getting your tarball suffixed with -uncommitted and you're sure
750 your changes were all committed, you can override the suffix with:
751
752     $ perl Porting/makerel -b -s ''
753
754 XXX if we go for extra tags and branches stuff, then add the extra details
755 here
756
757 Finally, clean up the temporary directory, e.g.
758
759     $ rm -rf ../perl-x.y.z-RC1
760
761
762 =head3 test the tarball
763
764 Once you have a tarball it's time to test the tarball (not the repository).
765
766 =head4 Copy the tarball to a web server
767
768 Copy the tarballs (.gz and possibly .bz2) to a web server somewhere you
769 have access to.
770
771 =head4 Download the tarball to another machine
772
773 Download the tarball to some other machine. For a release candidate, 
774 you really want to test your tarball on two or more different platforms
775 and architectures. The #p5p IRC channel on irc.perl.org is a good place
776 to find willing victims.
777
778 =head4 Check that F<Configure> works
779
780 Check that basic configuration and tests work on each test machine:
781
782     $ ./Configure -des && make all test
783
784 =head4 Run the test harness and install
785
786 Check that the test harness and install work on each test machine:
787
788     $ make distclean
789     $ ./Configure -des -Dprefix=/install/path && make all test_harness install
790     $ cd /install/path
791
792 =head4 Check C<perl -v> and C<perl -V>
793
794 Check that the output of C<perl -v> and C<perl -V> are as expected,
795 especially as regards version numbers, patch and/or RC levels, and @INC
796 paths. 
797
798 Note that the results may be different without a F<.git/> directory,
799 which is why you should test from the tarball.
800
801 =head4 Run the Installation Verification Procedure utility
802
803     $ ./perl utils/perlivp
804     ...
805     All tests successful.
806     $
807
808 =head4 Compare the installed paths to the last release
809
810 Compare the pathnames of all installed files with those of the previous
811 release (i.e. against the last installed tarball on this branch which you
812 have previously verified using this same procedure). In particular, look
813 for files in the wrong place, or files no longer included which should be.
814 For example, suppose the about-to-be-released version is 5.10.1 and the
815 previous is 5.10.0:
816
817     cd installdir-5.10.0/
818     find . -type f | perl -pe's/5\.10\.0/5.10.1/g' | sort > /tmp/f1
819     cd installdir-5.10.1/
820     find . -type f | sort > /tmp/f2
821     diff -u /tmp/f[12]
822
823 =head4 Test the CPAN client
824
825 Bootstrap the CPAN client on the clean install:
826
827     $ bin/perl -MCPAN -e "shell"
828
829 If you're running this on Win32 you probably also need a set of Unix
830 command-line tools available for CPAN to function correctly without
831 Perl alternatives like LWP installed. Cygwin is an obvious choice.)
832
833 =head4 Install the Inline module and test it
834
835 Try installing a popular CPAN module that's reasonably complex and that
836 has dependencies; for example:
837
838     CPAN> install Inline
839     CPAN> quit
840
841 Check that your perl can run this:
842
843     $ bin/perl -lwe "use Inline C => q[int f() { return 42;}]; print f"
844     42
845     $
846
847 =head4 Bootstrap the CPANPLUS client
848
849 Bootstrap the CPANPLUS client on the clean install:
850
851     $ bin/cpanp
852
853 (Again, on Win32 you'll need something like Cygwin installed, but make sure
854 that you don't end up with its various F<bin/cpan*> programs being found on
855 the PATH before those of the Perl that you're trying to test.)
856
857 =head4 Install the DBI module with CPANPLUS
858
859     CPAN Terminal> i DBI
860     CPAN Terminal> quit
861     $ bin/perl -MDBI -e 1
862     $
863
864 =head4 Make sure that perlbug works
865
866 Test L<perlbug> with the following:
867
868     $ bin/perlbug
869     ...
870     Subject: test bug report
871     Local perl administrator [yourself]: 
872     Editor [vi]: 
873     Module: 
874     Category [core]: 
875     Severity [low]: 
876     (edit report)
877     Action (Send/Display/Edit/Subject/Save to File): f
878     Name of file to save message in [perlbug.rep]: 
879     Action (Send/Display/Edit/Subject/Save to File): q
880
881 and carefully examine the output (in F<perlbug.rep]>), especially
882 the "Locally applied patches" section. If everything appears okay, then
883 delete the file, and try it again, this time actually submitting the bug
884 report. Check that it shows up, then remember to close it!
885
886 =for checklist skip BLEAD-POINT
887
888 =head3 monitor smokes
889
890 Wait for the smoke tests to catch up with the commit which this release is
891 based on (or at least the last commit of any consequence).
892
893 Then check that the smoke tests pass (particularly on Win32). If not, go
894 back and fix things.
895
896 Note that for I<BLEAD-POINT> releases this may not be practical. It takes a
897 long time for the smokers to catch up, especially the Win32
898 smokers. This is why we have a RC cycle for I<MAINT> and I<BLEAD-FINAL>
899 releases, but for I<BLEAD-POINT> releases sometimes the best you can do is
900 to plead with people on IRC to test stuff on their platforms, fire away,
901 and then hope for the best.
902
903
904 =head3 upload to PAUSE
905
906 Once smoking is okay, upload it to PAUSE. This is the point of no return.
907 If anything goes wrong after this point, you will need to re-prepare
908 a new release with a new minor version or RC number.
909
910     https://pause.perl.org/
911
912 (Login, then select 'Upload a file to CPAN')
913
914 If your workstation is not connected to a high-bandwidth,
915 high-reliability connection to the Internet, you should probably use the
916 "GET URL" feature (rather than "HTTP UPLOAD") to have PAUSE retrieve the
917 new release from wherever you put it for testers to find it.  This will
918 eliminate anxious gnashing of teeth while you wait to see if your
919 15 megabyte HTTP upload successfully completes across your slow, twitchy
920 cable modem.  You can make use of your home directory on dromedary for
921 this purpose: F<http://users.perl5.git.perl.org/~USERNAME> maps to
922 F</home/USERNAME/public_html>, where F<USERNAME> is your login account
923 on dromedary.  I<Remember>: if your upload is partially successful, you
924 may need to contact a PAUSE administrator or even bump the version of perl.
925
926 Upload both the .gz and .bz2 versions of the tarball.
927
928 Do not proceed any further until you are sure that your tarballs are on
929 CPAN.  Check your authors directory on one of the "fast" CPAN mirrors
930 (e.g., cpan.hexten.net
931 or cpan.cpantesters.org) to confirm that your uploads have been successful.
932
933 =for checklist skip RC
934
935 =head3 wait for indexing
936
937 I<You MUST SKIP this step for RC>
938
939 Wait until you receive notification emails from the PAUSE indexer
940 confirming that your uploads have been received.  IMPORTANT -- you will
941 probably get an email that indexing has failed, due to module permissions.
942 This is considered normal.
943
944
945 =head3 publish tag
946
947 Now that you've shipped the new perl release to PAUSE, it's
948 time to publish the tag you created earlier to the public git repo (e.g.):
949
950     $ git push origin tag v5.11.0
951
952 =for checklist skip BLEAD-POINT
953
954 =head3 disarm patchlevel.h
955
956 I<You MUST SKIP this step for BLEAD-POINT release>
957
958 Disarm the F<patchlevel.h> change; for example,
959
960      static const char * const local_patches[] = {
961              NULL
962     -        ,"RC1"
963              PERL_GIT_UNPUSHED_COMMITS /* do not remove this line */
964
965 Be sure to commit your change:
966
967     $ git commit -m 'disarm RCnnn bump' patchlevel.h
968     $ git push origin ....
969
970
971
972 =head3 announce to p5p
973
974 Mail p5p to announce your new release, with a quote you prepared earlier.
975
976 Use the template at Porting/release_announcement_template.txt
977
978 Send a carbon copy to C<noc@metacpan.org>
979
980 =head3 update epigraphs.pod
981
982 Add your quote to F<Porting/epigraphs.pod> and commit it.
983 Your release announcement will probably not have reached the web-visible
984 archives yet, so you won't be able to include the customary link to the
985 release announcement yet.
986
987 =head3 blog about your epigraph
988
989 If you have a blog, please consider writing an entry in your blog explaining
990 why you chose that particular quote for your epigraph.
991
992 =for checklist skip RC
993
994 =head3 Module::CoreList nagging
995
996 I<You MUST SKIP this step for RC>
997
998 Remind the current maintainer of C<Module::CoreList> to push a new release
999 to CPAN.
1000
1001 =for checklist skip RC
1002
1003 =head3 new perldelta
1004
1005 I<You MUST SKIP this step for RC>
1006
1007 Create a new perldelta.
1008
1009 =over 4
1010
1011 =item *
1012
1013 Confirm that you have a clean checkout with no local changes.
1014
1015 =item *
1016
1017 Run F<Porting/new-perldelta.pl>
1018
1019 =item *
1020
1021 Run the C<git add> commands it outputs to add new and modified files.
1022
1023 =item *
1024
1025 Verify that the build still works, by running C<./Configure> and
1026 C<make test_porting>. (On Win32, run C<nmake> and
1027 C<nmake test TEST_FILES="porting\*.t ..\lib\diagnostics.t">.)
1028
1029 =item *
1030
1031 If F<t/porting/podcheck.t> spots errors in the new F<pod/perldelta.pod>,
1032 run C<./perl -MTestInit t/porting/podcheck.t | less> for more detail.
1033 Skip to the end of its test output to see the options it offers you.
1034
1035 =item *
1036
1037 When C<make test_porting> passes, commit the new perldelta.
1038
1039 =back
1040
1041 At this point you may want to compare the commit with a previous bump to
1042 see if they look similar.  See commit e3c71926d3 for an example of a
1043 previous version bump.
1044
1045 =for checklist skip BLEAD-POINT MAINT RC
1046
1047 =head3 bump version
1048
1049 I<You MUST SKIP this step for RC, BLEAD-POINT, MAINT>
1050
1051 If this was a BLEAD-FINAL release (i.e. the first release of a new maint
1052 series, 5.x.0 where x is even), then bump the version in the blead branch
1053 in git, e.g. 5.12.0 to 5.13.0.
1054
1055 First, add a new feature bundle to F<regen/feature.pl>, initially by just
1056 copying the exiting entry, and bump the file's $VERSION (after the __END__
1057 marker); e.g.
1058
1059          "5.14" => [qw(switch say state unicode_strings)],
1060     +    "5.15" => [qw(switch say state unicode_strings)],
1061
1062 Run F<regen/feature.pl> to propagate the changes to F<lib/feature.pm>.
1063
1064 Then follow the section L<"Bump the version number"> to bump the version
1065 in the remaining files and test and commit.
1066
1067
1068 =head3 clean build and test
1069
1070 Run a clean build and test to make sure nothing obvious is broken.
1071
1072 In particular, F<Porting/perldelta_template.pod> is intentionally exempted
1073 from podchecker tests, to avoid false positives about placeholder text.
1074 However, once it's copied to F<pod/perldelta.pod> the contents can now
1075 cause test failures. Problems should resolved by doing one of the
1076 following:
1077
1078 =over
1079
1080 =item 1
1081
1082 Replace placeholder text with correct text.
1083
1084 =item 2
1085
1086 If the problem is from a broken placeholder link, you can add it to the
1087 array C<@perldelta_ignore_links> in F<t/porting/podcheck.t>.  Lines
1088 containing such links should be marked with C<XXX> so that they get
1089 cleaned up before the next release.
1090
1091 =item 3
1092
1093 Following the instructions output by F<t/porting/podcheck.t> on how to
1094 update its exceptions database.
1095
1096 =back
1097
1098 =head3 push commits
1099
1100 Finally, push any commits done above.
1101
1102     $ git push origin ....
1103
1104 =for checklist skip BLEAD-POINT MAINT RC
1105
1106 =head3 create maint branch
1107
1108 I<You MUST SKIP this step for RC, BLEAD-POINT, MAINT>
1109
1110 If this was a BLEAD-FINAL release (i.e. the first release of a new maint
1111 series, 5.x.0 where x is even), then create a new maint branch based on
1112 the commit tagged as the current release.
1113
1114 Assuming you're using git 1.7.x or newer:
1115
1116     $ git checkout -b maint-5.12 v5.12.0
1117     $ git push origin -u maint-5.12
1118
1119
1120 =for checklist skip BLEAD-POINT MAINT RC
1121
1122 =head3 make the maint branch available in the APC
1123
1124 Clone the new branch into /srv/gitcommon/branches on camel so the APC will
1125 receive its changes.
1126
1127     $ git clone --branch maint-5.14 /gitroot/perl.git \
1128     ?  /srv/gitcommon/branches/perl-5.14.x
1129     $ chmod -R g=u /srv/gitcommon/branches/perl-5.14.x
1130
1131 And nag the sysadmins to make this directory available via rsync.
1132
1133 =for checklist skip BLEAD-POINT RC
1134
1135 =head3 copy perldelta.pod to other branches
1136
1137 I<You MUST SKIP this step for RC, BLEAD-POINT>
1138
1139 Copy the perldelta.pod for this release into the other branches; for
1140 example:
1141
1142     $ cp -i ../5.10.x/pod/perldelta.pod pod/perl5101delta.pod    # for example
1143     $ git add pod/perl5101delta.pod
1144
1145 Edit F<pod/perl.pod> to add an entry for the file, e.g.:
1146
1147     perl5101delta               Perl changes in version 5.10.1
1148
1149 Then rebuild various files:
1150
1151     $ perl pod/buildtoc --build-all
1152
1153 Finally, commit:
1154
1155     $ git commit -a -m 'add perlXXXdelta'
1156
1157
1158 =head3 update perlhist.pod in other branches
1159
1160 Make sure any recent F<pod/perlhist.pod> entries are copied to
1161 F<perlhist.pod> on other branches
1162 e.g.
1163
1164           5.8.9         2008-Dec-14
1165
1166
1167 =head3 bump RT version number
1168
1169 Log into http://rt.perl.org/ and check whether the new version is in the RT
1170 fields C<Perl Version> and C<Fixed In>. The easiest way to determine this is
1171 to go to L<https://rt.perl.org/rt3/Search/Build.html> and click on the drop
1172 downs next to the C<Perl Version> and C<Fixed In> labels.
1173
1174 If the new version is not listed there, send an email to C<perlbug-admin at
1175 perl.org> requesting this.
1176
1177 =head3 Relax!
1178
1179 I<You MUST RETIRE to your preferred PUB, CAFE or SEASIDE VILLA for some
1180 much-needed rest and relaxation>.
1181
1182 Thanks for releasing perl!
1183
1184
1185 =head2 Building a release - the day after
1186
1187 =head3 link announcement in epigraphs.pod
1188
1189 Add, to your quote to F<Porting/epigraphs.pod>, a link to the release
1190 announcement in the web-visible mailing list archive.  Commit it.
1191
1192 =head3 check tarball availability
1193
1194 Check various website entries to make sure the that tarball has appeared
1195 and is properly indexed:
1196
1197 =over 4
1198
1199 =item *
1200
1201 Check your author directory under L<http://www.cpan.org/authors/id/>
1202 to ensure that the tarballs are available on the website.
1203
1204 =item *
1205
1206 Check C</src> on CPAN (on a fast mirror) to ensure that links to
1207 the new tarballs have appeared.  There should be links in C</src/5.0>
1208 (which is accumulating all new versions), links in C</src> (which shows
1209 only the latest version on each branch), and an appropriate mention in
1210 C</src/README.html> (which describes the latest versions).
1211
1212 These links should appear automatically, some hours after upload.
1213 If they don't, or the C<README.html> description is inadequate,
1214 ask Ask <ask@perl.org>.
1215
1216 =item *
1217
1218 Check L<http://www.cpan.org/src/> to ensure that the C</src> updates
1219 have been correctly mirrored to the website.
1220 If they haven't, ask Ask <ask@perl.org>.
1221
1222 =item *
1223
1224 Check L<http://search.cpan.org> to see if it has indexed the distribution.
1225 It should be visible at a URL like C<http://search.cpan.org/dist/perl-5.10.1/>.
1226
1227 =back
1228
1229 =for checklist skip RC
1230
1231 =head3 update dev.perl.org
1232
1233 I<You MUST SKIP this step for a RC release>
1234
1235 In your C<perlorg> repository, link to the new release.  For a new
1236 latest-maint release, edit F<docs/shared/tpl/stats.html>.  Otherwise,
1237 edit F<docs/dev/perl5/index.html>.
1238
1239 Then make a pull request to Leo Lapworth.  If this fails for some reason
1240 and you cannot cajole anybody else into submitting that change, you can
1241 mail Leo as last resort.
1242
1243 This repository can be found on L<github|https://github.com/perlorg/perlweb>.
1244
1245 =for checklist end
1246
1247 =head1 SOURCE
1248
1249 Based on
1250 http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2009-05/msg00608.html,
1251 plus a whole bunch of other sources, including private correspondence.
1252
1253 =cut
1254