3 release_managers_guide - Releasing a new version of perl 5.x
5 XXX as of Jul 2009, this file is still a work-in-progress. I think it
6 contains all the actions needed to build a release, but things may have
7 got skipped, and some things could do with polishing. Note that things
8 change each release, there may be new things not covered here, or
9 tools may need updating. DAPM
13 This document describes the series of tasks required - some automatic, some
14 manual - to produce a perl release of some description, be that a snaphot,
15 release candidate, or final, numbered release of maint or blead.
17 The release process has traditionally been executed by the current
20 This document both helps as a check-list for the release engineer
21 and is a base for ideas on how the various tasks could be automated
24 The outline of a typical release cycle is as follows:
26 (5.10.1 is released, and post-release actions have been done)
30 an occasional snapshot is released, that still identifies itself as
35 a few weeks before the release, a number of steps are performed,
36 including bumping the version to 5.10.2
38 ...a few weeks passes...
40 perl-5.10.2-RC1 is released
42 perl-5.10.2 is released
44 post-release actions are performed, including creating new
47 ... the cycle continues ...
51 Some of the tasks described below apply to all four types of
52 release of Perl. (snapshot, RC, final release of maint, final
53 release of blead). Some of these tasks apply only to a subset
54 of these release types. If a step does not apply to a given
55 type of release, you will see a notation to that effect at
56 the beginning of the step.
64 A snapshot is intended to encourage in-depth testing from time-to-time,
65 for example after a key point in the stabilisation of a branch. It
66 requires fewer steps than a full release, and the version number of perl in
67 the tarball will usually be the same as that of the previous release.
69 =item Release Candidate (RC)
73 =item Stable/Maint release
75 At this point you should have a working release candidate with few or no
78 It's essentially the same procedure as for making a release candidate, but
79 with a whole bunch of extra post-release steps.
83 It's essentially the same procedure as for making a release candidate, but
84 with a whole bunch of extra post-release steps.
90 Before you can make an official release of perl, there are a few
91 hoops you need to jump through:
97 I<SKIP this step for SNAPSHOT>
99 Make sure you have a PAUSE account suitable for uploading a perl release.
100 If you don't have a PAUSE account, then request one:
102 https://pause.perl.org/pause/query?ACTION=request_id
104 Check that your account is allowed to upload perl distros: goto
105 https://pause.perl.org/, login, then select 'upload file to CPAN'; there
106 should be a "For pumpkings only: Send a CC" tickbox. If not, ask Andreas
107 König to add your ID to the list of people allowed to upload something
108 called perl. You can find Andreas' email address at:
110 https://pause.perl.org/pause/query?ACTION=pause_04imprint
114 Some release engineering steps require a full mirror of the CPAN.
115 Work to fall back to using a remote mirror via HTTP is incomplete
116 but ongoing. (No, a minicpan mirror is not sufficient)
118 =item git checkout and commit bit
120 You will need a working C<git> installation, checkout of the perl
121 git repository and perl commit bit. For information about working
122 with perl and git, see F<pod/perlrepository.pod>.
124 If you are not yet a perl committer, you won't be able to make a
125 release. Have a chat with whichever evil perl porter tried to talk
126 you into the idea in the first place to figure out the best way to
130 =item Quotation for release announcement epigraph
132 I<SKIP this step for SNAPSHOT and RC>
134 For a numbered blead or maint release of perl, you will need a quotation
135 to use as an epigraph to your release announcement. (There's no harm
136 in having one for a snapshot, but it's not required).
142 =head2 Building a release
144 The work of building a release candidate for a numbered release of
145 perl generally starts several weeks before the first release candidate.
146 Some of these should be done regularly, but all I<must> be done in the
153 I<You MAY SKIP this step for SNAPSHOT>
155 Check F<Maintainers.pl> for consistency; both these commands should
158 $ perl Porting/Maintainers --checkmani
159 $ perl Porting/Maintainers --checkmani lib/ ext/
163 I<You MAY SKIP this step for SNAPSHOT>
165 Ensure that dual-life CPAN modules are synchronised with CPAN. Basically,
168 $ ./perl -Ilib Porting/core-cpan-diff -a -o /tmp/corediffs
170 to see any inconsistencies between the core and CPAN versions of distros,
171 then fix the core, or cajole CPAN authors as appropriate. See also the
172 C<-d> and C<-v> options for more detail. You'll probably want to use the
173 C<-c cachedir> option to avoid repeated CPAN downloads.
175 To see which core distro versions differ from the current CPAN versions:
177 $ ./perl -Ilib Porting/core-cpan-diff -x -a
179 if you are making a maint release, run C<core-cpan-diff> on both blead and
180 maint, then diff the two outputs. Compare this with what you expect, and if
181 necessary, fix things up. For example, you might think that both blead
182 and maint are synchronised with a particular CPAN module, but one might
183 have some extra changes.
187 I<You MAY SKIP this step for SNAPSHOT>
189 Ensure dual-life CPAN modules are stable, which comes down to:
191 for each module that fails its regression tests on $current
192 did it fail identically on $previous?
193 if yes, "SEP" (Somebody Else's Problem)
194 else work out why it failed (a bisect is useful for this)
196 attempt to group failure causes
198 for each failure cause
199 is that a regression?
200 if yes, figure out how to fix it
201 (more code? revert the code that broke it)
203 (presumably) it's relying on something un-or-under-documented
204 should the existing behaviour stay?
205 yes - goto "regression"
206 no - note it in perldelta as a significant bugfix
207 (also, try to inform the module's author)
211 I<You MAY SKIP this step for SNAPSHOT>
213 Similarly, monitor the smoking of core tests, and try to fix.
217 I<You MAY SKIP this step for SNAPSHOT>
219 Similarly, monitor the smoking of perl for compiler warnings, and try to
224 I<You MAY SKIP this step for SNAPSHOT>
226 Run F<Porting/cmpVERSION.pl> to compare the current source tree with the
227 previous version to check for for modules that have identical version
228 numbers but different contents, e.g.:
230 $ cd ~/some-perl-root
231 $ ./perl -Ilib Porting/cmpVERSION.pl -xd ~/my_perl-tarballs/perl-5.10.0 .
233 then bump the version numbers of any non-dual-life modules that have
234 changed since the previous release, but which still have the old version
235 number. If there is more than one maintenance branch (e.g. 5.8.x, 5.10.x),
236 then compare against both.
238 Note that some of the files listed may be generated (e.g. copied from ext/
239 to lib/, or a script like lib/lib_pm.PL is run to produce lib/lib.pm);
240 make sure you edit the correct file!
242 Once all version numbers have been bumped, re-run the checks.
244 Then run again without the -x option, to check that dual-life modules are
249 Check that files managed by F<regen.pl> and friends are up to date. From
250 within your working directory:
258 If any of the files managed by regen.pl have changed, then you should commit
259 the updated versions:
261 $ git commit -m 'Updated files generated by regen tools for perl 5.x.y' <list of files>
266 I<You MAY SKIP this step for SNAPSHOT>
268 Get perldelta in a mostly finished state.
270 Peruse F<Porting/how_to_write_a_perldelta.pod>, and try to make sure that
271 every section it lists is, if necessary, populated and complete. Copy
272 edit the whole document.
276 I<You MUST SKIP this step for SNAPSHOT>
278 Bump the perl version number (e.g. from 5.10.0 to 5.10.1).
280 There is a tool to semi-automate this process. It works in two stages.
281 First, it generates a list of suggested changes, which you review and
282 edit; then you feed this list back and it applies the edits. So, first
283 scan the source dir looking for likely candidates:
285 $ Porting/bump-perl-version -s 5.10.0 5.10.1 > /tmp/scan
287 This produces a file containing a list of suggested edits, eg:
291 89: -MODULE_DESC = "Perl 5.10.0 for NetWare"
292 +MODULE_DESC = "Perl 5.10.1 for NetWare"
294 i.e. in the file F<NetWare/Makefile>, line 89 would be changed as shown.
295 Review the file carefully, and delete any -/+ line pairs that you don't
296 want changing. Remember that this tool is largely just grepping for '5.10.0'
297 or whatever, so it will generate false positives. Be careful not change
298 text like "this was fixed in 5.10.0"! Then run:
300 $ Porting/bump-perl-version -u < /tmp/scan
302 which will update all the files shown; then commit the changes.
304 Be particularly careful with F<INSTALL>, which contains a mixture of
305 C<5.10.0>-type strings, some of which need bumping on every release, and
306 some of which need to be left. Also note that this tool currently only
307 performs a single change per line, so in particular, this line in
308 README.vms needs special handling:
310 rename perl-5^.10^.1.dir perl-5_10_1.dir
315 I<You MUST SKIP this step for SNAPSHOT>
317 Review and update INSTALL to account for the change in version number;
318 in particular, the "Coexistence with earlier versions of perl 5" section.
322 I<You MUST SKIP this step for SNAPSHOT>
324 Update the F<Changes> file to contain the git log command which would show
325 all the changes in this release. You will need assume the existence of a
326 not-yet created tag for the forthcoming release; e.g.
328 git log ... perl-5.10.0..perl5.12.0
330 Due to warts in the perforce-to-git migration, some branches require extra
331 exclusions to avoid other branches being pulled in. Make sure you have the
332 correct incantation: replace the not-yet-created tag with C<HEAD> and see
333 if git log produces roughly the right number of commits across roughly the
339 Check some more build configurations, e.g.
341 -Duseshrplib -Dd_dosuid
344 Check that setuid installs works (for < 5.11.0 only).
345 XXX any other configs?
350 I<You MAY SKIP this step for SNAPSHOT>
352 Update F<AUTHORS>, using the C<Porting/checkAUTHORS.pl> script, and if
353 necessary, update the script to include new alias mappings.
355 XXX This script is currently broken (7/2009). It needs updating to work
356 with git and a lack of Changes files.
361 I<You MAY SKIP this step for SNAPSHOT>
363 As there are no regular smokes [ XXX yet - please fix?] find out about the
364 state of the current branch on VMS. If the branch you're releasing on
365 is failing tests on VMS, you may not want to do a release.
369 Configure and build perl so that you have a Makefile and porting tools:
371 $ ./Configure -Dusedevel -des
381 Commit META.yml if it has changed:
383 $ git commit -m 'Updating META.yml in preparation for release of 5.x.y' META.yml
387 Check that the manifest is sorted and correct:
391 $ perl Porting/manicheck
394 Commit MANIFEST if it has changed:
396 $ git commit -m 'Updating MANIFEST in preparation for release of 5.x.y' MANIFEST
402 I<You MUST SKIP this step for SNAPSHOT>
404 A dd an entry to F<pod/perlhist.pod> with the current date:
406 5.8.9-RC1 2008-Nov-10
408 Make sure the correct pumpking is listed, and if this is the first release
409 under the stewardship of a new pumpking, make sure that his or her name
410 is listed in the section entitled C<THE KEEPERS OF THE PUMPKIN>.
412 Be sure to commit your changes:
414 $ git commit -m 'Updating perlhist in preparation for release of 5.x.y pod/perlhist.pod
419 Build perl, then make sure it passes its own test suite, and installs:
421 $ ./Configure -des -Dusedevel -Dprefix=/tmp/perl-5.x.y-pretest
426 Create a tarball. Use the C<-s> option to specify a suitable suffix for
427 the tarball and directory name:
429 $ cd root/of/perl/tree
431 $ git clean -xdf # make sure perl and git agree on files
433 $ perl Porting/makerel -b -s `git describe` # for a snapshot
434 $ perl Porting/makerel -b -s RC1 # for a release candidate
435 $ perl Porting/makerel -b # for a final release
437 This creates the directory F<../perl-x.y.z-RC1> or similar, copies all
438 the MANIFEST files into it, sets the correct permissions on them,
439 adds DOS line endings to some, then tars it up as
440 F<../perl-x.y.z-RC1.tar.gz>. With C<-b>, it also creates a C<tar.bz2> file.
442 XXX if we go for extra tags and branches stuff, then add the extra details
447 Copy the tarballs (.gz and possibly .bz2) to a web server somewhere you
452 Download the tarball to some other machine. For a release candidate,
453 you really want to test your tarball on two or more different platforms
454 and architectures. The #p5p IRC channel on irc.perl.org is a good place
455 to find willing victims.
459 Check that basic configuration and tests work on each test machine:
461 $ ./Configure -des && make all test
465 Check that the test harness and install work on each test machine:
467 $ ./Configure -des -Dprefix=/install/path && make all test_harness install
471 Check that the output of C<perl -v> and C<perl -V> are as expected,
472 especially as regards version numbers, patch and/or RC levels, and @INC
475 Note that the results may be different without a F<.git/> directory,
476 which is why you should test from the tarball.
480 Bootstrap the CPAN client on the clean install:
482 $ ./bin/perl -MCPAN -e'shell'
488 $ ./bin/perl -MCPAN -e'install Inline'
490 Check that your perl can run this:
492 $ ./bin/perl -lwe 'use Inline C => "int answer() { return 42;} "; print answer'
496 Bootstrap the CPANPLUS client on the clean install:
503 Install an XS module.
507 If all is well, announce the snapshot to p5p. (For a release candidate,
508 instead follow the further steps described later.)
514 I<You MAY SKIP this step for SNAPSHOT>
516 Re-read the perldelta to try to find any embarrassing typos and thinkos;
517 remove any C<TODO> or C<XXX> flags; and run through pod and spell
520 podchecker -warnings -warnings pod/perl5101delta.pod
521 spell pod/perl5101delta.pod
525 I<You MUST SKIP this step for SNAPSHOT>
527 Update patchlevel.h to add a C<-RC1>-or-whatever string; or, if this is a
528 final release, remove it. [ XXX how now?? see 34813 for old way ]
532 I<You MUST SKIP this step for SNAPSHOT>
534 Update C<Module::Corelist>.
536 Note that if this is a maint release, you should run the following actions
537 from the maint directory, but edit the C<Corelist.pm> in I<blead> and
538 subsequently cherry-pick it.
540 corelist.pl uses ftp.funet.fi to verify information about dual-lifed
541 modules on CPAN. It can use a full, local CPAN mirror or fall back
542 to C<wget> or C<curl> to fetch only package metadata remotely.
544 (If you'd prefer to have a full CPAN mirror, see
545 http://www.cpan.org/misc/cpan-faq.html#How_mirror_CPAN)
548 Then change to your perl checkout.
550 If you have a local CPAN mirror, run:
552 $ perl -Ilib Porting/corelist.pl ~/my-cpan-mirror
556 $ perl -Ilib Porting/corelist.pl cpan
558 This will chug for a while. Assuming all goes well, it will
559 update lib/Module/CoreList.pm.
561 Check that file over carefully:
563 $ git diff lib/Module/CoreList.pm
566 If necessary, bump C<$VERSION> (there's no need to do this for
567 every RC; in RC1, bump the version to a new clean number that will
568 appear in the final release, and leave as-is for the later RCs and final).
570 Edit the version number in the new C<< 'Module::CoreList' => 'X.YZ' >>
571 entry, as that is likely to reflect the previous version number.
573 If this is a final release (rather than a release candidate):
575 Update this version's entry in the C<%released> hash with today's date.
577 Finally, commit the new version of Module::CoreList:
579 $ git commit -m 'Updated Module::CoreList for the 5.x.y release' \
580 lib/Module/Corelist.pm
585 Disarm the patchlevel.h change [ XXX expand ]
589 I<You MAY SKIP this step for SNAPSHOT>
591 Wait for the smoke tests to catch up with the commit which this release is
592 based on (or at least the last commit of any consequence).
594 Then check that the smoke tests pass (particularly on Win32). If not, go
600 I<You MUST SKIP this step for SNAPSHOT>
602 Once smoking is okay, upload it to PAUSE. This is the point of no return.
603 If anything goes wrong after this point, you will need to re-prepare
604 a new release with a new minor version or RC number.
606 You may wish to create a .bz2 version of the tarball and upload that too.
610 I<You MUST SKIP this step for SNAPSHOT>
612 Create a tag for the exact git revsion you built the release from:
614 $ git tag perl-5.10.1-RC1 -m'Release Candidate 1 of Perl 5.10.1'
615 $ git push origin tag perl-5.10.1-RC1
619 Mail p5p to announce your new release, with a quote you prepared earlier.
623 I<You MAY SKIP this step for SNAPSHOT>
625 Wait 24 hours or so, then post the announcement to use.perl.org.
626 (if you don't have access rights to post news, ask someone like Rafael to
631 I<You MUST SKIP this step for SNAPSHOT, RC, BLEAD>
633 Ask Jarkko to update http://www.cpan.org/src/README.html and
634 Rafael to update http://dev.perl.org/perl5/
638 I<You MUST SKIP this step for SNAPSHOT, RC>
641 Create a new empty perlNNNdelta.pod file for the current release + 1;
642 see F<Porting/how_to_write_a_perldelta.pod>.
643 [ XXX Perhaps we should have an empty template file we can copy in. ]
645 In addition, edit F<pod.lst>, adding the new entry as 'D', and unmark previous
646 entry as 'D', then run C<perl pod/buildtoc --build-all> to update the
652 vms/descrip_mms.template
654 (F<vms/descrip_mms.template> still needs a manual edit to bump the
655 C<perldelta.pod> entry - it would be good for someone to figure out the fix.)
657 and change perlNNNdelta references to the new version in these files
665 Also, edit the previous delta file to change the C<NAME> from C<perldelta>
668 These two lists of files probably aren't exhaustive; do a recursive grep
669 on the previous filename to look for suitable candidates.
671 (see 16410843ea for an example).
675 I<You MUST SKIP this step for SNAPSHOT, RC, BLEAD>
677 If this was a maint release, then edit F<Porting/mergelog> to change
678 all the C<d> (deferred) flags to C<.> (needs review).
680 XXX - we should be able to use git to automate much of the role
681 previously filled by the mergelog.
685 I<You MUST SKIP this step for SNAPSHOT, RC, BLEAD>
687 If this was a major release (5.x.0), then create a new maint branch
688 based on the commit tagged as the current release and bump the version
689 in the blead branch in git, e.g. 5.12.0 to 5.13.0.
691 [ XXX probably lots more stuff to do, including perldelta,
694 XXX need a git recipe
698 I<You MUST SKIP this step for SNAPSHOT, RC, BLEAD>
700 Copy the perlNNNdelta.pod for this release into the other branches, and
701 remember to update these files on those branches too:
706 vms/descrip_mms.template
709 (see fc5be80860 for an example).
713 I<You MUST SKIP this step for SNAPSHOT>
715 Make sure any recent F<pod/perlhist.pod> entries are copied to
716 F<perlhist.pod> on other branches; typically the RC* and final entries,
719 5.8.9-RC1 2008-Nov-10
720 5.8.9-RC2 2008-Dec-06
725 I<You MUST SKIP this step for SNAPSHOT, RC>
727 Remind the current maintainer of C<Module::CoreList> to push a new release
732 I<You MUST RETIRE to your preferred PUB, CAFE or SEASIDE VILLA for some much-needed
733 rest and relaxation>.
735 Thanks for releasing perl!
742 http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2009-05/msg00608.html,
743 plus a whole bunch of other sources, including private correspondence.