+=encoding utf8
+
=head1 NAME
release_managers_guide - Releasing a new version of perl 5.x
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.
+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.
To see which core distro versions differ from the current CPAN versions:
I<You MAY SKIP this step for SNAPSHOT>
Similarly, monitor the smoking of core tests, and try to fix.
+See L<http://doc.procura.nl/smoke/index.html> for a summary.
=item *
numbers but different contents, e.g.:
$ cd ~/some-perl-root
- $ ./perl -Ilib Porting/cmpVERSION.pl -xd ~/my_perl-tarballs/perl-5.10.0 .
+ $ ./perl -Ilib Porting/cmpVERSION.pl -xd . v5.10.0
then bump the version numbers of any non-dual-life modules that have
changed since the previous release, but which still have the old version
number. If there is more than one maintenance branch (e.g. 5.8.x, 5.10.x),
then compare against both.
+Be sure to bump the version numbers in separate commits for each module
+(or group of related modules) so that changes can be cherry-picked later
+if necessary.
+
Note that some of the files listed may be generated (e.g. copied from ext/
to lib/, or a script like lib/lib_pm.PL is run to produce lib/lib.pm);
make sure you edit the correct file!
Then run again without the -x option, to check that dual-life modules are
also sensible.
- $ ./perl -Ilib Porting/cmpVERSION.pl -d ~/my_perl-tarballs/perl-5.10.0 .
+ $ ./perl -Ilib Porting/cmpVERSION.pl -d . v5.10.0
=item *
Get perldelta in a mostly finished state.
-
Peruse F<Porting/how_to_write_a_perldelta.pod>, and try to make sure that
+
Read F<Porting/how_to_write_a_perldelta.pod>, and try to make sure that
every section it lists is, if necessary, populated and complete. Copy
edit the whole document.
I<You MUST SKIP this step for SNAPSHOT>
-A week or two before the first release candidate, bump the perl version
-number (e.g. from 5.10.0 to 5.10.1), 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 bump the version further.
+Bump the version number (e.g. from 5.12.0 to 5.12.1).
+
+For a blead 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
+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
+bump the version further.
There is a tool to semi-automate this process. It works in two stages.
First, it generates a list of suggested changes, which you review and
rename perl-5^.10^.1.dir perl-5_10_1.dir
-Have a look a couple lines up from that. You'll see roman numerals.
-Update those too. Find someone with VMS clue if you have to update
-the Roman numerals for a .0 release.
+When doing a blead release, also make sure the C<PERL_API_*> constants in
+F<patchlevel.h> are in sync with the 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 stable perl version, the
+C<PERL_API_*> constants C<MUST NOT> be changed as we aim to guarantee binary
+compatibility in maint branches.
Commit your changes:
$ git st
- $ git diff
- B<review the delta carefully>
+ $ git diff
+ B<review the delta carefully>
$ git commit -a -m 'Bump the perl version in various places for 5.x.y'
Review and update INSTALL to account for the change in version number;
in particular, the "Coexistence with earlier versions of perl 5" section.
+Be particularly careful with the section "Upgrading from 5.X.Y or earlier". For
+stable releases, this needs to refer to the last release in the previous
+development cycle. For blead releases, it needs to refer to the previous blead
+release.
+
=item *
I<You MUST SKIP this step for SNAPSHOT>
I<You MAY SKIP this step for SNAPSHOT>
-Update F<AUTHORS>, using the C<Porting/checkAUTHORS.pl> script, and if
-necessary, update the script to include new alias mappings for porters
-already in F<AUTHORS>
-
- $ git log | perl Porting/checkAUTHORS.pl --acknowledged AUTHORS -
+L<perlport> has a section currently named I<Supported Platforms> that
+indicates which platforms are known to build in the current release.
+If necessary update the list and the indicated version number.
=back
=item *
+For a blead release, if you did not bump the perl version number as part
+of I<advance actions>, do that now.
+
+=item *
+
I<You MAY SKIP this step for SNAPSHOT>
+Finalize the perldelta. In particular, fill in the Acknowledgements
+section. You can generate a list of contributors with checkAUTHORS.pl.
+For example:
+
+ $ git log --pretty=fuller v5.13.2..HEAD | \
+ perl Porting/checkAUTHORS.pl --who -
+
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
$ perl pod/pod2html pod/perl5101delta.pod > /tmp/perl5101delta.html
+Another good HTML preview option is http://search.cpan.org/pod2html
+
+If you make changes, be sure to commit them.
+
=item *
Make sure you have a gitwise-clean perl directory (no modified files,
unpushed commits etc):
+ $ git clean -dxf
$ git status
=item *
within your working directory:
$ git status
- $ make regen
+ $ make regen_all
$ make regen_perly
$ git status
$ git commit -a -m 'make regen; make regen_perly'
-=item *
-
-Rebuild META.yml:
-
- $ rm META.yml
- $ make META.yml
- $ git diff
-
-XXX it would be nice to make Porting/makemeta use regen_lib.pl
-to get the same 'update the file if its changed' functionality
-we get with 'make regen' etc.
-
-Commit META.yml if it has changed:
-
- $ git commit -m 'Update META.yml' META.yml
+(XXX regen might be a problem depending on the bison version available.
+We need to get a wizard to give better instructions on what to do or not do.)
=item *
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 directory, but commit the C<Corelist.pm> changes in
-I<blead> and subsequently cherry-pick it.
+from the maint branch, but commit the C<Corelist.pm> changes in
+I<blead> and subsequently cherry-pick it. XXX need a better example
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.
+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.)
(If you'd prefer to have a full CPAN mirror, see
http://www.cpan.org/misc/cpan-faq.html#How_mirror_CPAN)
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 and
+in its F<META.yml> file.
+
In addition, if this is a final release (rather than a release candidate):
=over 4
=item *
-I<You MUST SKIP this step for SNAPSHOT>
+I<You MUST SKIP this step for SNAPSHOT or BLEAD release>
Update F<patchlevel.h> to add a C<-RC1>-or-whatever string; or, if this is
a final release, remove it. For example:
I<You MUST SKIP this step for SNAPSHOT>
-Tag the release:
+Tag the release (e.g.):
$ git tag v5.11.0 -m'First release of the v5.11 series!'
+(Adjust the syntax appropriately if you're working on Win32, i.e. use
+C<-m "..."> rather than C<-m'...'>.)
+
It is VERY important that from this point forward, you not push
your git changes to the Perl master repository. If anything goes
wrong before you publish your newly-created tag, you can delete
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.
+If you're getting your tarball suffixed with -uncommitted and you're sure
+your changes were all committed, you can override the suffix with:
+
+ $ perl Porting/makerel -b -s ''
XXX if we go for extra tags and branches stuff, then add the extra details
here
$ bin/perl -MCPAN -e'shell'
+(Use C<... -e "shell"> instead 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 *
Try installing a popular CPAN module that's reasonably complex and that
42
$
+(Use C<... -lwe "use ..."> instead on Win32.)
+
=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:
(Login, then select 'Upload a file to CPAN')
+If your workstation is not connected to a high-bandwidth,
+high-reliability connection to the Internet, you should probably use the
+"GET URL" feature (rather than "HTTP UPLOAD") to have PAUSE retrieve the
+new release from wherever you put it for testers to find it. This will
+eliminate anxious gnashing of teeth while you wait to see if your
+15 megabyte HTTP upload successfully completes across your slow, twitchy
+cable modem. You can make use of your home directory on dromedary for
+this purpose: F<http://users.perl5.git.perl.org/~USERNAME> maps to
+F</home/USERNAME/public_html>, where F<USERNAME> is your login account
+on dromedary. I<Remember>: if your upload is partially successful, you
+may need to contact a PAUSE administrator or even bump the version of perl.
+
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 dual-life modules,
+apparently). 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.shadowcatprojects.net, cpan.dagolden.com, cpan.hexten.net
+or cpan.cpantesters.org) to confirm that your uploads have been successful.
+
=item *
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:
+time to publish the tag you created earlier to the public git repo (e.g.):
$ git push origin tag v5.11.0
=item *
+Add your quote to F<Porting/epigraphs.pod> and commit it.
+
+=item *
+
Wait 24 hours or so, then post the announcement to use.perl.org.
(if you don't have access rights to post news, ask someone like Rafael to
do it for you.)
=item *
-Ask Jarkko to add the tarball to http://www.cpan.org/src/
+Check http://www.cpan.org/src/ to see if the new tarballs have appeared.
+They should appear automatically, but if they don't then ask Jarkko to look
+into it, since his scripts must have broken.
=item *
I<You MUST SKIP this step for RC>
-Bump the perlXYZ version number.
+Bump the perlXYZdelta version number.
First, create a new empty perlNNNdelta.pod file for the current release + 1;
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, e.g.
+Then commit this file. (If this new perldelta needs to get cherrypicked
+anywhere, this provides a clean base to merge from.)
+
+For example, assuming 5.10.2:
+
$ cp -i Porting/perldelta_template.pod pod/perl5102delta.pod
$ (edit it)
$ git add pod/perl5102delta.pod
+ $ git commit -m 'create perl5102delta'
+
+Edit the previous delta file to change the C<NAME> from C<perldelta>
+to C<perlNNNdelta> and commit it. For example:
+
+ $ git add pod/perl5101delta.pod
+ $ git commit -m 'retitle perl5101delta'
+
+Now you need to update various tables of contents, most of which can be
+generated automatically.
Edit F<pod.lst>: add the new entry, flagged as 'D', and unflag the previous
entry from being 'D'; for example:
INSTALL
README
-Edit the previous delta file to change the C<NAME> from C<perldelta>
-to C<perlNNNdelta>.
-
These two lists of files probably aren't exhaustive; do a recursive grep
on the previous filename to look for suitable candidates that may have
been missed.
Finally, commit:
- $ git commit -a -m 'create perlXXXdelta'
+ $ git commit -a -m 'update TOC and perldelta references'
At this point you may want to compare the commit with a previous bump to
see if they look similar. See commit ca8de22071 for an example of a
I<You MUST SKIP this step for RC, BLEAD>
-If this was a major release (5.x.0), then create a new maint branch
-based on the commit tagged as the current release and bump the version
-in the blead branch in git, e.g. 5.12.0 to 5.13.0.
+If this was the first release of a new maint series, (5.x.0 where x is
+even), then create a new maint branch based on the commit tagged as
+the current release and bump the version in the blead branch in git,
+e.g. 5.12.0 to 5.13.0.
[ XXX probably lots more stuff to do, including perldelta,
C<lib/feature.pm> ]
-XXX need a git recipe
+Assuming you're using git 1.7.x or newer:
+
+ $ git checkout -b maint-5.12
+ $ git push origin -u maint-5.12
=item *
=item *
+If necessary, send an email to C<perlbug-admin at perl.org> requesting
+that new version numbers be added to the RT fields C<Perl Version> and
+C<Fixed In>.
+
+=item *
+
I<You MUST RETIRE to your preferred PUB, CAFE or SEASIDE VILLA for some
much-needed rest and relaxation>.
https://perl5.git.perl.org / perl5.git / blobdiff