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