Copyediting the release_managers_guide.

[p5sagit/p5-mst-13.2.git] / Porting / release_managers_guide.pod

=head1 NAME

release_managers_guide - Releasing a new version of perl 5.x

XXX as of Jul 2009, this file is still a work-in-progress. I think it
contains all the actions needed to build a release, but things may have
got skipped, and some things could do with polishing. Note that things
change each release, there may be new things not covered here, or
tools may need updating. DAPM

=head1 SYNOPSIS

This document describes the series of tasks required - some automatic, some
manual - to produce a perl release of some description, be that a snaphot,
release candidate, or final release.

The release process is primarily executed by the current pumpking.

This document both helps as a check-list for the pumpking 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:

    (5.10.1 is released, and post-release actions have been done)

    ...time passes...

    an occasional snapshot is released, that still identifies itself as
	5.10.1

    ...time passes...

    a few weeks before the release, a number of steps are performed,
	including bumping the version to 5.10.2

    ...a few weeks passes...

    perl-5.10.2-RC1 is released

    perl-5.10.2 is released

    post-release actions are performed, including creating new
	perl5103delta.pod

    ... the cycle continues ...

=head1 DETAILS


=head2 Prerequisites

Before you can make an official release of perl, there are a few
hoops you need to jump through:

=over 4

=item *

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=request_id

Check that your account is allowed to upload perl distros: goto
https://pause.perl.org/, login, then select 'upload file to CPAN'; there
should be a "For pumpkings only: Send a CC" tickbox.  If not, ask Andreas
König to add your ID to the list of people allowed to upload something
called perl.  You can find Andreas' email address at:
    
    https://pause.perl.org/pause/query?ACTION=pause_04imprint

=item *

You will need a working C<git> installation, checkout of the perl
git repository and perl commit bit.  For information about working
with perl and git, see F<pod/perlrepository.pod>.

If you are not yet a perl committer, you won't be able to make a
release.  Have a chat with whichever evil perl porter tried to talk
you into the idea in the first place to figure out the best way to
resolve the issue.

=back


=head2 Building a snapshot

A snapshot is intended to encourage in-depth testing from time-to-time,
for example after a key point in the stabilisation of a branch. It
requires fewer steps than a full release, and the version number of perl in
the tarball will usually be the same as that of the previous release.

=over 4

=item *

As there are no regular smokes [ XXX yet - please fix?] find out about the
state of the current branch on VMS. If the branch you're releasing on
is failing tests on VMS, you may not want to do a release.

=item *

Configure and build perl so that you have a Makefile and porting tools:

    $ ./Configure -Dusedevel -des
    $ make

=item *

Rebuild META.yml:

    $ rm META.yml
    $ make META.yml

Commit META.yml if it has changed:

    $ git commit -m 'Updating META.yml in preparation for release of 5.x.y' META.yml

=item *

Check that the manifest is sorted and correct:

    $ make manisort
    $ make distclean 
    $ perl Porting/manicheck


Commit MANIFEST if it has changed:

    $ git commit -m 'Updating MANIFEST in preparation for release of 5.x.y' MANIFEST



=item *

If this is a release candidate or final release, add an entry to
F<pod/perlhist.pod> with the current date, e.g.

          5.8.9-RC1     2008-Nov-10

Make sure the correct pumpking is listed, and if this is your first time,
append your name to C<THE KEEPERS OF THE PUMPKIN>.

=item *

Build perl, then make sure it passes its own test suite, and installs:

    $ ./Configure -des -Dusedevel -Dprefix=/tmp/perl-5.x.y-pretest
    $ make test install

=item *

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

    $ perl Porting/makerel -b -s `git describe` # for a snapshot
    $ 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.

XXX if we go for extra tags and branches stuff, then add the extra details
here

=item *

Copy the tarballs (.gz and possibly .bz2) to a web server somewhere you
have access to.

=item *

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 *

Check that basic configuration and tests work on each test machine:

    $ ./Configure -des && make all test

=item *

Check that the test harness and install work on each test machine:

    $ ./Configure -des -Dprefix=/install/path && make all test_harness install

=item *

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. 

Note that the results may be different without a F<.git/> directory,
which is why you should test from the tarball.

=item *

Bootstrap the CPAN client on the clean install:

    $ ./bin/perl -MCPAN -e'shell' 

=item *

Install Inline.pm 

    $ ./bin/perl -MCPAN -e'install Inline'

Check that your perl can run this:

    $ ./bin/perl -lwe 'use Inline C => "int answer() { return 42;} "; print answer'

=item *

Bootstrap the CPANPLUS client on the clean install:

    $ ./bin/cpanp


=item *

Install an XS module.

=item *

If all is well, announce the snapshot to p5p. (For a release candidate,
instead follow the further steps described later.)

=back

=head2  Actions prior to the first release candidate

A week or two before the first release candidate, there are some additional
tasks you should perform (actually, some of these should be done regularly
anyway, but they definitely need doing now):

=over 4

=item *

Check F<Maintainers.pl> for consistency; both these commands should
produce no output:

    $ perl Porting/Maintainers --checkmani
    $ perl Porting/Maintainers --checkmani lib/ ext/

=item *

Ensure that dual-life CPAN modules are synchronised with CPAN.  Basically,
run the following:

    $ ./perl -Ilib Porting/core-cpan-diff -a -o /tmp/corediffs

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.

To see which core distro versions differ from the current CPAN versions:

    $ ./perl -Ilib Porting/core-cpan-diff -x -a

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. 

=item *

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)

    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)

=item *

Similarly, monitor the smoking of core tests, and try to fix.

=item *

Similarly, monitor the smoking of perl for compiler warnings, and try to
fix.

=item *

Run F<Porting/cmpVERSION.pl> to compare the current source tree with the
previous version to check for for modules that have identical version
numbers but different contents, e.g.:

     $ cd ~/some-perl-root
     $ ./perl -Ilib Porting/cmpVERSION.pl -xd ~/my_perl-tarballs/perl-5.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.

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!

Once all version numbers have been bumped, re-run the checks.

Then run again without the -x option, to check that dual-life modules are
also sensible.

=item *

Check that files managed by F<regen.pl> and friends are up to date. From
within your working directory:


    $ git status
    $ make regen
    $ make regen_perly
    $ git status

If any of the files managed by regen.pl have changed, then you should commit
the updated versions:

    $ git commit -m 'Updated files generated by regen tools for perl 5.x.y' <list of files>


=item *

Get perldelta in a mostly finished state.

Peruse  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.

=item *

Bump the perl version number (e.g. from 5.10.0 to 5.10.1).

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
edit; then you feed this list back and it applies the edits. So, first
scan the source dir looking for likely  candidates:

    $ Porting/bump-perl-version -s 5.10.0 5.10.1 > /tmp/scan

This produces a file containing a list of suggested edits, eg:

    NetWare/Makefile

       89: -MODULE_DESC     = "Perl 5.10.0 for NetWare"
	   +MODULE_DESC     = "Perl 5.10.1 for NetWare"

i.e. in the file F<NetWare/Makefile>, line 89 would be changed as shown.
Review the file carefully, and delete any -/+ line pairs that you don't
want changing. Remember that this tool is largely just grepping for '5.10.0'
or whatever, so it will generate false positives. Be careful not change
text like "this was fixed in 5.10.0"! Then run:

    $ Porting/bump-perl-version -u < /tmp/scan

which will update all the files shown; then commit the changes.

Be particularly careful with F<INSTALL>, which contains a mixture of
C<5.10.0>-type strings, some of which need bumping on every release, and
some of which need to be left. Also note that this tool currently only
performs a single change per line, so in particular, this line in
README.vms needs special handling:

    rename perl-5^.10^.1.dir perl-5_10_1.dir


=item *

Review and update INSTALL to account for the change in version number;
in particular, the "Coexistence with earlier versions of perl 5" section.

=item *

Update the F<Changes> file to contain the git log command which would show
all the changes in this release. You will need assume the existence of a
not-yet created tag for the forthcoming release; e.g.

    git log ... perl-5.10.0..perl5.12.0

Due to warts in the perforce-to-git migration, some branches require extra
exclusions to avoid other branches being pulled in. Make sure you have the
correct incantation: replace the not-yet-created tag with C<HEAD> and see
if git log produces roughly the right number of commits across roughly the
right time period.


=item *

Check some more build configurations, e.g.

     -Duseshrplib -Dd_dosuid
     make suidperl

Check that setuid installs works (for < 5.11.0 only).
XXX any other configs?


=item *

Update F<AUTHORS>, using the C<Porting/checkAUTHORS.pl> script, and if
necessary, update the script to include new alias mappings.

XXX This script is currently broken (7/2009). It needs updating to work
with git and a lack of Changes files.

=back

=head2  Building a release candidate

(At this point you should already have performed the actions described in
L</"Actions prior to the first release candidate">.) You should review
that section to ensure that everything there has done, and to see whether
any of those actions (such as consistency checks) need to be repeated.

=over 4

=item *

Re-read the perldelta to try to find any embarrassing typos and thinkos;
remove any C<TODO> or C<XXX> flags; and run through pod and spell
checkers, e.g.

    podchecker -warnings -warnings pod/perl5101delta.pod
    spell pod/perl5101delta.pod

=item *

Update patchlevel.h to add a C<-RC1>-or-whatever string; or, if this is a
final release, remove it.  [ XXX how now?? see 34813 for old way ]

=item *

Update C<Module::Corelist>.

Note that if this is a maint release, you should run the following actions
from the maint directory, but edit the C<Corelist.pm> in I<blead> and
subsequently cherry-pick it.

corelist.pl uses ftp.funet.fi to verify information about dual-lifed
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'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.

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 chug for a while. Assuming all goes well, it will
 update lib/Module/CoreList.pm. 

Check that file over carefully:

    $ git diff lib/Module/CoreList.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).

Edit the version number in the new C<< 'Module::CoreList' => 'X.YZ' >>
entry, as that is likely to reflect the previous version number.




Add or update an entry to the C<%released> hash, including today's date
(if this is just a release candidate, set the date to '????-??-??').

Finally, commit the new version of Module::CoreList:

    $ git commit -m 'Updated Module::CoreList for the 5.x.y release' \
     lib/Module/Corelist.pm


=item *

Follow the instructions in the section L</"Building a snapshot">, then
carry on with the extra steps that follow here.

=item *

Disarm the patchlevel.h change [ XXX expand ]

=item *

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).

Then check that the smoke tests pass (particularly on Win32). If not, go
back and fix things.


=item *

Once smoking is okay, upload it to PAUSE. This is the point of no return.
If anything goes wrong after this point, you will need to re-prepare
a new release with a new minor version or RC number.

You may wish to create a .bz2 version of the tarball and upload that too.

=item *

Create a tag for the exact git revsion you built the release from:

    $ git tag perl-5.10.1-RC1 -m'Release Candidate 1 of Perl 5.10.1'
    $ git push origin tag perl-5.10.1-RC1

=item *

Mail p5p to announce your new release, with a quote you prepared earlier.

=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.)

=back


=head2  Making a final release

At this point you should have a working release candidate with few or no
changes since.

It's essentially the same procedure as for making a release candidate, but
with a whole bunch of extra post-release steps.

=over 4

=item *

Follow the same steps as for making a release candidate, then

=item *

Ask Jarkko to update http://www.cpan.org/src/README.html and
Rafael to update http://dev.perl.org/perl5/

=item *

Create a new empty perlNNNdelta.pod file for the current release + 1;
see F<Porting/how_to_write_a_perldelta.pod>.
[ XXX Perhaps we should have an empty template file we can copy in. ]

In addition, edit F<pod.lst>, adding the new entry as 'D', and unmark previous
entry as 'D', then run C<perl pod/buildtoc --build-all> to update the
following files:

    MANIFEST
    pod/perl.pod
    win32/pod.mak
    vms/descrip_mms.template

(F<vms/descrip_mms.template> still needs a manual edit to bump the
C<perldelta.pod> entry - it would be good for someone to figure out the fix.)

and change perlNNNdelta references to the new version in these files

    INSTALL
    win32/Makefile.mk
    win32/Makefile
    Makefile.SH
    README

Also, 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.

(see 16410843ea for an example).

=item *

If this was a maintenance release, then edit F<Porting/mergelog> to change
all the C<d> (deferred) flags to C<.> (needs review).


=item *

If this was a major release, then

=over

=item *

bump the version, e.g. 5.12.0 to 5.13.0;

=item * 

[ XXX probably lots more stuff to do, including perldelta,
C<lib/feature.pm> ]

=item *

Create a new maint branch with an empty Porting/mergelog file
[ XXX and lots of other stuff too, probably ]

=back

=item *

Copy the perlNNNdelta.pod for this release into the other branches, and
remember to update these files on those branches too:

    MANIFEST
    pod.lst
    pod/perl.pod
    vms/descrip_mms.template
    win32/pod.mak

(see fc5be80860 for an example).

=item *

Make sure any recent F<pod/perlhist.pod> entries are copied to
F<perlhist.pod> on other branches; typically the RC* and final entries,
e.g.

          5.8.9-RC1     2008-Nov-10
          5.8.9-RC2     2008-Dec-06
          5.8.9         2008-Dec-14

=item *

Remind the current maintainer of C<Module::CoreList> to push a new release
to CPAN.

=back

=head1 SOURCE

Based on
http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2009-05/msg00608.html,
plus a whole bunch of other sources, including private correspondence.

=cut