Note that things change at each release, so there may be new things not
covered here, or tools may need updating.
+=head1 MAKING A CHECKLIST
+
+If you are preparing to do a release, you can run the
+F<Porting/make-rmg-checklist> script to generate a new version of this
+document that starts with a checklist for your release.
+
+This script is run as:
+
+ perl Porting/make-rmg-checklist \
+ --type [BLEAD-POINT or MAINT or ...] > /tmp/rmg.pod
+
+You can also pass the C<--html> flag to generate an HTML document instead of
+POD.
+
+ perl Porting/make-rmg-checklist --html \
+ --type [BLEAD-POINT or MAINT or ...] > /tmp/rmg.html
=head1 SYNOPSIS
20th by a non-pumpking release engineer. The release engineer roster
and schedule can be found in Porting/release_schedule.pod.
-This document both helps as a check-list for the release engineer
-and is a base for ideas on how the various tasks could be automated
+This document both helps as a check-list for the release engineer
+and is a base for ideas on how the various tasks could be automated
or distributed.
-The outline of a typical release cycle is as follows:
+The checklist of a typical release cycle is as follows:
(5.10.1 is released, and post-release actions have been done)
... the cycle continues ...
-
=head1 DETAILS
Some of the tasks described below apply to all four types of
release of Perl. (blead, RC, final release of maint, final
release of blead). Some of these tasks apply only to a subset
-of these release types. If a step does not apply to a given
+of these release types. If a step does not apply to a given
type of release, you will see a notation to that effect at
the beginning of the step.
-
=head2 Release types
=over 4
It's essentially the same procedure as for making a release candidate, but
with a whole bunch of extra post-release steps.
+Note that for a maint release there are two versions of this guide to
+consider: the one in the maint branch, and the one in blead. Which one to
+use is a fine judgement. The blead one will be most up-to-date, while
+it might describe some steps or new tools that aren't applicable to older
+maint branches. It is probably best to review both versions of this
+document, but to most closely follow the steps in the maint version.
+
=item A blead point release (BLEAD-POINT)
A release with an odd version number, such as 5.15.0 or 5.15.1.
=back
+=for checklist begin
=head2 Prerequisites
Before you can make an official release of perl, there are a few
hoops you need to jump through:
-=over 4
-
-=item PAUSE account
+=head3 PAUSE account with pumpkin status
Make sure you have a PAUSE account suitable for uploading a perl release.
If you don't have a PAUSE account, then request one:
https://pause.perl.org/pause/query?ACTION=pause_04imprint
-=item search.cpan.org
+=head3 search.cpan.org pumpkin status
Make sure that search.cpan.org knows that you're allowed to upload
perl distros. Contact Graham Barr to make sure that you're on the right
list.
-=item CPAN mirror
+=head3 rt.perl.org update access
-Some release engineering steps require a full mirror of the CPAN.
-Work to fall back to using a remote mirror via HTTP is incomplete
-but ongoing. (No, a minicpan mirror is not sufficient)
+Make sure you have permission to close tickets on L<http://rt.perl.org/>
+so you can respond to bug report as necessary during your stint. If you
+don't, make an account (if you don't have one) and contact the pumpking
+with your username to get ticket-closing permission.
-=item git checkout and commit bit
+=head3 git checkout and commit bit
You will need a working C<git> installation, checkout of the perl
git repository and perl commit bit. For information about working
you into the idea in the first place to figure out the best way to
resolve the issue.
+=head3 git clone of https://github.com/perlorg/perlweb
+
+For updating the L<http://dev.perl.org> web pages, either a Github account or
+sweet-talking somebody with a Github account into obedience is needed. This
+is only needed on the day of the release or shortly afterwards.
-=item Quotation for release announcement epigraph
+=for checklist skip RC
+
+=head3 Quotation for release announcement epigraph
I<SKIP this step for RC>
For all except an RC release of perl, you will need a quotation
to use as an epigraph to your release announcement.
-
-=back
-
-
=head2 Building a release - advance actions
-The work of building a release candidate for a numbered release of
-perl generally starts several weeks before the first release candidate.
-Some of the following steps should be done regularly, but all I<must> be
-done in the run up to a release.
-
+The work of building a release candidate for an even numbered release
+(BLEAD-FINAL) of perl generally starts several weeks before the first
+release candidate. Some of the following steps should be done regularly,
+but all I<must> be done in the run up to a release.
=head3 dual-life CPAN module synchronisation
-Ensure that dual-life CPAN modules are synchronised with CPAN. Basically,
-run the following:
+To see which core distro versions differ from the current CPAN versions:
- $ ./perl -Ilib Porting/core-cpan-diff -a -o /tmp/corediffs
+ $ ./perl -Ilib Porting/core-cpan-diff -x -a
-to see any inconsistencies between the core and CPAN versions of distros,
-then fix the core, or cajole CPAN authors as appropriate. See also the
-C<-d> and C<-v> options for more detail. You'll probably want to use the
-C<-c cachedir> option to avoid repeated CPAN downloads and may want to
-use C<-m file:///mirror/path> if you made a local CPAN mirror.
+However, this only checks whether the version recorded in
+F<Porting/Maintainers.pl> differs from the latest on CPAN. It doesn't tell you
+if the code itself has diverged from CPAN.
-To see which core distro versions differ from the current CPAN versions:
+You can also run an actual diff of the contents of the modules, comparing core
+to CPAN, to ensure that there were no erroneous/extraneous changes that need to
+be dealt with. You do this by not passing the C<-x> option:
- $ ./perl -Ilib Porting/core-cpan-diff -x -a
+ $ ./perl -Ilib Porting/core-cpan-diff -a -o /tmp/corediffs
+
+Passing C<-u cpan> will probably be helpful, since it limits the search to
+distributions with 'cpan' upstream source. (It's OK for blead upstream to
+differ from CPAN because those dual-life releases usually come I<after> perl
+is released.)
+
+See also the C<-d> and C<-v> options for more detail (and the C<-u> option as
+mentioned above). You'll probably want to use the C<-c cachedir> option to
+avoid repeated CPAN downloads and may want to use C<-m file:///mirror/path> if
+you made a local CPAN mirror. Note that a minicpan mirror won't actually work,
+but can provide a good first pass to quickly get a list of modules which
+definitely haven't changed, to avoid having to download absolutely everything.
+
+For a BLEAD-POINT or BLEAD-FINAL release with 'cpan' upstream, if a CPAN
+release appears to be ahead of blead, then consider updating it (or asking the
+relevant porter to do so). (However, if this is a BLEAD-FINAL release or one of
+the last BLEAD-POINT releases before it and hence blead is in some kind of
+"code freeze" state (e.g. the sequence might be "contentious changes freeze",
+then "user-visible changes freeze" and finally "full code freeze") then any
+CPAN module updates must be subject to the same restrictions, so it may not be
+possible to update all modules until after the BLEAD-FINAL release.) If blead
+contains edits to a 'cpan' upstream module, this is naughty but sometimes
+unavoidable to keep blead tests passing. Make sure the affected file has a
+CUSTOMIZED entry in F<Porting/Maintainers.pl>.
If you are making a MAINT release, run C<core-cpan-diff> on both blead and
maint, then diff the two outputs. Compare this with what you expect, and if
necessary, fix things up. For example, you might think that both blead
and maint are synchronised with a particular CPAN module, but one might
-have some extra changes.
+have some extra changes.
+
+=head3 How to sync a CPAN module with a cpan/ distro
+
+=over 4
+
+=item *
+
+Fetch the most recent version from CPAN.
+
+=item *
+
+Unpack the retrieved tarball. Rename the old directory; rename the new
+directory to the original name.
+
+=item *
+
+Restore any F<.gitignore> file. This can be done by issuing
+C<git checkout .gitignore> in the F<cpan/Distro> directory.
+
+=item *
+
+Remove files we do not need. That is, remove any files that match the
+entries in C<@IGNORABLE> in F<Porting/Maintainer.pl>, and anything that
+matches the C<EXCLUDED> section of the distro's entry in the C<%Modules>
+hash.
+
+=item *
+
+Restore any files mentioned in the C<CUSTOMIZED> section, using
+C<git checkout>. Make any new customizations if necessary. Also,
+restore any files that are mentioned in C<@IGNORE>, but were checked
+into the repository anyway.
+
+=item *
+For any new files in the distro, determine whether they are needed.
+If not, delete them, and list them in either C<EXCLUDED> or C<@INGORE>.
+Otherwise, add them to C<MANIFEST>, and run C<git add> to add the files
+to the repository.
+
+=item *
+
+For any files that are gone, remove them from C<MANIFEST>, and use
+C<git rm> to tell git the files will be gone.
+
+=item *
+
+If the C<MANIFEST> file was changed in any of the previous steps, run
+C<perl Porting/manisort --output MANIFEST.sort; mv MANIFEST.sort MANIFEST>.
+
+=item *
+
+For any files that have an execute bit set, either remove the execute
+bit, or edit F<Porting/exec-bit.txt>
+
+=item *
+
+Run C<make> (or C<nmake> on Windows), see if C<perl> compiles.
+
+=item *
+
+Run the tests for the package.
+
+=item *
+
+Run the tests in F<t/porting>.
+
+=item *
+
+Update the C<DISTRIBUTION> entry in F<Porting/Maintainers.pl>.
+
+=item *
+
+Run a full configure/build/test cycle.
+
+=item *
+
+If everything is ok, commit the changes.
+
+=back
+
+For entries with a non-simple C<FILES> section, or with a C<MAP>, you
+may have to take more steps than listed above.
+
+F<Porting/sync-with-cpan> is a script that automates most of the steps
+above; but see the comments at the beginning of the file. In particular,
+it has not yet been exercised on Windows, but will certainly require a set
+of Unix tools such as Cygwin, and steps that run C<make> will need to run
+C<nmake> instead.
=head3 dual-life CPAN module stability
Ensure dual-life CPAN modules are stable, which comes down to:
- for each module that fails its regression tests on $current
- did it fail identically on $previous?
- if yes, "SEP" (Somebody Else's Problem)
- else work out why it failed (a bisect is useful for this)
+ for each module that fails its regression tests on $current
+ did it fail identically on $previous?
+ if yes, "SEP" (Somebody Else's Problem)
+ else work out why it failed (a bisect is useful for this)
- attempt to group failure causes
+ attempt to group failure causes
- for each failure cause
- is that a regression?
- if yes, figure out how to fix it
- (more code? revert the code that broke it)
- else
- (presumably) it's relying on something un-or-under-documented
- should the existing behaviour stay?
- yes - goto "regression"
- no - note it in perldelta as a significant bugfix
- (also, try to inform the module's author)
+ for each failure cause
+ is that a regression?
+ if yes, figure out how to fix it
+ (more code? revert the code that broke it)
+ else
+ (presumably) it's relying on something un-or-under-documented
+ should the existing behaviour stay?
+ yes - goto "regression"
+ no - note it in perldelta as a significant bugfix
+ (also, try to inform the module's author)
-
-=head3 smoking
+=head3 monitor smoke tests for failures
Similarly, monitor the smoking of core tests, and try to fix. See
-L<http://doc.procura.nl/smoke/index.html> for a summary. See also
+L<http://doc.procura.nl/smoke/index.html> and L<http://perl5.test-smoke.org/>
+for a summary. See also
L<http://www.nntp.perl.org/group/perl.daily-build.reports/> which has
the raw reports.
Similarly, monitor the smoking of perl for compiler warnings, and try to
fix.
-
-=head3 perldelta
+=head3 update perldelta
Get perldelta in a mostly finished state.
every section it lists is, if necessary, populated and complete. Copy
edit the whole document.
+You won't be able to automatically fill in the "Updated Modules" section until
+after Module::CoreList is updated (as described below in
+L<"update Module::CoreList">).
=head3 Bump the version number
+Do not do this yet for a BLEAD-POINT release! You will do this at the end of
+the release process.
+
Increase the version number (e.g. from 5.12.0 to 5.12.1).
-For a BLEAD-POINT release, this can happen on the day of the release. For a
-release candidate for a stable perl, this should happen a week or two
+For a release candidate for a stable perl, this should happen a week or two
before the first release candidate to allow sufficient time for testing and
smoking with the target version built into the perl executable. For
-subsequent release candidates and the final release, it it not necessary to
+subsequent release candidates and the final release, it is not necessary to
bump the version further.
There is a tool to semi-automate this process:
When doing a BLEAD-POINT or BLEAD-FINAL release, also make sure the
C<PERL_API_*> constants in F<patchlevel.h> are in sync with the version
-you're releasing, unless you're
-absolutely sure the release you're about to make is 100% binary compatible
-to an earlier release. When releasing a MAINT perl version, the C<PERL_API_*>
-constants C<MUST NOT> be changed as we aim to guarantee binary compatibility
-in maint branches.
+you're releasing, unless you're absolutely sure the release you're about to
+make is 100% binary compatible to an earlier release. When releasing a MAINT
+perl version, the C<PERL_API_*> constants C<MUST NOT> be changed as we aim
+to guarantee binary compatibility in maint branches.
After editing, regenerate uconfig.h (this must be run on a system with a
/bin/sh available):
- $ perl regen/uconfig_h.pl
+ $ perl regen/uconfig_h.pl
+
+This might not cause any new changes.
Test your changes:
- $ git clean -xdf # careful if you don't have local files to keep!
- $ ./Configure -des -Dusedevel
- $ make
- $ make test
+ $ git clean -xdf # careful if you don't have local files to keep!
+ $ ./Configure -des -Dusedevel
+ $ make
+ $ make test
Commit your changes:
- $ git status
- $ git diff
- B<review the delta carefully>
+ $ git status
+ $ git diff
+ B<review the delta carefully>
- $ git commit -a -m 'Bump the perl version in various places for 5.x.y'
+ $ git commit -a -m 'Bump the perl version in various places for 5.x.y'
At this point you may want to compare the commit with a previous bump to
-see if they look similar. See commit 8891dd8d for an example of a
+see if they look similar. See commit f7cf42bb69 for an example of a
previous version bump.
When the version number is bumped, you should also update Module::CoreList
(as described below in L<"update Module::CoreList">) to reflect the new
version number.
-
=head3 update INSTALL
Review and update INSTALL to account for the change in version number;
For BLEAD-POINT releases, it needs to refer to the previous BLEAD-POINT
release (so for 5.15.3 this would be 5.15.2).
+=head3 Check copyright years
+
+Check that the copyright years are up to date by running:
+
+ $ ./perl t/porting/copyright.t --now
+
+Remedy any test failures by editing README or perl.c accordingly (search for
+the "Copyright"). If updating perl.c, check if the file's own copyright date in
+the C comment at the top needs updating, as well as the one printed by C<-v>.
+
=head3 Check more build configurations
-Check some more build configurations. The check that setuid builds and
-installs is for < 5.11.0 only.
+Try running the full test suite against multiple Perl configurations. Here are
+some sets of Configure flags you can try:
- $ sh Configure -Dprefix=/tmp/perl-5.x.y -Uinstallusrbinperl \
- -Duseshrplib -Dd_dosuid
- $ make
- $ LD_LIBRARY_PATH=`pwd` make test # or similar for useshrplib
+=over 4
+
+=item *
- $ make suidperl
- $ su -c 'make install'
- $ ls -l .../bin/sperl
- -rws--x--x 1 root root 69974 2009-08-22 21:55 .../bin/sperl
+C<-Duseshrplib -Dusesitecustomize>
-(Then delete the installation directory.)
+=item *
-XXX think of other configurations that need testing.
+C<-Duserelocatableinc>
+=item *
+
+C<-Dusethreads>
+
+=back
+
+If you have multiple compilers on your machine, you might also consider
+compiling with C<-Dcc=$other_compiler>.
=head3 update perlport
indicates which platforms are known to build in the current release.
If necessary update the list and the indicated version number.
+=head3 check a readonly build
+Even before other prep work, follow the steps in L<build the tarball> and test
+it locally. Because a perl source tarballs sets many files read-only, it could
+test differently than tests run from the repository. After you're sure
+permissions aren't a problem, delete the generated directory and tarballs.
=head2 Building a release - on the day
This section describes the actions required to make a release
-that are performed on the actual day.
-
+that are performed near to, or on the actual release day.
=head3 re-check earlier actions
L<"Building a release - advance actions"> to ensure they are all done and
up-to-date.
+=head3 create a release branch
-=head3 bump version number
-
-For a BLEAD-POINT release, if you did not bump the perl version number as
-part of I<advance actions>, do that now.
-
-
-=head3 finalize perldelta
-
-Finalize the perldelta. In particular, fill in the Acknowledgements
-section, which can be generated with something like:
-
- $ perl Porting/acknowledgements.pl v5.15.0..HEAD
-
-Re-read the perldelta to try to find any embarrassing typos and thinkos;
-remove any C<TODO> or C<XXX> flags; update the "Known Problems" section
-with any serious issues for which fixes are not going to happen now; and
-run through pod and spell checkers, e.g.
-
- $ podchecker -warnings -warnings pod/perldelta.pod
- $ spell pod/perldelta.pod
-
-Also, you may want to generate and view an HTML version of it to check
-formatting, e.g.
-
- $ ./perl -Ilib ext/Pod-Html/pod2html pod/perldelta.pod > /tmp/perldelta.html
-
-Another good HTML preview option is http://search.cpan.org/pod2html
-
-If you make changes, be sure to commit them.
+For BLEAD-POINT releases, making a release from a release branch avoids the
+need to freeze blead during the release. This is less important for
+BLEAD-FINAL, MAINT, and RC releases, since blead will already be frozen in
+those cases. Create the branch by running
+ git checkout -b release-5.xx.yy
=head3 build a clean perl
$ ./Configure -Dusedevel -des && make
-
=head3 update Module::CoreList
-Update C<Module::CoreList> with module version data for the new release.
+=head4 Bump Module::CoreList* $VERSIONs
+
+If necessary, bump C<$Module::CoreList::VERSION> (there's no need to do this for
+every RC; in RC1, bump the version to a new clean number that will
+appear in the final release, and leave as-is for the later RCs and final).
+It may also happen that C<Module::CoreList> has been modified in blead, and
+hence has a new version number already. (But make sure it is not the same
+number as a CPAN release.)
+
+C<$Module::CoreList::TieHashDelta::VERSION> and
+C<$Module::CoreList::Utils::VERSION> should always be equal to
+C<$Module::CoreList::VERSION>. If necessary, bump those two versions to match
+before proceeding.
+
+=head4 Update C<Module::CoreList> with module version data for the new release.
Note that if this is a MAINT release, you should run the following actions
from the maint branch, but commit the C<CoreList.pm> changes in
I<blead> and subsequently cherry-pick any releases since the last
maint release and then your recent commit. XXX need a better example
+[ Note that the procedure for handling Module::CoreList in maint branches
+is a bit complex, and the RMG currently don't describe a full and
+workable approach. The main issue is keeping Module::CoreList
+and its version number synchronised across all maint branches, blead and
+CPAN, while having to bump its version number for every RC release.
+See this brief p5p thread:
+
+ Message-ID: <20130311174402.GZ2294@iabyn.com>
+
+If you can devise a workable system, feel free to try it out, and to
+update the RMG accordingly!
+
+DAPM May 2013 ]
+
F<corelist.pl> uses ftp.funet.fi to verify information about dual-lived
-modules on CPAN. It can use a full, local CPAN mirror or fall back
-to C<wget> or C<curl> to fetch only package metadata remotely. (If you're
-on Win32, then installing Cygwin is one way to have commands like C<wget>
-and C<curl> available.)
+modules on CPAN. It can use a full, local CPAN mirror and/or fall back
+on HTTP::Tiny to fetch package metadata remotely.
-(If you'd prefer to have a full CPAN mirror, see
+(If you'd prefer to have a full CPAN mirror, see
http://www.cpan.org/misc/cpan-faq.html#How_mirror_CPAN)
Then change to your perl checkout, and if necessary,
$ make
-If this not the first update for this version (e.g. if it was updated
-when the version number was originally bumped), first edit
-F<dist/Module-CoreList/lib/Module/CoreList.pm> to delete the existing
-entries for this version from the C<%released> and C<%version> hashes:
-they will have a key like C<5.010001> for 5.10.1.
-
-XXX the edit-in-place functionality of Porting/corelist.pl should
-be fixed to handle this automatically.
-
Then, If you have a local CPAN mirror, run:
$ ./perl -Ilib Porting/corelist.pl ~/my-cpan-mirror
This will chug for a while, possibly reporting various warnings about
badly-indexed CPAN modules unrelated to the modules actually in core.
Assuming all goes well, it will update
-F<dist/Module-CoreList/lib/Module/CoreList.pm>.
+F<dist/Module-CoreList/lib/Module/CoreList.pm> and possibly
+F<dist/Module-CoreList/lib/Module/CoreList.pod> and/or
+F<dist/Module-CoreList/lib/Module/CoreList/Utils.pm>.
-Check that file over carefully:
+Check those files over carefully:
$ git diff dist/Module-CoreList/lib/Module/CoreList.pm
+ $ git diff dist/Module-CoreList/lib/Module/CoreList.pod
+ $ git diff dist/Module-CoreList/lib/Module/CoreList/Utils.pm
-If necessary, bump C<$VERSION> (there's no need to do this for
-every RC; in RC1, bump the version to a new clean number that will
-appear in the final release, and leave as-is for the later RCs and final).
-It may also happen that C<Module::CoreList> has been modified in blead, and
-hence has a new version number already. (But make sure it is not the same
-number as a CPAN release.)
+=head4 Bump version in Module::CoreList F<Changes>
-Edit the version number in the new C<< 'Module::CoreList' => 'X.YZ' >>
-entry, as that is likely to reflect the previous version number.
+Also edit Module::CoreList's new version number in its F<Changes> file.
-Also edit Module::CoreList's new version number in its F<Changes>
-file.
+=head4 Add Module::CoreList version bump to perldelta
Add a perldelta entry for the new Module::CoreList version.
+=for checklist skip RC
+
+=head4 Update C<%Module::CoreList::released> and C<CAVEATS>
+
In addition, if this is a final release (rather than a release candidate):
-=over 4
+=over 4
=item *
=item *
Make sure that the script has correctly updated the C<CAVEATS> section
+(Note, the C<CAVEATS> section is in
+F<dist/Module-CoreList/lib/Module/CoreList.pod>)
=back
+=head4 Commit Module::CoreList changes
+
Finally, commit the new version of Module::CoreList:
(unless this is for MAINT; in which case commit it to blead first, then
cherry-pick it back).
- $ git commit -m 'Update Module::CoreList for 5.x.y' dist/Module-CoreList/lib/Module/CoreList.pm
+ $ git commit -m 'Update Module::CoreList for 5.x.y' dist/Module-CoreList/Changes dist/Module-CoreList/lib/Module/CoreList.pm dist/Module-CoreList/lib/Module/CoreList.pod dist/Module-CoreList/lib/Module/CoreList/Utils.pm
+=head4 Rebuild and test
-=head3 check MANIFEST
+Build and test to get the changes into the currently built lib directory and to ensure
+all tests are passing.
-Check that the manifest is sorted and correct:
+=head3 finalize perldelta
- $ make distclean
- $ git clean -xdf # This shouldn't be necessary if distclean is correct
- $ perl Porting/manicheck
+Finalize the perldelta. In particular, fill in the Acknowledgements
+section, which can be generated with something like:
+
+ $ perl Porting/acknowledgements.pl v5.15.0..HEAD
+
+Fill in the "New/Updated Modules" sections now that Module::CoreList is updated:
+
+ $ ./perl -Ilib Porting/corelist-perldelta.pl --mode=update pod/perldelta.pod
+
+Ideally, also fill in a summary of the major changes to each module for which
+an entry has been added by F<corelist-perldelta.pl>.
+
+Re-read the perldelta to try to find any embarrassing typos and thinkos;
+remove any C<TODO> or C<XXX> flags; update the "Known Problems" section
+with any serious issues for which fixes are not going to happen now; and
+run through pod and spell checkers, e.g.
+
+ $ podchecker -warnings -warnings pod/perldelta.pod
+ $ spell pod/perldelta.pod
+
+Also, you may want to generate and view an HTML version of it to check
+formatting, e.g.
+
+ $ ./perl -Ilib ext/Pod-Html/bin/pod2html pod/perldelta.pod > /tmp/perldelta.html
+
+Another good HTML preview option is http://search.cpan.org/pod2html
+
+If you make changes, be sure to commit them.
+
+=for checklist skip BLEAD-POINT MAINT RC
+
+=head3 remove stale perldeltas
-If manicheck turns up anything wrong, update MANIFEST and begin this step again.
+For the first RC release that is ONLY for a BLEAD-FINAL, the perldeltas
+from the BLEAD-POINT releases since the previous BLEAD-FINAL should have
+now been consolidated into the current perldelta, and hence are now just
+useless clutter. They can be removed using:
- $ ./configure -des -Dusedevel
- $ make test_porting
- $ git commit -m 'Update MANIFEST' MANIFEST
+ $ git rm <file1> <file2> ...
+For example, for RC0 of 5.16.0:
+
+ $ cd pod
+ $ git rm perldelta515*.pod
+
+=for checklist skip BLEAD-FINAL BLEAD-POINT
+
+=head3 add recent perldeltas
+
+For the first RC for a MAINT release, copy in any recent perldeltas from
+blead that have been added since the last release on this branch. This
+should include any recent maint releases on branches older than your one,
+but not newer. For example if you're producing a 5.14.x release, copy any
+perldeltas from recent 5.10.x, 5.12.x etc maint releases, but not from
+5.16.x or higher. Remember to
+
+ $ git add <file1> <file2> ...
+
+=head3 update and commit perldelta files
+
+If you have added or removed any perldelta files via the previous two
+steps, then edit F<pod/perl.pod> to add/remove them from its table of
+contents, then run F<Porting/pod_rules.pl> to propagate your changes there
+into all the other files that mention them (including F<MANIFEST>). You'll
+need to C<git add> the files that it changes.
+
+Then build a clean perl and do a full test
+
+ $ git status
+ $ git clean -dxf
+ $ ./Configure -Dusedevel -des
+ $ make
+ $ make test
+
+Once all tests pass, commit your changes.
+
+=head3 build a clean perl
+
+If you skipped the previous step (adding/removing perldeltas),
+again, make sure you have a gitwise-clean perl directory (no modified files,
+unpushed commits etc):
+
+ $ git status
+ $ git clean -dxf
+
+then configure and build perl so that you have a Makefile and porting tools:
+
+ $ ./Configure -Dusedevel -des && make
+
+=for checklist skip BLEAD-FINAL BLEAD-POINT
+
+=head3 synchronise from blead's perlhist.pod
+
+For the first RC for a MAINT release, copy in the latest
+F<pod/perlhist.pod> from blead; this will include details of newer
+releases in all branches. In theory, blead's version should be a strict
+superset of the one in this branch, but it's probably safest to diff them
+first to ensure that there's nothing in this branch that was forgotten
+from blead:
+
+ $ diff pod/perlhist.pod ..../blead/pod/perlhist.pod
+ $ cp ..../blead/pod/perlhist.pod pod/
+ $ git commit -m 'sync perlhist from blead' pod/perlhist.pod
+
+=for checklist skip RC
=head3 update perlhist.pod
sure that his or her name is listed in the section entitled
C<THE KEEPERS OF THE PUMPKIN>.
+I<If you're making a BLEAD-FINAL release>, also update the "SELECTED
+RELEASE SIZES" section with the output of
+F<Porting/perlhist_calculate.pl>.
+
Be sure to commit your changes:
$ git commit -m 'add new release to perlhist' pod/perlhist.pod
+=for checklist skip BLEAD-POINT
=head3 update patchlevel.h
$ git commit -m 'bump version to RCnnn' patchlevel.h
+=head3 run makemeta to update META files
+
+ $ ./perl -Ilib Porting/makemeta
+
+Be sure to commit any changes (if applicable):
+
+ $ git status # any changes?
+ $ git commit -m 'Update META files' META.*
=head3 build, test and check a fresh perl
Check that the output of C</tmp/perl-5.x.y-pretest/bin/perl -v> and
C</tmp/perl-5.x.y-pretest/bin/perl -V> are as expected,
especially as regards version numbers, patch and/or RC levels, and @INC
-paths. Note that as they have been been built from a git working
+paths. Note that as they have been built from a git working
directory, they will still identify themselves using git tags and
-commits.
-
-Then delete the temporary installation.
+commits. (Note that for an odd-numbered version, perl will install
+itself as C<perl5.x.y>). C<perl -v> will identify itself as:
+ This is perl 5, version X, subversion Y (v5.X.Y (v5.X.Z-NNN-gdeadbeef))
-=head3 push the work so far
-
-Push all your recent commits:
-
- $ git push origin ....
+where 5.X.Z is the latest tag, NNN the number of commits since this tag,
+and C<< deadbeef >> commit of that tag.
+Then delete the temporary installation.
-=head3 tag the release
+=head3 create the release tag
-Tag the release (e.g.):
+Create the tag identifying this release (e.g.):
$ git tag v5.11.0 -m "First release of the v5.11 series!"
and recreate it. Once you push your tag, we're stuck with it
and you'll need to use a new version number for your release.
-
=head3 build the tarball
Before you run the following, you might want to install 7-Zip (the
Create a tarball. Use the C<-s> option to specify a suitable suffix for
the tarball and directory name:
- $ cd root/of/perl/tree
- $ make distclean
- $ git clean -xdf # make sure perl and git agree on files
- $ git status # and there's nothing lying around
+ $ cd root/of/perl/tree
+ $ make distclean
+ $ git clean -xdf # make sure perl and git agree on files
+ $ git status # and there's nothing lying around
- $ perl Porting/makerel -b -s RC1 # for a release candidate
- $ perl Porting/makerel -b # for a final release
+ $ perl Porting/makerel -b -s RC1 # for a release candidate
+ $ perl Porting/makerel -b # for a final release
This creates the directory F<../perl-x.y.z-RC1> or similar, copies all
-the MANIFEST files into it, sets the correct permissions on them,
-adds DOS line endings to some, then tars it up as
-F<../perl-x.y.z-RC1.tar.gz>. With C<-b>, it also creates a C<tar.bz2> file.
+the MANIFEST files into it, sets the correct permissions on them, then
+tars it up as F<../perl-x.y.z-RC1.tar.gz>. With C<-b>, it also creates a
+C<tar.bz2> file.
If you're getting your tarball suffixed with -uncommitted and you're sure
your changes were all committed, you can override the suffix with:
$ rm -rf ../perl-x.y.z-RC1
-
=head3 test the tarball
-=over 4
+Once you have a tarball it's time to test the tarball (not the repository).
-=item *
+=head4 Copy the tarball to a web server
Copy the tarballs (.gz and possibly .bz2) to a web server somewhere you
have access to.
-=item *
+=head4 Download the tarball to another machine
-Download the tarball to some other machine. For a release candidate,
+Download the tarball to some other machine. For a release candidate,
you really want to test your tarball on two or more different platforms
and architectures. The #p5p IRC channel on irc.perl.org is a good place
to find willing victims.
-=item *
+=head4 Check that F<Configure> works
Check that basic configuration and tests work on each test machine:
$ ./Configure -des && make all test
-=item *
+=head4 Run the test harness and install
Check that the test harness and install work on each test machine:
$ ./Configure -des -Dprefix=/install/path && make all test_harness install
$ cd /install/path
-=item *
+=head4 Check C<perl -v> and C<perl -V>
Check that the output of C<perl -v> and C<perl -V> are as expected,
especially as regards version numbers, patch and/or RC levels, and @INC
-paths.
+paths.
Note that the results may be different without a F<.git/> directory,
which is why you should test from the tarball.
-=item *
-
-Run the Installation Verification Procedure utility:
+=head4 Run the Installation Verification Procedure utility
$ ./perl utils/perlivp
...
All tests successful.
$
-=item *
+=head4 Compare the installed paths to the last release
Compare the pathnames of all installed files with those of the previous
release (i.e. against the last installed tarball on this branch which you
find . -type f | sort > /tmp/f2
diff -u /tmp/f[12]
-=item *
+=head4 Bootstrap the CPAN client
Bootstrap the CPAN client on the clean install:
- $ bin/perl -MCPAN -e "shell"
+ $ bin/cpan
-If you're running this on Win32 you probably also need a set of Unix
-command-line tools available for CPAN to function correctly without
-Perl alternatives like LWP installed. Cygwin is an obvious choice.)
-
-=item *
+=head4 Install the Inline module with CPAN and test it
Try installing a popular CPAN module that's reasonably complex and that
has dependencies; for example:
42
$
-=item *
-
-Bootstrap the CPANPLUS client on the clean install:
-
- $ bin/cpanp
-
-(Again, on Win32 you'll need something like Cygwin installed, but make sure
-that you don't end up with its various F<bin/cpan*> programs being found on
-the PATH before those of the Perl that you're trying to test.)
-
-=item *
-
-Install an XS module, for example:
-
- CPAN Terminal> i DBI
- CPAN Terminal> quit
- $ bin/perl -MDBI -e 1
- $
-
-=item *
+=head4 Make sure that perlbug works
-Check that the L<perlbug> utility works. Try the following:
+Test L<perlbug> with the following:
$ bin/perlbug
...
Subject: test bug report
- Local perl administrator [yourself]:
- Editor [vi]:
- Module:
- Category [core]:
- Severity [low]:
+ Local perl administrator [yourself]:
+ Editor [vi]:
+ Module:
+ Category [core]:
+ Severity [low]:
(edit report)
Action (Send/Display/Edit/Subject/Save to File): f
- Name of file to save message in [perlbug.rep]:
+ Name of file to save message in [perlbug.rep]:
Action (Send/Display/Edit/Subject/Save to File): q
and carefully examine the output (in F<perlbug.rep]>), especially
delete the file, and try it again, this time actually submitting the bug
report. Check that it shows up, then remember to close it!
-=back
-
+=for checklist skip BLEAD-POINT
=head3 monitor smokes
+XXX This is probably irrelevant if working on a release branch, though
+MAINT or RC might want to push a smoke branch and wait.
+
Wait for the smoke tests to catch up with the commit which this release is
based on (or at least the last commit of any consequence).
to plead with people on IRC to test stuff on their platforms, fire away,
and then hope for the best.
-
=head3 upload to PAUSE
Once smoking is okay, upload it to PAUSE. This is the point of no return.
Upload both the .gz and .bz2 versions of the tarball.
-Wait until you receive notification emails from the PAUSE indexer
-confirming that your uploads have been received. IMPORTANT -- you will
-probably get an email that indexing has failed, due to module permissions.
-This is considered normal.
-
-Do not proceed any further until you are sure that your tarballs are on
-CPAN. Check your authors directory on one of the "fast" CPAN mirrors
-(e.g., cpan.hexten.net
-or cpan.cpantesters.org) to confirm that your uploads have been successful.
+Do not proceed any further until you are sure that your tarballs are on CPAN.
+Check your authors directory www.cpan.org (the globally balanced "fast"
+mirror) to confirm that your uploads have been successful.
+=for checklist skip RC BLEAD-POINT
-=head3 publish tag
+=head3 wait for indexing
-Now that you've shipped the new perl release to PAUSE, it's
-time to publish the tag you created earlier to the public git repo (e.g.):
+I<You MUST SKIP this step for RC and BLEAD-POINT>
- $ git push origin tag v5.11.0
+Wait until you receive notification emails from the PAUSE indexer
+confirming that your uploads have been received. IMPORTANT -- you will
+probably get an email that indexing has failed, due to module permissions.
+This is considered normal.
+=for checklist skip BLEAD-POINT
=head3 disarm patchlevel.h
Be sure to commit your change:
$ git commit -m 'disarm RCnnn bump' patchlevel.h
- $ git push origin ....
-
-
=head3 announce to p5p
Mail p5p to announce your new release, with a quote you prepared earlier.
+Use the template at Porting/release_announcement_template.txt
+
+Send a carbon copy to C<noc@metacpan.org>
+
+=head3 merge release branch back to blead
+
+Merge the (local) release branch back into master now, and delete it.
+
+ git checkout blead
+ git pull
+ git merge release-5.xx.yy
+ git push
+ git branch -d release-5.xx.yy
+
+Note: The merge will create a merge commit if other changes have been pushed
+to blead while you've been working on your release branch. Do NOT rebase your
+branch to avoid the merge commit (as you might normally do when merging a
+small branch into blead) since doing so will invalidate the tag that you
+created earlier.
+
+=head3 publish the release tag
+
+Now that you've shipped the new perl release to PAUSE and pushed your changes
+to the Perl master repository, it's time to publish the tag you created
+earlier too (e.g.):
+
+ $ git push origin tag v5.11.0
=head3 update epigraphs.pod
Add your quote to F<Porting/epigraphs.pod> and commit it.
+Your release announcement will probably not have reached the web-visible
+archives yet, so you won't be able to include the customary link to the
+release announcement yet.
+
+=head3 blog about your epigraph
+If you have a blog, please consider writing an entry in your blog explaining
+why you chose that particular quote for your epigraph.
+
+=for checklist skip RC
=head3 Module::CoreList nagging
Remind the current maintainer of C<Module::CoreList> to push a new release
to CPAN.
+=for checklist skip RC
=head3 new perldelta
Create a new perldelta.
-B<Note>: currently, the buildtoc below must be run in a I<built> perl source
-directory, as at least one of the pod files it expects to find is
-autogenerated: perluniprops.pod. But you can't build perl if you've added
-the new perldelta file and not updated toc. So, make sure you have a built
-perl (with a pod/perluniprops.pod file) now, I<before> continuing.
-
-First, update the F<pod/.gitignore> file to ignore the next
-release's generated F<pod/perlNNNdelta.pod> file rather than this release's
-one which we are about to set in stone (where NNN is the perl version number
-without the dots. i.e. 5135 for 5.13.5).
-
- $ (edit pod/.gitignore )
- $ git add pod/.gitignore
+=over 4
-Then, move the existing F<pod/perldelta.pod> to F<pod/perlNNNdelta.pod>,
-and edit the moved delta file to change the C<NAME> from C<perldelta> to
-C<perlNNNdelta>. For example, assuming you just released 5.10.1, and are
-about to create the 5.10.2 perldelta:
+=item *
- $ rm pod/perl5101delta.pod # remove the auto-generated file, if any
- $ git mv pod/perldelta.pod pod/perl5101delta.pod
- $ (edit pod/perl5101delta.pod to retitle)
- $ git add pod/perl5101delta.pod
+Confirm that you have a clean checkout with no local changes.
-Then create a new empty perldelta.pod file for the new release; see
-F<Porting/how_to_write_a_perldelta.pod>. You should be able to do this by
-just copying in a skeleton template and then doing a quick fix up of the
-version numbers. Then commit the move and the new file.
+=item *
- $ cp -i Porting/perldelta_template.pod pod/perldelta.pod
- $ (edit pod/perldelta.pod)
- $ git add pod/perldelta.pod
- $ git commit -m 'create perldelta for 5.10.2'
+Run F<Porting/new-perldelta.pl>
-=head3 update perldelta TOC and references
+=item *
-Now you need to update various tables of contents related to perldelta,
-most of which can be generated automatically.
+Run the C<git add> commands it outputs to add new and modified files.
-Edit F<pod.lst>: add the new entry for the perlNNNdelta file for the
-current version (the file that will be symlinked to perldelta).
+=item *
-Manually create a temporary link to the new delta file; normally this is
-done from the Makefile, but the Makefile is updated by buildtoc, and
-buildtoc won't run without the file there:
+Verify that the build still works, by running C<./Configure> and
+C<make test_porting>. (On Win32 use the appropriate make utility).
- $ ln -s perldelta.pod pod/perl5102delta.pod
+=item *
-Run C<perl pod/buildtoc --build-all> to update the F<perldelta> version in
-the following files:
+If F<t/porting/podcheck.t> spots errors in the new F<pod/perldelta.pod>,
+run C<./perl -MTestInit t/porting/podcheck.t | less> for more detail.
+Skip to the end of its test output to see the options it offers you.
- MANIFEST
- Makefile.SH
- pod/perl.pod
- vms/descrip_mms.template
- win32/Makefile
- win32/makefile.mk
- win32/pod.mak
+=item *
-Finally, commit:
+When C<make test_porting> passes, commit the new perldelta.
- $ git commit -a -m 'update TOC for perlNNNdelta'
+=back
At this point you may want to compare the commit with a previous bump to
-see if they look similar. See commit dd885b5 for an example of a
+see if they look similar. See commit ba03bc34a4 for an example of a
previous version bump.
+=for checklist skip MAINT RC
=head3 bump version
-I<You MUST SKIP this step for RC, BLEAD-POINT, MAINT>
+I<You MUST SKIP this step for RC and MAINT>
If this was a BLEAD-FINAL release (i.e. the first release of a new maint
series, 5.x.0 where x is even), then bump the version in the blead branch
in git, e.g. 5.12.0 to 5.13.0.
-First, add a new feature bundle to F<lib/feature.pm>, initially by just
-copying the exiting entry, and bump the file's $VERSION; e.g.
+First, add a new feature bundle to F<regen/feature.pl>, initially by just
+copying the exiting entry, and bump the file's $VERSION (after the __END__
+marker); e.g.
"5.14" => [qw(switch say state unicode_strings)],
+ "5.15" => [qw(switch say state unicode_strings)],
+Run F<regen/feature.pl> to propagate the changes to F<lib/feature.pm>.
+
Then follow the section L<"Bump the version number"> to bump the version
in the remaining files and test and commit.
+If this was a BLEAD-POINT release, then just follow the section
+L<"Bump the version number">.
+
+After bumping the version, follow the section L<"update INSTALL"> to
+ensure all version number references are correct.
=head3 clean build and test
In particular, F<Porting/perldelta_template.pod> is intentionally exempted
from podchecker tests, to avoid false positives about placeholder text.
However, once it's copied to F<pod/perldelta.pod> the contents can now
-cause test failures. Problems should resolved either by replacing placeholder
-text with correct text, or following the instructions output by
-F<t/porting/podcheck.t> on how to update its exceptions database.
+cause test failures. Problems should resolved by doing one of the
+following:
+
+=over
+
+=item 1
+
+Replace placeholder text with correct text.
+
+=item 2
+
+If the problem is from a broken placeholder link, you can add it to the
+array C<@perldelta_ignore_links> in F<t/porting/podcheck.t>. Lines
+containing such links should be marked with C<XXX> so that they get
+cleaned up before the next release.
+
+=item 3
+
+Following the instructions output by F<t/porting/podcheck.t> on how to
+update its exceptions database.
+
+=back
=head3 push commits
$ git push origin ....
+=for checklist skip BLEAD-POINT MAINT RC
=head3 create maint branch
$ git push origin -u maint-5.12
+=for checklist skip BLEAD-POINT MAINT RC
+
=head3 make the maint branch available in the APC
Clone the new branch into /srv/gitcommon/branches on camel so the APC will
And nag the sysadmins to make this directory available via rsync.
+XXX Who are the sysadmins? Contact info?
+
+=for checklist skip BLEAD-POINT RC
-=head3 copy perldelta.pod to other branches
+=head3 copy perldelta.pod to blead
I<You MUST SKIP this step for RC, BLEAD-POINT>
-Copy the perldelta.pod for this release into the other branches; for
-example:
+Copy the perldelta.pod for this release into blead; for example:
- $ cp -i ../5.10.x/pod/perldelta.pod pod/perl5101delta.pod # for example
- $ git add pod/perl5101delta.pod
+ $ cd ..../blead
+ $ cp -i ../5.10.x/pod/perldelta.pod pod/perl5101delta.pod # for example
+ $ git add pod/perl5101delta.pod
-Edit F<pod.lst> to add an entry for the file, e.g.:
+Don't forget to set the NAME correctly in the new file (e.g. perl5101delta
+rather than perldelta).
+
+Edit F<pod/perl.pod> to add an entry for the file, e.g.:
perl5101delta Perl changes in version 5.10.1
Then rebuild various files:
- $ perl pod/buildtoc --build-all
+ $ perl Porting/pod_rules.pl
-Finally, commit:
+Finally, commit and push:
$ git commit -a -m 'add perlXXXdelta'
+ $ git push origin ....
+=for checklist skip BLEAD-POINT
-=head3 update perlhist.pod in other branches
+=head3 copy perlhist.pod entries to blead
Make sure any recent F<pod/perlhist.pod> entries are copied to
-F<perlhist.pod> on other branches
-e.g.
+F<perlhist.pod> on blead. e.g.
5.8.9 2008-Dec-14
-
=head3 bump RT version number
-Log into http://rt.perl.org/ and check whether the new version is
-in the RT fields C<Perl Version> and C<Fixed In>. If not, send an
-email to C<perlbug-admin at perl.org> requesting this.
+Log into http://rt.perl.org/ and check whether the new version is in the RT
+fields C<Perl Version> and C<Fixed In>. The easiest way to determine this is to
+open up any ticket for modification and check the drop downs next to the
+C<Perl Version> and C<Fixed In> labels.
+
+Here, try this link: L<https://rt.perl.org/Ticket/Modify.html?id=10000>
+
+If the new version is not listed there, send an email to C<perlbug-admin at
+perl.org> requesting this.
=head3 Relax!
Thanks for releasing perl!
-
=head2 Building a release - the day after
+=head3 link announcement in epigraphs.pod
+
+Add, to your quote to F<Porting/epigraphs.pod>, a link to the release
+announcement in the web-visible mailing list archive. Commit it.
+
+=for checklist skip BLEAD-FINAL, MAINT, RC
+
+=head3 update Module::CoreList
+
+I<After a BLEAD-POINT release only>
+
+After Module::CoreList has shipped to CPAN by the maintainer, update
+Module::CoreList in the source so that it reflects the new blead
+version number:
+
+=over 4
+
+=item *
+
+Update F<Porting/Maintainers.pl> to list the new DISTRIBUTION on CPAN,
+which should be identical to what is currently in blead.
+
+=item *
+
+Bump the $VERSION in F<dist/Module-CoreList/lib/Module/CoreList.pm>,
+F<dist/Module-CoreList/lib/Module/CoreList/TieHashDelta.pm> and
+F<dist/Module-CoreList/lib/Module/CoreList/Utils.pm>.
+
+=item *
+
+If you have a local CPAN mirror, run:
+
+ $ ./perl -Ilib Porting/corelist.pl ~/my-cpan-mirror
+
+Otherwise, run:
+
+ $ ./perl -Ilib Porting/corelist.pl cpan
+
+This will update F<dist/Module-CoreList/lib/Module/CoreList.pm>,
+F<dist/Module-CoreList/lib/Module/CoreList.pod> and
+F<dist/Module-CoreList/lib/Module/CoreList/Utils.pm> as it did before,
+but this time adding new sections for the next BLEAD-POINT release.
+
+=item *
+
+Add the new $Module::CoreList::VERSION to
+F<dist/Module-CoreList/Changes>.
+
+=item *
+
+Update F<pod/perldelta.pod> to mention the upgrade to Module::CoreList.
+
+=item *
+
+Remake perl to get your changed .pm files propagated into F<lib/> and
+then run at least the F<dist/Module-CoreList/t/*.t> tests and the
+test_porting makefile target to check that they're ok.
+
+=item *
+
+Run
+
+ $ ./perl -Ilib -MModule::CoreList -le 'print Module::CoreList->find_version($]) ? "ok" : "not ok"'
+
+and check that it outputs "ok" to prove that Module::CoreList now knows
+about blead's current version.
+
+=item *
+
+Commit and push your changes.
+
+=back
+
=head3 check tarball availability
Check various website entries to make sure the that tarball has appeared
=item *
Check C</src> on CPAN (on a fast mirror) to ensure that links to
-the new tarballs have appeared. There should be links in C</src/5.0>
-(which is accumulating all new versions), links in C</src> (which shows
-only the latest version on each branch), and an appropriate mention in
-C</src/README.html> (which describes the latest versions).
+the new tarballs have appeared: There should be links in C</src/5.0>
+(which is accumulating all new versions), and (for BLEAD-FINAL and
+MAINT only) an appropriate mention in C</src/README.html> (which describes
+the latest versions in each stable branch, with links).
-These links should appear automatically, some hours after upload.
-If they don't, or the C<README.html> description is inadequate,
+The C</src/5.0> links should appear automatically, some hours after upload.
+If they don't, or the C</src> description is inadequate,
ask Ask <ask@perl.org>.
=item *
=back
+=for checklist skip RC
=head3 update dev.perl.org
-I<This step ONLY for BLEAD-FINAL and MAINT>
+I<You MUST SKIP this step for a RC release>
+
+In your C<perlweb> repository, link to the new release. For a new
+latest-maint release, edit F<docs/shared/tpl/stats.html>. Otherwise,
+edit F<docs/dev/perl5/index.html>.
+
+Then make a pull request to Leo Lapworth. If this fails for some reason
+and you cannot cajole anybody else into submitting that change, you can
+mail Leo as last resort.
+
+This repository can be found on L<github|https://github.com/perlorg/perlweb>.
+
+=head3 update release manager's guide
-Ask Leo Lapworth to update L<http://dev.perl.org/perl5/>.
+Go over your notes from the release (you did take some, right?) and update
+F<Porting/release_managers_guide.pod> with any fixes or information that
+will make life easier for the next release manager.
+=for checklist end
=head1 SOURCE
https://perl5.git.perl.org / perl5.git / blobdiff