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 checklist of a typical release cycle is as follows:
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 Building a release - advance actions
-The work of building a release candidate for an even 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.
+Passing C<-u cpan> (and maybe C<-u undef>) will probably be helpful, since
+those are the only types of distributions that you can actually affect as a
+perl release manager (as opposed to a CPAN module maintainer).
-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
+
+then fix the core, or cajole CPAN authors as appropriate. 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.
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<@IGNORE> 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
+in in 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
=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.
=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
$ 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!
$ 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 0e79a3d1bc for an example of a
previous version bump.
When the version number is bumped, you should also update Module::CoreList
=head3 Check more build configurations
-Check some more build configurations.
+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 -Dusesitecustomize
- $ make
- $ make test
+=over 4
+
+=item *
+
+C<-Duseshrplib -Dusesitecustomize>
+
+=item *
+
+C<-Duserelocatableinc>
+
+=item *
+
+C<-Dusethreads>
-XXX think of other configurations that need testing.
+=back
+If you have multiple compilers on your machine, you might also consider
+compiling with C<-Dcc=$other_compiler>.
=head3 update perlport
up-to-date.
-=head3 bump version number
+=head3 create a release branch
-For a BLEAD-POINT release, if you did not bump the perl version number as
-part of I<advance actions>, do that now.
+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 finalize perldelta
maint release and then your recent commit. 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. (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,
Edit the version number in the new C<< 'Module::CoreList' => 'X.YZ' >>
entry, as that is likely to reflect the previous version number.
+=head4 Bump C<$Module::CoreList::TieHashDelta::VERSION>
+
+C<$Module::CoreList::TieHashDelta::VERSION> should always be equal to
+C<$Module::CoreList::VERSION>. Make sure the two versions match before
+proceeding.
+
+Edit the version number in the new
+C<< 'Module::CoreList::TieHashDelta' => 'X.YZ' >> entry, as that is likely to
+reflect the previous version number.
+
=head4 Bump version in Module::CoreList F<Changes>
Also edit Module::CoreList's new version number in its F<Changes>
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
(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/lib/Module/CoreList.pm dist/Module-CoreList/lib/Module/CoreList.pod
=for checklist skip RC
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
$ 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
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
directory, they will still identify themselves using git tags and
-commits.
+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))
+
+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.
Push all your recent commits:
- $ git push origin ....
-
+ $ git push origin release-5.xx.yy
=head3 tag the release
=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.
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.
find . -type f | sort > /tmp/f2
diff -u /tmp/f[12]
-=head4 Test the CPAN client
+=head4 Bootstrap the CPAN client
Bootstrap the CPAN client on the clean install:
- $ bin/perl -MCPAN -e "shell"
-
-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.)
+ $ bin/cpan
-=head4 Install the Inline module and test it
+=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:
$ 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.)
-
=head4 Install the DBI module with CPANPLUS
CPAN Terminal> i DBI
$ 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
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
+
+If you made a release branch for this release, merge it back into master now,
+and delete it.
+
+ git checkout blead
+ git pull
+ git merge release-5.xx.yy
+ git push
+ git push origin :release-5.xx.yy
+ git branch -d release-5.xx.yy
+
=head3 update epigraphs.pod
Add your quote to F<Porting/epigraphs.pod> and commit it.
=item *
Verify that the build still works, by running C<./Configure> and
-C<make test_porting>. (On Win32, run C<nmake> and
-C<nmake test TEST_FILES="porting\*.t ..\lib\diagnostics.t">.)
+C<make test_porting>. (On Win32 use the appropriate make utility).
=item *
=back
At this point you may want to compare the commit with a previous bump to
-see if they look similar. See commit e3c71926d3 for an example of a
+see if they look similar. See commit 4eabcf701b for an example of a
previous version bump.
-=for checklist skip BLEAD-POINT MAINT RC
+=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
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">.
+
=head3 clean build and test
Then rebuild various files:
- $ perl pod/buildtoc --build-all
+ $ perl Porting/pod_rules.pl
Finally, commit:
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).
+(which is accumulating all new versions), and an appropriate mention in
+C</src> (which describes the latest versions in each branch, with links).
These links should appear automatically, some hours after upload.
-If they don't, or the C<README.html> description is inadequate,
+If they don't, or the C</src> description is inadequate,
ask Ask <ask@perl.org>.
=item *
I<You MUST SKIP this step for a RC release>
-In the C<perlorg> repository, edit F<docs/dev/perl5/index.html>
-to link to this new release. 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.
+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>.
=for checklist end
https://perl5.git.perl.org / perl5.git / blobdiff