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