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