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