This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
this is already mentioned at the end (and that is more correct)
[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 Test your changes:
386
387     $ git clean -xdf   # careful if you don't have local files to keep!
388     $ ./Configure -des -Dusedevel
389     $ make
390     $ make test
391
392 Commit your changes:
393
394     $ git status
395     $ git diff
396     B<review the delta carefully>
397
398     $ git commit -a -m 'Bump the perl version in various places for 5.x.y'
399
400 At this point you may want to compare the commit with a previous bump to
401 see if they look similar.  See commit 8891dd8d for an example of a
402 previous version bump.
403
404 When the version number is bumped, you should also update Module::CoreList
405 (as described below in L<"update Module::CoreList">) to reflect the new
406 version number.
407
408
409 =head3 update INSTALL
410
411 Review and update INSTALL to account for the change in version number;
412 in particular, the "Coexistence with earlier versions of perl 5" section.
413
414 Be particularly careful with the section "Upgrading from 5.X.Y or earlier".
415 The "X.Y" needs to be changed to the most recent version that we are
416 I<not> binary compatible with.
417
418 For MAINT and BLEAD-FINAL releases, this needs to refer to the last
419 release in the previous development cycle (so for example, for a 5.14.x
420 release, this would be 5.13.11).
421
422 For BLEAD-POINT releases, it needs to refer to the previous BLEAD-POINT
423 release (so for 5.15.3 this would be 5.15.2).
424
425 =head3 Check more build configurations
426
427 Check some more build configurations.
428
429     $ sh Configure -Dprefix=/tmp/perl-5.x.y  -Uinstallusrbinperl \
430         -Duseshrplib -Dusesitecustomize
431     $ make
432     $ make test
433
434 XXX think of other configurations that need testing.
435
436
437 =head3 update perlport
438
439 L<perlport> has a section currently named I<Supported Platforms> that
440 indicates which platforms are known to build in the current release.
441 If necessary update the list and the indicated version number.
442
443
444
445 =head2 Building a release - on the day
446
447 This section describes the actions required to make a release
448 that are performed on the actual day.
449
450
451 =head3 re-check earlier actions
452
453 Review all the actions in the previous section,
454 L<"Building a release - advance actions"> to ensure they are all done and
455 up-to-date.
456
457
458 =head3 bump version number
459
460 For a BLEAD-POINT release, if you did not bump the perl version number as
461 part of I<advance actions>, do that now.
462
463
464 =head3 finalize perldelta
465
466 Finalize the perldelta.  In particular, fill in the Acknowledgements
467 section, which can be generated with something like:
468
469   $ perl Porting/acknowledgements.pl v5.15.0..HEAD
470
471 Re-read the perldelta to try to find any embarrassing typos and thinkos;
472 remove any C<TODO> or C<XXX> flags; update the "Known Problems" section
473 with any serious issues for which fixes are not going to happen now; and
474 run through pod and spell checkers, e.g.
475
476     $ podchecker -warnings -warnings pod/perldelta.pod
477     $ spell pod/perldelta.pod
478
479 Also, you may want to generate and view an HTML version of it to check
480 formatting, e.g.
481
482     $ ./perl -Ilib ext/Pod-Html/bin/pod2html pod/perldelta.pod > /tmp/perldelta.html
483
484 Another good HTML preview option is http://search.cpan.org/pod2html
485
486 If you make changes, be sure to commit them.
487
488 =for checklist skip BLEAD-POINT MAINT RC
489
490 =head3 remove stale perldeltas
491
492 For the first RC release that is ONLY for a BLEAD-FINAL, the perldeltas
493 from the BLEAD-POINT releases since the previous BLEAD_FINAL should have
494 now been consolidated into the current perldelta, and hence are now just
495 useless clutter.  They can be removed using:
496
497     $ git rm <file1> <file2> ...
498
499 For example, for RC0 of 5.16.0:
500
501     $ cd pod
502     $ git rm perldelta515*.pod
503
504 All mention to them should also be removed.  Edit F<pod/perl.pod> to remove
505 them from its table of contents, then run F<Porting/pod_rules.pl> to
506 propagate your changes there into all the other files that mention them
507 (including F<MANIFEST>). You'll need to C<git add> the files that it changes.
508
509 Then build a clean perl and do a full test
510
511     $ git status
512     $ git clean -dxf
513     $ ./Configure -Dusedevel -des
514     $ make
515     $ make test
516
517 Once all tests pass, commit your changes.
518
519 =head3 build a clean perl
520
521 If you skipped the previous step (removing the stale perldeltas)
522 make sure you have a gitwise-clean perl directory (no modified files,
523 unpushed commits etc):
524
525     $ git status
526     $ git clean -dxf
527
528 then configure and build perl so that you have a Makefile and porting tools:
529
530     $ ./Configure -Dusedevel -des && make
531
532 =head3 update Module::CoreList
533
534 Update C<Module::CoreList> with module version data for the new release.
535
536 Note that if this is a MAINT release, you should run the following actions
537 from the maint branch, but commit the C<CoreList.pm> changes in
538 I<blead> and subsequently cherry-pick any releases since the last
539 maint release and then your recent commit.  XXX need a better example
540
541 F<corelist.pl> uses ftp.funet.fi to verify information about dual-lived
542 modules on CPAN. It can use a full, local CPAN mirror or fall back
543 to C<wget> or C<curl> to fetch only package metadata remotely. (If you're
544 on Win32, then installing Cygwin is one way to have commands like C<wget>
545 and C<curl> available.)
546
547 (If you'd prefer to have a full CPAN mirror, see 
548 http://www.cpan.org/misc/cpan-faq.html#How_mirror_CPAN)
549
550 Then change to your perl checkout, and if necessary,
551
552     $ make
553
554 If this is not the first update for this version (e.g. if it was updated
555 when the version number was originally bumped), first edit
556 F<dist/Module-CoreList/lib/Module/CoreList.pm> to delete the existing
557 entries for this version from the C<%released> and C<%version> hashes:
558 they will have a key like C<5.010001> for 5.10.1.
559
560 XXX the edit-in-place functionality of Porting/corelist.pl should
561 be fixed to handle this automatically.
562
563 Then, If you have a local CPAN mirror, run:
564
565     $ ./perl -Ilib Porting/corelist.pl ~/my-cpan-mirror
566
567 Otherwise, run:
568
569     $ ./perl -Ilib Porting/corelist.pl cpan
570
571 This will chug for a while, possibly reporting various warnings about
572 badly-indexed CPAN modules unrelated to the modules actually in core.
573 Assuming all goes well, it will update
574 F<dist/Module-CoreList/lib/Module/CoreList.pm>.
575
576 Check that file over carefully:
577
578     $ git diff dist/Module-CoreList/lib/Module/CoreList.pm
579
580 If this is a .0 Perl version, add the appropriate lines in F<Corelist.pm>
581 to alias "5.nnn000" to "5.nnn" in each hash.  (If feeling energetic,
582 amend F<corelist.pl> to automate this.)
583
584 =head4 Bump C<$Module::CoreList::VERSION>
585
586 If necessary, bump C<$Module::CoreList::VERSION> (there's no need to do this for
587 every RC; in RC1, bump the version to a new clean number that will
588 appear in the final release, and leave as-is for the later RCs and final).
589 It may also happen that C<Module::CoreList> has been modified in blead, and
590 hence has a new version number already.  (But make sure it is not the same
591 number as a CPAN release.)
592
593 Edit the version number in the new C<< 'Module::CoreList' => 'X.YZ' >>
594 entry, as that is likely to reflect the previous version number.
595
596 =head4 Bump version in Module::CoreList F<Changes>
597
598 Also edit Module::CoreList's new version number in its F<Changes>
599 file.
600
601 =head4 Add Module::CoreList version bump to perldelta
602
603 Add a perldelta entry for the new Module::CoreList version.
604
605 =for checklist skip RC
606
607 =head4 Update C<%Module::CoreList::released> and C<CAVEATS>
608
609 In addition, if this is a final release (rather than a release candidate):
610
611 =over 4 
612
613 =item *
614
615 Update this version's entry in the C<%released> hash with today's date.
616
617 =item *
618
619 Make sure that the script has correctly updated the C<CAVEATS> section
620 (Note, the C<CAVEATS> section is in
621 F<dist/Module-CoreList/lib/Module/CoreList.pod>)
622
623 =back
624
625 =head4 Commit Module::CoreList changes
626
627 Finally, commit the new version of Module::CoreList:
628 (unless this is for MAINT; in which case commit it to blead first, then
629 cherry-pick it back).
630
631     $ git commit -m 'Update Module::CoreList for 5.x.y' dist/Module-CoreList/lib/Module/CoreList.pm dist/Module-CoreList/lib/Module/CoreList.pod
632
633 =for checklist skip RC
634
635 =head3 update perlhist.pod
636
637 I<You MUST SKIP this step for a RC release>
638
639 Add an entry to F<pod/perlhist.pod> with the release date, e.g.:
640
641     David    5.10.1       2009-Aug-06
642
643 Make sure that the correct pumpking is listed in the left-hand column, and
644 if this is the first release under the stewardship of a new pumpking, make
645 sure that his or her name is listed in the section entitled
646 C<THE KEEPERS OF THE PUMPKIN>.
647
648 Be sure to commit your changes:
649
650     $ git commit -m 'add new release to perlhist' pod/perlhist.pod
651
652 =for checklist skip BLEAD-POINT
653
654 =head3 update patchlevel.h
655
656 I<You MUST SKIP this step for a BLEAD-POINT release>
657
658 Update F<patchlevel.h> to add a C<-RC1>-or-whatever string; or, if this is
659 a final release, remove it. For example:
660
661      static const char * const local_patches[] = {
662              NULL
663     +        ,"RC1"
664              PERL_GIT_UNPUSHED_COMMITS /* do not remove this line */
665
666 Be sure to commit your change:
667
668     $ git commit -m 'bump version to RCnnn' patchlevel.h
669
670
671 =head3 build, test and check a fresh perl
672
673 Build perl, then make sure it passes its own test suite, and installs:
674
675     $ git clean -xdf
676     $ ./Configure -des -Dprefix=/tmp/perl-5.x.y-pretest
677
678     # or if it's an odd-numbered version:
679     $ ./Configure -des -Dusedevel -Dprefix=/tmp/perl-5.x.y-pretest
680
681     $ make test install
682
683 Check that the output of C</tmp/perl-5.x.y-pretest/bin/perl -v> and
684 C</tmp/perl-5.x.y-pretest/bin/perl -V> are as expected,
685 especially as regards version numbers, patch and/or RC levels, and @INC
686 paths. Note that as they have been been built from a git working
687 directory, they will still identify themselves using git tags and
688 commits. (Note that for an odd-numbered version, perl will install
689 itself as C<perl5.x.y>). C<perl -v> will identify itself as:
690
691  This is perl 5, version X, subversion Y (v5.X.Y (v5.X.Z-NNN-deadbeef))
692
693 where 5.X.Z is the latest tag, Z the number of commits since this tag,
694 and C<< deadbeef >> commit of that tag.
695
696 Then delete the temporary installation.
697
698
699 =head3 push the work so far
700
701 Push all your recent commits:
702
703     $ git push origin ....
704
705
706 =head3 tag the release
707
708 Tag the release (e.g.):
709
710     $ git tag v5.11.0 -m "First release of the v5.11 series!"
711
712 It is B<VERY> important that from this point forward, you not push
713 your git changes to the Perl master repository.  If anything goes
714 wrong before you publish your newly-created tag, you can delete
715 and recreate it.  Once you push your tag, we're stuck with it
716 and you'll need to use a new version number for your release.
717
718
719 =head3 build the tarball
720
721 Before you run the following, you might want to install 7-Zip (the
722 C<p7zip-full> package under Debian or the C<p7zip> port on MacPorts) or
723 the AdvanceCOMP suite (e.g. the C<advancecomp> package under Debian,
724 or the C<advancecomp> port on macports - 7-Zip on Windows is the
725 same code as AdvanceCOMP, so Windows users get the smallest files
726 first time). These compress about 5% smaller than gzip and bzip2.
727 Over the lifetime of your distribution this will save a lot of
728 people a small amount of download time and disk space, which adds
729 up.
730
731 Create a tarball. Use the C<-s> option to specify a suitable suffix for
732 the tarball and directory name:
733
734     $ cd root/of/perl/tree
735     $ make distclean
736     $ git clean -xdf            # make sure perl and git agree on files
737     $ git status                # and there's nothing lying around
738
739     $ perl Porting/makerel -b -s RC1            # for a release candidate
740     $ perl Porting/makerel -b                   # for a final release
741
742 This creates the  directory F<../perl-x.y.z-RC1> or similar, copies all
743 the MANIFEST files into it, sets the correct permissions on them,
744 adds DOS line endings to some, then tars it up as
745 F<../perl-x.y.z-RC1.tar.gz>. With C<-b>, it also creates a C<tar.bz2> file.
746
747 If you're getting your tarball suffixed with -uncommitted and you're sure
748 your changes were all committed, you can override the suffix with:
749
750     $ perl Porting/makerel -b -s ''
751
752 XXX if we go for extra tags and branches stuff, then add the extra details
753 here
754
755 Finally, clean up the temporary directory, e.g.
756
757     $ rm -rf ../perl-x.y.z-RC1
758
759
760 =head3 test the tarball
761
762 Once you have a tarball it's time to test the tarball (not the repository).
763
764 =head4 Copy the tarball to a web server
765
766 Copy the tarballs (.gz and possibly .bz2) to a web server somewhere you
767 have access to.
768
769 =head4 Download the tarball to another machine
770
771 Download the tarball to some other machine. For a release candidate, 
772 you really want to test your tarball on two or more different platforms
773 and architectures. The #p5p IRC channel on irc.perl.org is a good place
774 to find willing victims.
775
776 =head4 Check that F<Configure> works
777
778 Check that basic configuration and tests work on each test machine:
779
780     $ ./Configure -des && make all test
781
782 =head4 Run the test harness and install
783
784 Check that the test harness and install work on each test machine:
785
786     $ make distclean
787     $ ./Configure -des -Dprefix=/install/path && make all test_harness install
788     $ cd /install/path
789
790 =head4 Check C<perl -v> and C<perl -V>
791
792 Check that the output of C<perl -v> and C<perl -V> are as expected,
793 especially as regards version numbers, patch and/or RC levels, and @INC
794 paths. 
795
796 Note that the results may be different without a F<.git/> directory,
797 which is why you should test from the tarball.
798
799 =head4 Run the Installation Verification Procedure utility
800
801     $ ./perl utils/perlivp
802     ...
803     All tests successful.
804     $
805
806 =head4 Compare the installed paths to the last release
807
808 Compare the pathnames of all installed files with those of the previous
809 release (i.e. against the last installed tarball on this branch which you
810 have previously verified using this same procedure). In particular, look
811 for files in the wrong place, or files no longer included which should be.
812 For example, suppose the about-to-be-released version is 5.10.1 and the
813 previous is 5.10.0:
814
815     cd installdir-5.10.0/
816     find . -type f | perl -pe's/5\.10\.0/5.10.1/g' | sort > /tmp/f1
817     cd installdir-5.10.1/
818     find . -type f | sort > /tmp/f2
819     diff -u /tmp/f[12]
820
821 =head4 Test the CPAN client
822
823 Bootstrap the CPAN client on the clean install:
824
825     $ bin/perl -MCPAN -e "shell"
826
827 If you're running this on Win32 you probably also need a set of Unix
828 command-line tools available for CPAN to function correctly without
829 Perl alternatives like LWP installed. Cygwin is an obvious choice.)
830
831 =head4 Install the Inline module and test it
832
833 Try installing a popular CPAN module that's reasonably complex and that
834 has dependencies; for example:
835
836     CPAN> install Inline
837     CPAN> quit
838
839 Check that your perl can run this:
840
841     $ bin/perl -lwe "use Inline C => q[int f() { return 42;}]; print f"
842     42
843     $
844
845 =head4 Bootstrap the CPANPLUS client
846
847 Bootstrap the CPANPLUS client on the clean install:
848
849     $ bin/cpanp
850
851 (Again, on Win32 you'll need something like Cygwin installed, but make sure
852 that you don't end up with its various F<bin/cpan*> programs being found on
853 the PATH before those of the Perl that you're trying to test.)
854
855 =head4 Install the DBI module with CPANPLUS
856
857     CPAN Terminal> i DBI
858     CPAN Terminal> quit
859     $ bin/perl -MDBI -e 1
860     $
861
862 =head4 Make sure that perlbug works
863
864 Test L<perlbug> with the following:
865
866     $ bin/perlbug
867     ...
868     Subject: test bug report
869     Local perl administrator [yourself]: 
870     Editor [vi]: 
871     Module: 
872     Category [core]: 
873     Severity [low]: 
874     (edit report)
875     Action (Send/Display/Edit/Subject/Save to File): f
876     Name of file to save message in [perlbug.rep]: 
877     Action (Send/Display/Edit/Subject/Save to File): q
878
879 and carefully examine the output (in F<perlbug.rep]>), especially
880 the "Locally applied patches" section. If everything appears okay, then
881 delete the file, and try it again, this time actually submitting the bug
882 report. Check that it shows up, then remember to close it!
883
884 =for checklist skip BLEAD-POINT
885
886 =head3 monitor smokes
887
888 Wait for the smoke tests to catch up with the commit which this release is
889 based on (or at least the last commit of any consequence).
890
891 Then check that the smoke tests pass (particularly on Win32). If not, go
892 back and fix things.
893
894 Note that for I<BLEAD-POINT> releases this may not be practical. It takes a
895 long time for the smokers to catch up, especially the Win32
896 smokers. This is why we have a RC cycle for I<MAINT> and I<BLEAD-FINAL>
897 releases, but for I<BLEAD-POINT> releases sometimes the best you can do is
898 to plead with people on IRC to test stuff on their platforms, fire away,
899 and then hope for the best.
900
901
902 =head3 upload to PAUSE
903
904 Once smoking is okay, upload it to PAUSE. This is the point of no return.
905 If anything goes wrong after this point, you will need to re-prepare
906 a new release with a new minor version or RC number.
907
908     https://pause.perl.org/
909
910 (Login, then select 'Upload a file to CPAN')
911
912 If your workstation is not connected to a high-bandwidth,
913 high-reliability connection to the Internet, you should probably use the
914 "GET URL" feature (rather than "HTTP UPLOAD") to have PAUSE retrieve the
915 new release from wherever you put it for testers to find it.  This will
916 eliminate anxious gnashing of teeth while you wait to see if your
917 15 megabyte HTTP upload successfully completes across your slow, twitchy
918 cable modem.  You can make use of your home directory on dromedary for
919 this purpose: F<http://users.perl5.git.perl.org/~USERNAME> maps to
920 F</home/USERNAME/public_html>, where F<USERNAME> is your login account
921 on dromedary.  I<Remember>: if your upload is partially successful, you
922 may need to contact a PAUSE administrator or even bump the version of perl.
923
924 Upload both the .gz and .bz2 versions of the tarball.
925
926 Do not proceed any further until you are sure that your tarballs are on
927 CPAN.  Check your authors directory on one of the "fast" CPAN mirrors
928 (e.g., cpan.hexten.net
929 or cpan.cpantesters.org) to confirm that your uploads have been successful.
930
931 =for checklist skip RC
932
933 =head3 wait for indexing
934
935 I<You MUST SKIP this step for RC>
936
937 Wait until you receive notification emails from the PAUSE indexer
938 confirming that your uploads have been received.  IMPORTANT -- you will
939 probably get an email that indexing has failed, due to module permissions.
940 This is considered normal.
941
942
943 =head3 publish tag
944
945 Now that you've shipped the new perl release to PAUSE, it's
946 time to publish the tag you created earlier to the public git repo (e.g.):
947
948     $ git push origin tag v5.11.0
949
950 =for checklist skip BLEAD-POINT
951
952 =head3 disarm patchlevel.h
953
954 I<You MUST SKIP this step for BLEAD-POINT release>
955
956 Disarm the F<patchlevel.h> change; for example,
957
958      static const char * const local_patches[] = {
959              NULL
960     -        ,"RC1"
961              PERL_GIT_UNPUSHED_COMMITS /* do not remove this line */
962
963 Be sure to commit your change:
964
965     $ git commit -m 'disarm RCnnn bump' patchlevel.h
966     $ git push origin ....
967
968
969
970 =head3 announce to p5p
971
972 Mail p5p to announce your new release, with a quote you prepared earlier.
973
974 Use the template at Porting/release_announcement_template.txt
975
976 Send a carbon copy to C<noc@metacpan.org>
977
978 =head3 update epigraphs.pod
979
980 Add your quote to F<Porting/epigraphs.pod> and commit it.
981 Your release announcement will probably not have reached the web-visible
982 archives yet, so you won't be able to include the customary link to the
983 release announcement yet.
984
985 =head3 blog about your epigraph
986
987 If you have a blog, please consider writing an entry in your blog explaining
988 why you chose that particular quote for your epigraph.
989
990 =for checklist skip RC
991
992 =head3 Module::CoreList nagging
993
994 I<You MUST SKIP this step for RC>
995
996 Remind the current maintainer of C<Module::CoreList> to push a new release
997 to CPAN.
998
999 =for checklist skip RC
1000
1001 =head3 new perldelta
1002
1003 I<You MUST SKIP this step for RC>
1004
1005 Create a new perldelta.
1006
1007 =over 4
1008
1009 =item *
1010
1011 Confirm that you have a clean checkout with no local changes.
1012
1013 =item *
1014
1015 Run F<Porting/new-perldelta.pl>
1016
1017 =item *
1018
1019 Run the C<git add> commands it outputs to add new and modified files.
1020
1021 =item *
1022
1023 Verify that the build still works, by running C<./Configure> and
1024 C<make test_porting>. (On Win32, run C<nmake> and
1025 C<nmake test TEST_FILES="porting\*.t ..\lib\diagnostics.t">.)
1026
1027 =item *
1028
1029 If F<t/porting/podcheck.t> spots errors in the new F<pod/perldelta.pod>,
1030 run C<./perl -MTestInit t/porting/podcheck.t | less> for more detail.
1031 Skip to the end of its test output to see the options it offers you.
1032
1033 =item *
1034
1035 When C<make test_porting> passes, commit the new perldelta.
1036
1037 =back
1038
1039 At this point you may want to compare the commit with a previous bump to
1040 see if they look similar.  See commit e3c71926d3 for an example of a
1041 previous version bump.
1042
1043 =for checklist skip BLEAD-POINT MAINT RC
1044
1045 =head3 bump version
1046
1047 I<You MUST SKIP this step for RC, BLEAD-POINT, MAINT>
1048
1049 If this was a BLEAD-FINAL release (i.e. the first release of a new maint
1050 series, 5.x.0 where x is even), then bump the version in the blead branch
1051 in git, e.g. 5.12.0 to 5.13.0.
1052
1053 First, add a new feature bundle to F<regen/feature.pl>, initially by just
1054 copying the exiting entry, and bump the file's $VERSION (after the __END__
1055 marker); e.g.
1056
1057          "5.14" => [qw(switch say state unicode_strings)],
1058     +    "5.15" => [qw(switch say state unicode_strings)],
1059
1060 Run F<regen/feature.pl> to propagate the changes to F<lib/feature.pm>.
1061
1062 Then follow the section L<"Bump the version number"> to bump the version
1063 in the remaining files and test and commit.
1064
1065
1066 =head3 clean build and test
1067
1068 Run a clean build and test to make sure nothing obvious is broken.
1069
1070 In particular, F<Porting/perldelta_template.pod> is intentionally exempted
1071 from podchecker tests, to avoid false positives about placeholder text.
1072 However, once it's copied to F<pod/perldelta.pod> the contents can now
1073 cause test failures. Problems should resolved by doing one of the
1074 following:
1075
1076 =over
1077
1078 =item 1
1079
1080 Replace placeholder text with correct text.
1081
1082 =item 2
1083
1084 If the problem is from a broken placeholder link, you can add it to the
1085 array C<@perldelta_ignore_links> in F<t/porting/podcheck.t>.  Lines
1086 containing such links should be marked with C<XXX> so that they get
1087 cleaned up before the next release.
1088
1089 =item 3
1090
1091 Following the instructions output by F<t/porting/podcheck.t> on how to
1092 update its exceptions database.
1093
1094 =back
1095
1096 =head3 push commits
1097
1098 Finally, push any commits done above.
1099
1100     $ git push origin ....
1101
1102 =for checklist skip BLEAD-POINT MAINT RC
1103
1104 =head3 create maint branch
1105
1106 I<You MUST SKIP this step for RC, BLEAD-POINT, MAINT>
1107
1108 If this was a BLEAD-FINAL release (i.e. the first release of a new maint
1109 series, 5.x.0 where x is even), then create a new maint branch based on
1110 the commit tagged as the current release.
1111
1112 Assuming you're using git 1.7.x or newer:
1113
1114     $ git checkout -b maint-5.12 v5.12.0
1115     $ git push origin -u maint-5.12
1116
1117
1118 =for checklist skip BLEAD-POINT MAINT RC
1119
1120 =head3 make the maint branch available in the APC
1121
1122 Clone the new branch into /srv/gitcommon/branches on camel so the APC will
1123 receive its changes.
1124
1125     $ git clone --branch maint-5.14 /gitroot/perl.git \
1126     ?  /srv/gitcommon/branches/perl-5.14.x
1127     $ chmod -R g=u /srv/gitcommon/branches/perl-5.14.x
1128
1129 And nag the sysadmins to make this directory available via rsync.
1130
1131 =for checklist skip BLEAD-POINT RC
1132
1133 =head3 copy perldelta.pod to other branches
1134
1135 I<You MUST SKIP this step for RC, BLEAD-POINT>
1136
1137 Copy the perldelta.pod for this release into the other branches; for
1138 example:
1139
1140     $ cp -i ../5.10.x/pod/perldelta.pod pod/perl5101delta.pod    # for example
1141     $ git add pod/perl5101delta.pod
1142
1143 Edit F<pod/perl.pod> to add an entry for the file, e.g.:
1144
1145     perl5101delta               Perl changes in version 5.10.1
1146
1147 Then rebuild various files:
1148
1149     $ perl pod/buildtoc --build-all
1150
1151 Finally, commit:
1152
1153     $ git commit -a -m 'add perlXXXdelta'
1154
1155
1156 =head3 update perlhist.pod in other branches
1157
1158 Make sure any recent F<pod/perlhist.pod> entries are copied to
1159 F<perlhist.pod> on other branches
1160 e.g.
1161
1162           5.8.9         2008-Dec-14
1163
1164
1165 =head3 bump RT version number
1166
1167 Log into http://rt.perl.org/ and check whether the new version is in the RT
1168 fields C<Perl Version> and C<Fixed In>. The easiest way to determine this is
1169 to go to L<https://rt.perl.org/rt3/Search/Build.html> and click on the drop
1170 downs next to the C<Perl Version> and C<Fixed In> labels.
1171
1172 If the new version is not listed there, send an email to C<perlbug-admin at
1173 perl.org> requesting this.
1174
1175 =head3 Relax!
1176
1177 I<You MUST RETIRE to your preferred PUB, CAFE or SEASIDE VILLA for some
1178 much-needed rest and relaxation>.
1179
1180 Thanks for releasing perl!
1181
1182
1183 =head2 Building a release - the day after
1184
1185 =head3 link announcement in epigraphs.pod
1186
1187 Add, to your quote to F<Porting/epigraphs.pod>, a link to the release
1188 announcement in the web-visible mailing list archive.  Commit it.
1189
1190 =head3 check tarball availability
1191
1192 Check various website entries to make sure the that tarball has appeared
1193 and is properly indexed:
1194
1195 =over 4
1196
1197 =item *
1198
1199 Check your author directory under L<http://www.cpan.org/authors/id/>
1200 to ensure that the tarballs are available on the website.
1201
1202 =item *
1203
1204 Check C</src> on CPAN (on a fast mirror) to ensure that links to
1205 the new tarballs have appeared.  There should be links in C</src/5.0>
1206 (which is accumulating all new versions), links in C</src> (which shows
1207 only the latest version on each branch), and an appropriate mention in
1208 C</src/README.html> (which describes the latest versions).
1209
1210 These links should appear automatically, some hours after upload.
1211 If they don't, or the C<README.html> description is inadequate,
1212 ask Ask <ask@perl.org>.
1213
1214 =item *
1215
1216 Check L<http://www.cpan.org/src/> to ensure that the C</src> updates
1217 have been correctly mirrored to the website.
1218 If they haven't, ask Ask <ask@perl.org>.
1219
1220 =item *
1221
1222 Check L<http://search.cpan.org> to see if it has indexed the distribution.
1223 It should be visible at a URL like C<http://search.cpan.org/dist/perl-5.10.1/>.
1224
1225 =back
1226
1227 =for checklist skip RC
1228
1229 =head3 update dev.perl.org
1230
1231 I<You MUST SKIP this step for a RC release>
1232
1233 In your C<perlorg> repository, link to the new release.  For a new
1234 latest-maint release, edit F<docs/shared/tpl/stats.html>.  Otherwise,
1235 edit F<docs/dev/perl5/index.html>.
1236
1237 Then make a pull request to Leo Lapworth.  If this fails for some reason
1238 and you cannot cajole anybody else into submitting that change, you can
1239 mail Leo as last resort.
1240
1241 This repository can be found on L<github|https://github.com/perlorg/perlweb>.
1242
1243 =for checklist end
1244
1245 =head1 SOURCE
1246
1247 Based on
1248 http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2009-05/msg00608.html,
1249 plus a whole bunch of other sources, including private correspondence.
1250
1251 =cut
1252