=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
=item *
-Restore any F<.gitignore> file. This can be done by issueing
+Restore any F<.gitignore> file. This can be done by issuing
C<git checkout .gitignore> in the F<cpan/Distro> directory.
=item *
=item *
-Run C<make>, see if C<perl> compiles.
+Run C<make> (or C<nmake> on Windows), see if C<perl> compiles.
=item *
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.
+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 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!
up-to-date.
-=head3 bump version number
+=head3 create a release branch
+
+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
-For a BLEAD-POINT release, if you did not bump the perl version number as
-part of I<advance actions>, do that now.
+ git checkout -b release-5.xx.yy
=head3 finalize perldelta
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-deadbeef))
+ This is perl 5, version X, subversion Y (v5.X.Y (v5.X.Z-NNN-gdeadbeef))
-where 5.X.Z is the latest tag, Z the number of commits since this tag,
+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.
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"
+ $ 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.)
-
-=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
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.
see if they look similar. See commit e3c71926d3 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:
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<perlorg> 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>.