=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 C<.gitignore> file. This can be done by issueing
-C<git checkout .gitignore> in the C<cpan/Distro> directory.
+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
C<Porting/Maintainer.pl>, and anything that
+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 *
For any files that have an execute bit set, either remove the execute
-bit, or edit
C<Porting/exec-bit.txt>
+bit, or edit
F<Porting/exec-bit.txt>
=item *
=item *
-Run the tests in C<t/porting>.
+Run the tests in F<t/porting>.
=item *
-Update the C<DISTRIBUTION> entry in
C<Porting/Maintainers.pl>.
+Update the C<DISTRIBUTION> entry in
F<Porting/Maintainers.pl>.
=item *
For entries with a non-simple C<FILES> section, or with a C<MAP>, you
may have to take more steps than listed above.
-
C<Porting/sync-with-cpan> is a script that automates most of the steps
+
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.
=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 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
+
+ git checkout -b release-5.xx.yy
+
+
=head3 bump version number
For a BLEAD-POINT release, if you did not bump the perl version number as
=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
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.
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
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>.
=for checklist end
https://perl5.git.perl.org / perl5.git / blobdiff