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