"Fossies" - the Fresh Open Source Software Archive  

Source code changes of the file "Porting/release_managers_guide.pod" between
perl-5.35.11.tar.xz and perl-5.36.0-RC2.tar.xz

About: Perl (Practical Extraction and Report Language) is a high-level, general-purpose, interpreted, dynamic programming language.
Release candidate.

release_managers_guide.pod  (perl-5.35.11.tar.xz):release_managers_guide.pod  (perl-5.36.0-RC2.tar.xz)
skipping to change at line 18 skipping to change at line 18
covered here, or tools may need updating. covered here, or tools may need updating.
=head1 MAKING A CHECKLIST =head1 MAKING A CHECKLIST
If you are preparing to do a release, you can run the If you are preparing to do a release, you can run the
F<Porting/make-rmg-checklist> script to generate a new version of this F<Porting/make-rmg-checklist> script to generate a new version of this
document that starts with a checklist for your release. document that starts with a checklist for your release.
This script is run as: This script is run as:
perl Porting/make-rmg-checklist \ perl Porting/make-rmg-checklist \
--version [5.x.y-RC#] > /tmp/rmg.pod --version [5.x.y-RC#] > /tmp/rmg.pod
You can also pass the C<--html> flag to generate an HTML document instead of You can also pass the C<--html> flag to generate an HTML document instead of
POD. POD.
perl Porting/make-rmg-checklist --html \ perl Porting/make-rmg-checklist --html \
--version [5.x.y-RC#] > /tmp/rmg.html --version [5.x.y-RC#] > /tmp/rmg.html
=head1 SYNOPSIS =head1 SYNOPSIS
This document describes the series of tasks required - some automatic, some This document describes the series of tasks required - some automatic, some
manual - to produce a perl release of some description, be that a release manual - to produce a perl release of some description, be that a release
candidate, or final, numbered release of maint or blead. candidate, or final, numbered release of maint or blead.
New releases of perl are made each month on the 20th by a release engineer New releases of perl are made each month on the 20th by a release engineer
appointed by the Steering Council. The release engineer roster and schedule appointed by the Steering Council. The release engineer roster and schedule
can be found in Porting/release_schedule.pod. can be found in Porting/release_schedule.pod.
This document both helps as a check-list for the release engineer 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 and is a base for ideas on how the various tasks could be automated
or distributed. or distributed.
The checklist of a typical release cycle is as follows: The checklist of a typical release cycle is as follows:
(5.10.1 is released, and post-release actions have been done) (5.10.1 is released, and post-release actions have been done)
...time passes... ...time passes...
a few weeks before the release, a number of steps are performed, a few weeks before the release, a number of steps are performed,
including bumping the version to 5.10.2 including bumping the version to 5.10.2
...a few weeks pass... ...a few weeks pass...
perl-5.10.2-RC1 is released perl-5.10.2-RC1 is released
perl-5.10.2 is released perl-5.10.2 is released
post-release actions are performed, including creating new post-release actions are performed, including creating new
perldelta.pod perldelta.pod
... the cycle continues ... ... the cycle continues ...
=head1 DETAILS =head1 DETAILS
Some of the tasks described below apply to all four types of Some of the tasks described below apply to all four types of
release of Perl. (blead, RC, final release of maint, final release of Perl. (blead, RC, final release of maint, final
release of blead). Some of these tasks apply only to a subset 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 type of release, you will see a notation to that effect at
the beginning of the step. the beginning of the step.
skipping to change at line 132 skipping to change at line 132
=head2 Prerequisites =head2 Prerequisites
Before you can make an official release of perl, there are a few Before you can make an official release of perl, there are a few
hoops you need to jump through: hoops you need to jump through:
=head3 PAUSE account with pumpkin status =head3 PAUSE account with pumpkin status
Make sure you have a PAUSE account suitable for uploading a perl release. Make sure you have a PAUSE account suitable for uploading a perl release.
If you don't have a PAUSE account, then request one: If you don't have a PAUSE account, then request one:
https://pause.perl.org/pause/query?ACTION=request_id https://pause.perl.org/pause/query?ACTION=request_id
Check that your account is allowed to upload perl distros: go to Check that your account is allowed to upload perl distros: go to
L<https://pause.perl.org/pause/authenquery?ACTION=who_pumpkin> and check that L<https://pause.perl.org/pause/authenquery?ACTION=who_pumpkin> and check that
your PAUSE ID is listed there. If not, ask Andreas KE<0xf6>nig to add your ID your PAUSE ID is listed there. If not, ask Andreas KE<0xf6>nig to add your ID
to the list of people allowed to upload something called perl. You can find to the list of people allowed to upload something called perl. You can find
Andreas' email address at: Andreas' email address at:
https://pause.perl.org/pause/query?ACTION=pause_04imprint https://pause.perl.org/pause/query?ACTION=pause_04imprint
=head3 GitHub access =head3 GitHub access
You will need a working C<git> installation, checkout of the perl You will need a working C<git> installation, checkout of the perl
git repository and perl commit bit. For information about working git repository and perl commit bit. For information about working
with perl and git, see F<pod/perlgit.pod>. with perl and git, see L<perlgit>.
If you are not yet a perl committer, you won't be able to make a If you are not yet a perl committer, you won't be able to make a
release. You will need to have a GitHub account (if you don't have one) release. You will need to have a GitHub account (if you don't have one)
and contact the Steering Council with your username to get membership in the and contact the Steering Council with your username to get membership in the
L<< Perl-Releasers|https://github.com/orgs/Perl/teams/perl-releasers >> team. L<< Perl-Releasers|https://github.com/orgs/Perl/teams/perl-releasers >> team.
=head3 web-based file share =head3 web-based file share
You will need to be able to share tarballs with #p5p members for You will need to be able to share tarballs with #p5p members for
pre-release testing, and you may wish to upload to PAUSE via URL. pre-release testing, and you may wish to upload to PAUSE via URL.
skipping to change at line 195 skipping to change at line 195
The work of building a release candidate for an even numbered release The work of building a release candidate for an even numbered release
(BLEAD-FINAL) of perl generally starts several weeks before the first (BLEAD-FINAL) of perl generally starts several weeks before the first
release candidate. Some of the following steps should be done regularly, release candidate. Some of the following steps should be done regularly,
but all I<must> be done in the run up to a release. but all I<must> be done in the run up to a release.
=head3 dual-life CPAN module synchronisation =head3 dual-life CPAN module synchronisation
To see which core distro versions differ from the current CPAN versions: To see which core distro versions differ from the current CPAN versions:
$ ./perl -Ilib Porting/core-cpan-diff -x -a $ ./perl -Ilib Porting/core-cpan-diff -x -a
However, this only checks whether the version recorded in However, this only checks whether the version recorded in
F<Porting/Maintainers.pl> differs from the latest on CPAN. It doesn't tell you F<Porting/Maintainers.pl> differs from the latest on CPAN. It doesn't tell you
if the code itself has diverged from CPAN. if the code itself has diverged from CPAN.
You can also run an actual diff of the contents of the modules, comparing core 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 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: be dealt with. You do this by not passing the C<-x> option:
$ ./perl -Ilib Porting/core-cpan-diff -a -o ~/corediffs $ ./perl -Ilib Porting/core-cpan-diff -a -o ~/corediffs
Passing C<-u cpan> will probably be helpful, since it limits the search to Passing C<-u cpan> will probably be helpful, since it limits the search to
distributions with 'cpan' upstream source. (It's OK for blead upstream to distributions with 'cpan' upstream source. (It's OK for blead upstream to
differ from CPAN because those dual-life releases usually come I<after> perl differ from CPAN because those dual-life releases usually come I<after> perl
is released.) is released.)
See also the C<-d> and C<-v> options for more detail (and the C<-u> option as 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 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 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, you made a local CPAN mirror. Note that a minicpan mirror won't actually work,
skipping to change at line 245 skipping to change at line 245
have some extra changes. have some extra changes.
In any case, any cpan-first distribution that is listed as having files In any case, any cpan-first distribution that is listed as having files
"Customized for blead" in the output of cpan-core-diff should have requests "Customized for blead" in the output of cpan-core-diff should have requests
submitted to the maintainer(s) to make a cpan release to catch up with blead. submitted to the maintainer(s) to make a cpan release to catch up with blead.
Additionally, all files listed as "modified" but not "customized for blead" Additionally, all files listed as "modified" but not "customized for blead"
should have entries added under the C<CUSTOMIZED> key in should have entries added under the C<CUSTOMIZED> key in
F<Porting/Maintainers.pl>, as well as checksums updated via: F<Porting/Maintainers.pl>, as well as checksums updated via:
cd t; ../perl -I../lib porting/customized.t --regen cd t; ../perl -I../lib porting/customized.t --regen
=head4 Sync CPAN modules with the corresponding cpanE<sol> distro =head4 Sync CPAN modules with the corresponding cpanE<sol> distro
In most cases, once a new version of a distribution shipped with core has been In most cases, once a new version of a distribution shipped with core has been
uploaded to CPAN, the core version thereof can be synchronized automatically uploaded to CPAN, the core version thereof can be synchronized automatically
with the program F<Porting/sync-with-cpan>. (But see the comments at the with the program F<Porting/sync-with-cpan>. (But see the comments at the
beginning of that program. In particular, it has not yet been exercised on beginning of that program. In particular, it has not yet been exercised on
Windows as much as it has on Unix-like platforms.) Windows as much as it has on Unix-like platforms.)
If, however, F<Porting/sync-with-cpan> does not provide good results, follow If, however, F<Porting/sync-with-cpan> does not provide good results, follow
skipping to change at line 344 skipping to change at line 344
=back =back
For entries with a non-simple C<FILES> section, or with a C<MAP>, you For entries with a non-simple C<FILES> section, or with a C<MAP>, you
may have to take more steps than listed above. may have to take more steps than listed above.
=head3 Ensure dual-life CPAN module stability =head3 Ensure dual-life CPAN module stability
This comes down to: This comes down to:
for each module that fails its regression tests on $current for each module that fails its regression tests on $current
did it fail identically on $previous? did it fail identically on $previous?
if yes, "SEP" (Somebody Else's Problem, but try to make sure a if yes, "SEP" (Somebody Else's Problem, but try to make sure a
bug ticket is filed) bug ticket is filed)
else work out why it failed (a bisect is useful for this) else work out why it failed (a bisect is useful for this)
attempt to group failure causes attempt to group failure causes
for each failure cause for each failure cause
is that a regression? is that a regression?
if yes, figure out how to fix it if yes, figure out how to fix it
(more code? revert the code that broke it) (more code? revert the code that broke it)
else else
(presumably) it's relying on something un-or-under-documented (presumably) it's relying on something un-or-under-documented
should the existing behaviour stay? should the existing behaviour stay?
yes - goto "regression" yes - goto "regression"
no - note it in perldelta as a significant bugfix no - note it in perldelta as a significant bugfix
(also, try to inform the module's author) (also, try to inform the module's author)
=head3 monitor smoke tests for failures =head3 monitor smoke tests for failures
Similarly, monitor the smoking of core tests, and try to fix. See Similarly, monitor the smoking of core tests, and try to fix. See
L<https://tux.nl/perl5/smoke/index.html>, L<https://perl5.test-smoke.org/> L<https://tux.nl/perl5/smoke/index.html>, L<https://perl5.test-smoke.org/>
and L<http://perl.develop-help.com> for a summary. See also and L<http://perl.develop-help.com> for a summary. See also
L<https://www.nntp.perl.org/group/perl.daily-build.reports/> which has L<https://www.nntp.perl.org/group/perl.daily-build.reports/> which has
the raw reports. the raw reports.
Similarly, monitor the smoking of perl for compiler warnings, and try to Similarly, monitor the smoking of perl for compiler warnings, and try to
skipping to change at line 418 skipping to change at line 418
Increase the version number (e.g. from 5.12.0 to 5.12.1). Increase the version number (e.g. from 5.12.0 to 5.12.1).
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 before the first release candidate to allow sufficient time for testing and
smoking with the target version built into the perl executable. For smoking with the target version built into the perl executable. For
subsequent release candidates and the final release, it is not necessary to subsequent release candidates and the final release, it is not necessary to
bump the version further. bump the version further.
There is a tool to semi-automate this process: There is a tool to semi-automate this process:
$ ./perl -Ilib Porting/bump-perl-version -i 5.10.0 5.10.1 $ ./perl -Ilib Porting/bump-perl-version -i 5.10.0 5.10.1
Remember that this tool is largely just grepping for '5.10.0' or whatever, 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 so it will generate false positives. Be careful not change text like
"this was fixed in 5.10.0"! "this was fixed in 5.10.0"!
Use git status and git diff to select changes you want to keep. Use git status and git diff to select changes you want to keep.
Be particularly careful with F<INSTALL>, which contains a mixture of 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 C<5.10.0>-type strings, some of which need bumping on every release, and
some of which need to be left unchanged. some of which need to be left unchanged.
skipping to change at line 527 skipping to change at line 527
Note: It should not be harmful to use a wider range. Note: It should not be harmful to use a wider range.
Note: If you have uncommitted changes this could cause some warnings, Note: If you have uncommitted changes this could cause some warnings,
and you might like to use the additional argument C<--to=upstream/blead> and you might like to use the additional argument C<--to=upstream/blead>
to use the last known git commit by GitHub. to use the last known git commit by GitHub.
Review the changes to the AUTHORS file, be sure you are not adding duplicate Review the changes to the AUTHORS file, be sure you are not adding duplicate
entries or removing any entries, then commit your changes. entries or removing any entries, then commit your changes.
$ git commit -a AUTHORS -m 'Update AUTHORS list for 5.x.y' $ git commit -a AUTHORS -m 'Update AUTHORS list for 5.x.y'
=head3 Check copyright years =head3 Check copyright years
Check that the copyright years are up to date by running: Check that the copyright years are up to date by running:
$ pushd t; ../perl -I../lib porting/copyright.t --now $ pushd t; ../perl -I../lib porting/copyright.t --now
Remedy any test failures by editing README or perl.c accordingly (search for Remedy any test failures by editing README or perl.c accordingly (search for
the "Copyright"). If updating perl.c, check if the file's own copyright date in the "Copyright"). If updating perl.c, check if the file's own copyright date in
the C comment at the top needs updating, as well as the one printed by C<-v>. the C comment at the top needs updating, as well as the one printed by C<-v>.
=head3 Check more build configurations =head3 Check more build configurations
Try running the full test suite against multiple Perl configurations. Here are Try running the full test suite against multiple Perl configurations. Here are
some sets of Configure flags you can try: some sets of Configure flags you can try:
skipping to change at line 597 skipping to change at line 597
L<"Building a release - advance actions"> to ensure they are all done and L<"Building a release - advance actions"> to ensure they are all done and
up-to-date. up-to-date.
=head3 create a release branch =head3 create a release branch
For BLEAD-POINT releases, making a release from a release branch avoids the 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 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 BLEAD-FINAL, MAINT, and RC releases, since blead will already be frozen in
those cases. Create the branch by running those cases. Create the branch by running
git checkout -b release-5.xx.yy git checkout -b release-5.xx.yy
=head3 build a clean perl =head3 build a clean perl
Make sure you have a gitwise-clean perl directory (no modified files, Make sure you have a gitwise-clean perl directory (no modified files,
unpushed commits etc): unpushed commits etc):
$ git status $ git status
$ git clean -dxf $ git clean -dxf
then configure and build perl so that you have a Makefile and porting tools: then configure and build perl so that you have a Makefile and porting tools:
$ ./Configure -Dusedevel -des && make $ ./Configure -Dusedevel -des && make
=head3 Check module versions =head3 Check module versions
For each Perl release since the previous release of the current branch, check For each Perl release since the previous release of the current branch, check
for modules that have identical version numbers but different contents by for modules that have identical version numbers but different contents by
running: running:
$ ./perl -Ilib Porting/cmpVERSION.pl --tag=v5.X.YY $ ./perl -Ilib Porting/cmpVERSION.pl --tag=v5.X.YY
(This is done automatically by F<t/porting/cmp_version.t> for the previous (This is done automatically by F<t/porting/cmp_version.t> for the previous
release of the current branch, but not for any releases from other branches.) release of the current branch, but not for any releases from other branches.)
Any modules that fail will need a version bump, plus a nudge to the upstream Any modules that fail will need a version bump, plus a nudge to the upstream
maintainer for 'cpan' upstream modules. maintainer for 'cpan' upstream modules.
=head3 update Module::CoreList =head3 update Module::CoreList
=head4 Bump Module::CoreList* $VERSIONs =head4 Bump Module::CoreList* $VERSIONs
skipping to change at line 668 skipping to change at line 668
I<blead> and subsequently cherry-pick any releases since the last I<blead> and subsequently cherry-pick any releases since the last
maint release and then your recent commit. XXX need a better example maint release and then your recent commit. XXX need a better example
[ Note that the procedure for handling Module::CoreList in maint branches [ Note that the procedure for handling Module::CoreList in maint branches
is a bit complex, and the RMG currently don't describe a full and is a bit complex, and the RMG currently don't describe a full and
workable approach. The main issue is keeping Module::CoreList workable approach. The main issue is keeping Module::CoreList
and its version number synchronised across all maint branches, blead and and its version number synchronised across all maint branches, blead and
CPAN, while having to bump its version number for every RC release. CPAN, while having to bump its version number for every RC release.
See this brief p5p thread: See this brief p5p thread:
Message-ID: <20130311174402.GZ2294@iabyn.com> Message-ID: <20130311174402.GZ2294@iabyn.com>
If you can devise a workable system, feel free to try it out, and to If you can devise a workable system, feel free to try it out, and to
update the RMG accordingly! update the RMG accordingly!
DAPM May 2013 ] DAPM May 2013 ]
F<corelist.pl> uses www.cpan.org to verify information about dual-lived F<corelist.pl> uses www.cpan.org to verify information about dual-lived
modules on CPAN. It can use a full, local CPAN mirror and/or fall back modules on CPAN. It can use a full, local CPAN mirror and/or fall back
on HTTP::Tiny to fetch package metadata remotely. 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
L<https://www.cpan.org/misc/cpan-faq.html#How_mirror_CPAN>) L<https://www.cpan.org/misc/cpan-faq.html#How_mirror_CPAN>)
Change to your perl checkout, and if necessary, Change to your perl checkout, and if necessary,
$ make $ make
Then, If you have a local CPAN mirror, run: Then, If you have a local CPAN mirror, run:
$ ./perl -Ilib Porting/corelist.pl ~/my-cpan-mirror $ ./perl -Ilib Porting/corelist.pl ~/my-cpan-mirror
Otherwise, run: Otherwise, run:
$ ./perl -Ilib Porting/corelist.pl cpan $ ./perl -Ilib Porting/corelist.pl cpan
This will chug for a while, possibly reporting various warnings about This will chug for a while, possibly reporting various warnings about
badly-indexed CPAN modules unrelated to the modules actually in core. badly-indexed CPAN modules unrelated to the modules actually in core.
Assuming all goes well, it will update Assuming all goes well, it will update
F<dist/Module-CoreList/lib/Module/CoreList.pm> and possibly F<dist/Module-CoreList/lib/Module/CoreList.pm> and possibly
F<dist/Module-CoreList/lib/Module/CoreList/Utils.pm>. F<dist/Module-CoreList/lib/Module/CoreList/Utils.pm>.
Check those files over carefully: Check those files over carefully:
$ git diff dist/Module-CoreList/lib/Module/CoreList.pm $ git diff dist/Module-CoreList/lib/Module/CoreList.pm
$ git diff dist/Module-CoreList/lib/Module/CoreList/Utils.pm $ git diff dist/Module-CoreList/lib/Module/CoreList/Utils.pm
=head4 Bump version in Module::CoreList F<Changes> =head4 Bump version in Module::CoreList F<Changes>
Also edit Module::CoreList's new version number in its F<Changes> file. Also edit Module::CoreList's new version number in its F<Changes> file.
This file is F<dist/Module-CoreList/Changes>. This file is F<dist/Module-CoreList/Changes>.
(BLEAD-POINT releases should have had this done already as a post-release (BLEAD-POINT releases should have had this done already as a post-release
action from the last commit.) action from the last commit.)
=head4 Add Module::CoreList version bump to perldelta =head4 Add Module::CoreList version bump to perldelta
skipping to change at line 732 skipping to change at line 732
For any release except an RC: Update this version's entry in the C<%released> For any release except an RC: Update this version's entry in the C<%released>
hash with today's date. hash with today's date.
=head4 Commit Module::CoreList changes =head4 Commit Module::CoreList changes
Finally, commit the new version of Module::CoreList: Finally, commit the new version of Module::CoreList:
(unless this is for MAINT; in which case commit it to blead first, then (unless this is for MAINT; in which case commit it to blead first, then
cherry-pick it back). cherry-pick it back).
$ git commit -m 'Update Module::CoreList for 5.x.y' \ $ git commit -m 'Update Module::CoreList for 5.x.y' \
dist/Module-CoreList/Changes \ dist/Module-CoreList/Changes \
dist/Module-CoreList/lib/Module/CoreList.pm \ dist/Module-CoreList/lib/Module/CoreList.pm \
dist/Module-CoreList/lib/Module/CoreList/Utils.pm dist/Module-CoreList/lib/Module/CoreList/Utils.pm
=head4 Rebuild and test =head4 Rebuild and test
Build and test to get the changes into the currently built lib directory and to Build and test to get the changes into the currently built lib directory and to
ensure all tests are passing. ensure all tests are passing.
=head3 finalize perldelta =head3 finalize perldelta
Finalize the perldelta. In particular, fill in the Acknowledgements Finalize the perldelta. In particular, fill in the Acknowledgements
section, which can be generated with something like: section, which can be generated with something like:
$ perl Porting/acknowledgements.pl v5.15.0..HEAD $ perl Porting/acknowledgements.pl v5.15.0..HEAD
Fill in the "New/Updated Modules" sections now that Module::CoreList is Fill in the "New/Updated Modules" sections now that Module::CoreList is
updated: updated:
$ ./perl -Ilib Porting/corelist-perldelta.pl \ $ ./perl -Ilib Porting/corelist-perldelta.pl \
--mode=update pod/perldelta.pod --mode=update pod/perldelta.pod
For a MAINT release use something like this instead: For a MAINT release use something like this instead:
$ ./perl -Ilib Porting/corelist-perldelta.pl 5.020001 5.020002 \ $ ./perl -Ilib Porting/corelist-perldelta.pl 5.020001 5.020002 \
--mode=update pod/perldelta.pod --mode=update pod/perldelta.pod
Ideally, also fill in a summary of the major changes to each module for which Ideally, also fill in a summary of the major changes to each module for which
an entry has been added by F<corelist-perldelta.pl>. an entry has been added by F<corelist-perldelta.pl>.
Re-read the perldelta to try to find any embarrassing typos and thinkos; 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 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 with any serious issues for which fixes are not going to happen now; and
run through pod and spell checkers, e.g. run through pod and spell checkers, e.g.
$ podchecker -warnings -warnings pod/perldelta.pod $ podchecker -warnings -warnings pod/perldelta.pod
$ spell pod/perldelta.pod $ spell pod/perldelta.pod
$ aspell list < pod/perldelta.pod | sort -u $ aspell list < pod/perldelta.pod | sort -u
Also, you may want to generate and view an HTML version of it to check Also, you may want to generate and view an HTML version of it to check
formatting, e.g. formatting, e.g.
$ ./perl -Ilib ext/Pod-Html/bin/pod2html pod/perldelta.pod > \ $ ./perl -Ilib ext/Pod-Html/bin/pod2html pod/perldelta.pod > \
~/perldelta.html ~/perldelta.html
You should add pod links for GitHub issue references thusly: You should add pod links for GitHub issue references thusly:
$ perl -p -i -e'BEGIN{undef $/}; s{(GH\s+#)(\d+)}{L<$1$2|https://github.com/ Perl/perl5/issues/$2>}mg' pod/perldelta.pod $ perl -p -i -e'BEGIN{undef $/}; s{(GH\s+#)(\d+)}{L<$1$2|https://github.com/Per l/perl5/issues/$2>}mg' pod/perldelta.pod
If you make changes, be sure to commit them. If you make changes, be sure to commit them.
=for checklist skip BLEAD-POINT MAINT RC =for checklist skip BLEAD-POINT MAINT RC
=head3 remove stale perldeltas =head3 remove stale perldeltas
For the first RC release that is ONLY for a BLEAD-FINAL, the perldeltas For the first RC release that is ONLY for a BLEAD-FINAL, the perldeltas
from the BLEAD-POINT releases since the previous BLEAD-FINAL should have from the BLEAD-POINT releases since the previous BLEAD-FINAL should have
now been consolidated into the current perldelta, and hence are now just now been consolidated into the current perldelta, and hence are now just
useless clutter. They can be removed using: useless clutter. They can be removed using:
$ git rm <file1> <file2> ... $ git rm <file1> <file2> ...
For example, for RC0 of 5.16.0: For example, for RC0 of 5.16.0:
$ cd pod $ cd pod
$ git rm perldelta515*.pod $ git rm perldelta515*.pod
=for checklist skip BLEAD-FINAL BLEAD-POINT =for checklist skip BLEAD-FINAL BLEAD-POINT
=head3 add recent perldeltas =head3 add recent perldeltas
For the first RC for a MAINT release, copy in any recent perldeltas from For the first RC for a MAINT release, copy in any recent perldeltas from
blead that have been added since the last release on this branch. This blead that have been added since the last release on this branch. This
should include any recent maint releases on branches older than your one, should include any recent maint releases on branches older than your one,
but not newer. For example if you're producing a 5.14.x release, copy any but not newer. For example if you're producing a 5.14.x release, copy any
perldeltas from recent 5.10.x, 5.12.x etc maint releases, but not from perldeltas from recent 5.10.x, 5.12.x etc maint releases, but not from
5.16.x or higher. Remember to 5.16.x or higher. Remember to
$ git add <file1> <file2> ... $ git add <file1> <file2> ...
=head3 update and commit perldelta files =head3 update and commit perldelta files
If you have added or removed any perldelta files via the previous two If you have added or removed any perldelta files via the previous two
steps, then edit F<pod/perl.pod> to add/remove them from its table of steps, then edit F<pod/perl.pod> to add/remove them from its table of
contents, then run F<Porting/pod_rules.pl> to propagate your changes there contents, then run F<Porting/pod_rules.pl> to propagate your changes there
into all the other files that mention them (including F<MANIFEST>). You'll into all the other files that mention them (including F<MANIFEST>). You'll
need to C<git add> the files that it changes. need to C<git add> the files that it changes.
Then build a clean perl and do a full test Then build a clean perl and do a full test
$ git status $ git status
$ git clean -dxf $ git clean -dxf
$ ./Configure -Dusedevel -des $ ./Configure -Dusedevel -des
$ make $ make
$ make test $ make test
Once all tests pass, commit your changes. Once all tests pass, commit your changes.
=head3 final check of perldelta placeholders =head3 final check of perldelta placeholders
Check for any 'XXX' leftover section in the perldelta. Check for any 'XXX' leftover section in the perldelta.
Either fill them or remove these sections appropriately. Either fill them or remove these sections appropriately.
$ git grep XX pod/perldelta.pod $ git grep XX pod/perldelta.pod
=head3 build a clean perl =head3 build a clean perl
If you skipped the previous step (adding/removing perldeltas), If you skipped the previous step (adding/removing perldeltas),
again, make sure you have a gitwise-clean perl directory (no modified files, again, make sure you have a gitwise-clean perl directory (no modified files,
unpushed commits etc): unpushed commits etc):
$ git status $ git status
$ git clean -dxf $ git clean -dxf
then configure and build perl so that you have a Makefile and porting tools: then configure and build perl so that you have a Makefile and porting tools:
$ ./Configure -Dusedevel -des && make $ ./Configure -Dusedevel -des && make
=for checklist skip BLEAD-FINAL BLEAD-POINT =for checklist skip BLEAD-FINAL BLEAD-POINT
=head3 synchronise from blead's perlhist.pod =head3 synchronise from blead's perlhist.pod
For the first RC for a MAINT release, copy in the latest For the first RC for a MAINT release, copy in the latest
F<pod/perlhist.pod> from blead; this will include details of newer F<pod/perlhist.pod> from blead; this will include details of newer
releases in all branches. In theory, blead's version should be a strict releases in all branches. In theory, blead's version should be a strict
superset of the one in this branch, but it's probably safest to examine the superset of the one in this branch, but it's probably safest to examine the
changes first, to ensure that there's nothing in this branch that was changes first, to ensure that there's nothing in this branch that was
forgotten from blead. An easy way to do that is with C<< git checkout -p >>, forgotten from blead. An easy way to do that is with C<< git checkout -p >>,
to selectively apply any changes from the blead version to your current to selectively apply any changes from the blead version to your current
branch: branch:
$ git fetch origin $ git fetch origin
$ git checkout -p origin/blead pod/perlhist.pod $ git checkout -p origin/blead pod/perlhist.pod
$ git commit -m 'Sync perlhist from blead' pod/perlhist.pod $ git commit -m 'Sync perlhist from blead' pod/perlhist.pod
=head3 update perlhist.pod =head3 update perlhist.pod
Add an entry to F<pod/perlhist.pod> with the release date, e.g.: Add an entry to F<pod/perlhist.pod> with the release date, e.g.:
David 5.10.1 2009-Aug-06 David 5.10.1 2009-Aug-06
List yourself in the left-hand column, and if this is the first release List yourself in the left-hand column, and if this is the first release
that you've ever done, make sure that your name is listed in the section that you've ever done, make sure that your name is listed in the section
entitled C<THE KEEPERS OF THE PUMPKIN>. entitled C<THE KEEPERS OF THE PUMPKIN>.
I<If you're making a BLEAD-FINAL release>, also update the "SELECTED I<If you're making a BLEAD-FINAL release>, also update the "SELECTED
RELEASE SIZES" section with the output of RELEASE SIZES" section with the output of
F<Porting/perlhist_calculate.pl>. F<Porting/perlhist_calculate.pl>.
Be sure to commit your changes: Be sure to commit your changes:
$ git commit -m 'Add new release to perlhist' pod/perlhist.pod $ git commit -m 'Add new release to perlhist' pod/perlhist.pod
=for checklist skip BLEAD-POINT =for checklist skip BLEAD-POINT
=head3 update patchlevel.h =head3 update patchlevel.h
I<You MUST SKIP this step for a BLEAD-POINT release> I<You MUST SKIP this step for a BLEAD-POINT release>
Update F<patchlevel.h> to add a C<-RC1>-or-whatever string; or, if this is Update F<patchlevel.h> to add a C<-RC1>-or-whatever string; or, if this is
a final release, remove it. For example: a final release, remove it. For example:
static const char * const local_patches[] = { static const char * const local_patches[] = {
NULL NULL
+ ,"RC1" + ,"RC1"
#ifdef PERL_GIT_UNCOMMITTED_CHANGES #ifdef PERL_GIT_UNCOMMITTED_CHANGES
,"uncommitted-changes" ,"uncommitted-changes"
#endif #endif
Be sure to commit your change: Be sure to commit your change:
$ git commit -m 'Bump version to RCnnn' patchlevel.h $ git commit -m 'Bump version to RCnnn' patchlevel.h
=head3 run makemeta to update META files =head3 run makemeta to update META files
$ ./perl -Ilib Porting/makemeta $ ./perl -Ilib Porting/makemeta
Be sure to commit any changes (if applicable): Be sure to commit any changes (if applicable):
$ git status # any changes? $ git status # any changes?
$ git commit -m 'Update META files' META.* $ git commit -m 'Update META files' META.*
=head3 build, test and check a fresh perl =head3 build, test and check a fresh perl
Build perl, then make sure it passes its own test suite, and installs: Build perl, then make sure it passes its own test suite, and installs:
$ git clean -xdf $ git clean -xdf
$ ./Configure -des -Dprefix=/tmp/perl-5.x.y-pretest $ ./Configure -des -Dprefix=/tmp/perl-5.x.y-pretest
# or if it's an odd-numbered version: # or if it's an odd-numbered version:
$ ./Configure -des -Dusedevel -Dprefix=/tmp/perl-5.x.y-pretest $ ./Configure -des -Dusedevel -Dprefix=/tmp/perl-5.x.y-pretest
$ make test install $ make test install
Check that the output of C</tmp/perl-5.x.y-pretest/bin/perl -v> and Check that the output of C</tmp/perl-5.x.y-pretest/bin/perl -v> and
C</tmp/perl-5.x.y-pretest/bin/perl -V> are as expected, C</tmp/perl-5.x.y-pretest/bin/perl -V> are as expected,
especially as regards version numbers, patch and/or RC levels, and @INC especially as regards version numbers, patch and/or RC levels, and @INC
paths. Note that as they have been built from a git working paths. Note that as they have been built from a git working
directory, they will still identify themselves using git tags and directory, they will still identify themselves using git tags and
commits. (Note that for an odd-numbered version, perl will install commits. (Note that for an odd-numbered version, perl will install
itself as C<perl5.x.y>). C<perl -v> will identify itself as: 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)) 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, where 5.X.Z is the latest tag, NNN the number of commits since this tag,
and C<< deadbeef >> commit of that tag. and C<< deadbeef >> commit of that tag.
Then delete the temporary installation. Then delete the temporary installation.
=head3 create the release tag =head3 create the release tag
Create the tag identifying this release (e.g.): Create the tag identifying this release (e.g.):
$ git tag v5.11.0 -m 'First release of the v5.11 series!' $ git tag v5.11.0 -m 'First release of the v5.11 series!'
It is B<VERY> important that from this point forward, you not push It is B<VERY> important that from this point forward, you not push
your git changes to the Perl master repository. If anything goes your git changes to the Perl master repository. If anything goes
wrong before you publish your newly-created tag, you can delete wrong before you publish your newly-created tag, you can delete
and recreate it. Once you push your tag, we're stuck with it and recreate it. Once you push your tag, we're stuck with it
and you'll need to use a new version number for your release. and you'll need to use a new version number for your release.
=head3 build the tarball =head3 build the tarball
Before you run the following, you might want to install 7-Zip (the Before you run the following, you might want to install 7-Zip (the
skipping to change at line 982 skipping to change at line 982
to prevent OS X resource files from being included in your tarball. After to prevent OS X resource files from being included in your tarball. After
creating the tarball following the instructions below, inspect it to ensure creating the tarball following the instructions below, inspect it to ensure
you don't have files like F<._foobar>. you don't have files like F<._foobar>.
Create a tarball. Use the C<-s> option to specify a suitable suffix for Create a tarball. Use the C<-s> option to specify a suitable suffix for
the tarball and directory name: the tarball and directory name:
$ cd root/of/perl/tree $ cd root/of/perl/tree
$ make distclean # make sure distclean works $ make distclean # make sure distclean works
$ git clean -xdf # make sure perl and git agree on files $ git clean -xdf # make sure perl and git agree on files
# git clean should not output anything! # git clean should not output anything!
$ git status --ignored # and there's nothing lying around $ git status --ignored # and there's nothing lying around
$ perl Porting/makerel -x -s RC1 # for a release candidate $ perl Porting/makerel -x -s RC1 # for a release candidate
$ perl Porting/makerel -x # for the release itself $ perl Porting/makerel -x # for the release itself
This creates the directory F<../perl-x.y.z-RC1> or similar, copies all 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, then the MANIFEST files into it, sets the correct permissions on them, then
tars it up as F<../perl-x.y.z-RC1.tar.gz>. The C<-x> also produces a tars it up as F<../perl-x.y.z-RC1.tar.gz>. The C<-x> also produces a
C<tar.xz> file. C<tar.xz> file.
If you're getting your tarball suffixed with -uncommitted and you're sure If you're getting your tarball suffixed with -uncommitted and you're sure
your changes were all committed, you can override the suffix with: your changes were all committed, you can override the suffix with:
$ perl Porting/makerel -x -s '' $ perl Porting/makerel -x -s ''
XXX if we go for extra tags and branches stuff, then add the extra details XXX if we go for extra tags and branches stuff, then add the extra details
here here
Finally, clean up the temporary directory, e.g. Finally, clean up the temporary directory, e.g.
$ rm -rf ../perl-x.y.z-RC1 $ rm -rf ../perl-x.y.z-RC1
=head3 test the tarball =head3 test the tarball
Once you have a tarball it's time to test the tarball (not the repository). Once you have a tarball it's time to test the tarball (not the repository).
=head4 Copy the tarball to a web server =head4 Copy the tarball to a web server
Copy the tarballs (.gz and .xz) to a web server somewhere you have access to. Copy the tarballs (.gz and .xz) to a web server somewhere you have access to.
=head4 Download the tarball to another machine and unpack it =head4 Download the tarball to another machine and unpack it
skipping to change at line 1032 skipping to change at line 1032
ask the #p5p IRC channel on irc.perl.org for volunteers to test the ask the #p5p IRC channel on irc.perl.org for volunteers to test the
tarballs on whatever platforms they can. tarballs on whatever platforms they can.
If you're not confident in the tarball, you can defer this step until after If you're not confident in the tarball, you can defer this step until after
your own tarball testing, below. your own tarball testing, below.
=head4 Check that F<Configure> works =head4 Check that F<Configure> works
Check that basic configuration and tests work on each test machine: Check that basic configuration and tests work on each test machine:
$ ./Configure -des && make all minitest test $ ./Configure -des && make all minitest test
# Or for a development release: # Or for a development release:
$ ./Configure -Dusedevel -des && make all minitest test $ ./Configure -Dusedevel -des && make all minitest test
=head4 Run the test harness and install =head4 Run the test harness and install
Check that the test harness and install work on each test machine: Check that the test harness and install work on each test machine:
$ make distclean $ make distclean
$ ./Configure -des -Dprefix=/install/path && \ $ ./Configure -des -Dprefix=/install/path && \
make all test_harness install make all test_harness install
$ cd /install/path $ cd /install/path
(Remember C<-Dusedevel> above, for a development release.) (Remember C<-Dusedevel> above, for a development release.)
=head4 Check C<perl -v> and C<perl -V> =head4 Check C<perl -v> and C<perl -V>
Check that the output of C<perl -v> and C<perl -V> are as expected, 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 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, Note that the results may be different without a F<.git/> directory,
which is why you should test from the tarball. which is why you should test from the tarball.
=head4 Run the Installation Verification Procedure utility =head4 Run the Installation Verification Procedure utility
$ ./perl -Ilib ./utils/perlivp $ ./perl -Ilib ./utils/perlivp
# Or, perhaps: # Or, perhaps:
$ ./perl5.x.y ./utils/perlivp5.x.y $ ./perl5.x.y ./utils/perlivp5.x.y
... ...
All tests successful. All tests successful.
$ $
=head4 Compare the installed paths to the last release =head4 Compare the installed paths to the last release
Compare the pathnames of all installed files with those of the previous Compare the pathnames of all installed files with those of the previous
release (i.e. against the last installed tarball on this branch which you release (i.e. against the last installed tarball on this branch which you
have previously verified using this same procedure). In particular, look have previously verified using this same procedure). In particular, look
for files in the wrong place, or files no longer included which should be. for files in the wrong place, or files no longer included which should be.
For example, suppose the about-to-be-released version is 5.10.1 and the For example, suppose the about-to-be-released version is 5.10.1 and the
previous is 5.10.0: previous is 5.10.0:
cd installdir-5.10.0/ cd installdir-5.10.0/
find . -type f | perl -pe's/5\.10\.0/5.10.1/g' | sort > /tmp/f1 find . -type f | perl -pe's/5\.10\.0/5.10.1/g' | sort > /tmp/f1
cd installdir-5.10.1/ cd installdir-5.10.1/
find . -type f | sort > /tmp/f2 find . -type f | sort > /tmp/f2
diff -u /tmp/f[12] diff -u /tmp/f[12]
=head4 Disable C<local::lib> if it's turned on =head4 Disable C<local::lib> if it's turned on
If you're using C<local::lib>, you should reset your environment before If you're using C<local::lib>, you should reset your environment before
performing these actions: performing these actions:
$ unset PERL5LIB PERL_MB_OPT PERL_LOCAL_LIB_ROOT PERL_MM_OPT $ unset PERL5LIB PERL_MB_OPT PERL_LOCAL_LIB_ROOT PERL_MM_OPT
=head4 Bootstrap the CPAN client =head4 Bootstrap the CPAN client
Bootstrap the CPAN client on the clean install: Bootstrap the CPAN client on the clean install:
$ bin/cpan $ bin/cpan
# Or, perhaps: # Or, perhaps:
$ bin/cpan5.xx.x $ bin/cpan5.xx.x
=head4 Install the Inline module with CPAN 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 Try installing a popular CPAN module that's reasonably complex and that
has dependencies; for example: has dependencies; for example:
CPAN> install Inline::C CPAN> install Inline::C
CPAN> quit CPAN> quit
Check that your perl can run this: Check that your perl can run this:
$ bin/perl -Ilib -lwe "use Inline C => q[int f() { return 42;}]; print f" $ bin/perl -Ilib -lwe "use Inline C => q[int f() { return 42;}]; print f"
42 42
$ $
=head4 Make sure that perlbug works =head4 Make sure that perlbug works
Test L<perlbug> with the following: Test L<perlbug> with the following:
$ bin/perlbug $ bin/perlbug
... ...
Subject: test bug report Subject: test bug report
Local perl administrator [yourself]: Local perl administrator [yourself]:
Editor [vi]: Editor [vi]:
Module: Module:
Category [core]: Category [core]:
Severity [low]: Severity [low]:
(edit report) (edit report)
Action (Send/Display/Edit/Subject/Save to File): f 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]:
and carefully examine the output (in F<perlbug.rep]>), especially and carefully examine the output (in F<perlbug.rep]>), especially
the "Locally applied patches" section. the "Locally applied patches" section.
=for checklist skip BLEAD-POINT =for checklist skip BLEAD-POINT
=head3 monitor smokes =head3 monitor smokes
XXX This is probably irrelevant if working on a release branch, though XXX This is probably irrelevant if working on a release branch, though
MAINT or RC might want to push a smoke branch and wait. MAINT or RC might want to push a smoke branch and wait.
skipping to change at line 1156 skipping to change at line 1156
releases, but for I<BLEAD-POINT> releases sometimes the best you can do is releases, but for I<BLEAD-POINT> releases sometimes the best you can do is
to plead with people on IRC to test stuff on their platforms, fire away, to plead with people on IRC to test stuff on their platforms, fire away,
and then hope for the best. and then hope for the best.
=head3 upload to PAUSE =head3 upload to PAUSE
Once smoking is okay, upload it to PAUSE. This is the point of no return. 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 If anything goes wrong after this point, you will need to re-prepare
a new release with a new minor version or RC number. a new release with a new minor version or RC number.
https://pause.perl.org/ https://pause.perl.org/
(Log in, then select 'Upload a file to CPAN') (Log in, then select 'Upload a file to CPAN')
If your workstation is not connected to a high-bandwidth, If your workstation is not connected to a high-bandwidth,
high-reliability connection to the Internet, you should probably use the high-reliability connection to the Internet, you should probably use the
"GET URL" feature (rather than "HTTP UPLOAD") to have PAUSE retrieve 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 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 eliminate anxious gnashing of teeth while you wait to see if your
15 megabyte HTTP upload successfully completes across your slow, twitchy 15 megabyte HTTP upload successfully completes across your slow, twitchy
cable modem. cable modem.
I<Remember>: if your upload is partially successful, you I<Remember>: if your upload is partially successful, you
may need to contact a PAUSE administrator or even bump the version of perl. may need to contact a PAUSE administrator or even bump the version of perl.
Upload the .gz and .xz versions of the tarball. Upload the .gz and .xz versions of the tarball.
Note: You can also use the command-line utility to upload your tarballs, if Note: You can also use the command-line utility to upload your tarballs, if
you have it configured: you have it configured:
cpan-upload perl-5.X.Y.tar.gz cpan-upload perl-5.X.Y.tar.gz
cpan-upload perl-5.X.Y.tar.xz cpan-upload perl-5.X.Y.tar.xz
Do not proceed any further until you are sure that your tarballs are on CPAN. Do not proceed any further until you are sure that your tarballs are on CPAN.
Check your authors directory metacpan.org to confirm that your uploads have Check your authors directory metacpan.org to confirm that your uploads have
been successful. been successful.
https://metacpan.org/author/YOUR_PAUSE_ID https://metacpan.org/author/YOUR_PAUSE_ID
=for checklist skip RC BLEAD-POINT =for checklist skip RC BLEAD-POINT
=head3 wait for indexing =head3 wait for indexing
I<You MUST SKIP this step for RC and BLEAD-POINT> I<You MUST SKIP this step for RC and BLEAD-POINT>
Wait until you receive notification emails from the PAUSE indexer Wait until you receive notification emails from the PAUSE indexer
confirming that your uploads have been received. IMPORTANT -- you will confirming that your uploads have been received. IMPORTANT -- you will
probably get an email that indexing has failed, due to module permissions. probably get an email that indexing has failed, due to module permissions.
This is considered normal. This is considered normal.
=for checklist skip BLEAD-POINT =for checklist skip BLEAD-POINT
=head3 disarm patchlevel.h =head3 disarm patchlevel.h
I<You MUST SKIP this step for BLEAD-POINT release> I<You MUST SKIP this step for BLEAD-POINT release>
Disarm the F<patchlevel.h> change; for example, Disarm the F<patchlevel.h> change; for example,
static const char * const local_patches[] = { static const char * const local_patches[] = {
NULL NULL
- ,"RC1" - ,"RC1"
#ifdef PERL_GIT_UNCOMMITTED_CHANGES #ifdef PERL_GIT_UNCOMMITTED_CHANGES
,"uncommitted-changes" ,"uncommitted-changes"
#endif #endif
Be sure to commit your change: Be sure to commit your change:
$ git commit -m 'Disarm RCnnn bump' patchlevel.h $ git commit -m 'Disarm RCnnn bump' patchlevel.h
=head3 announce to p5p =head3 announce to p5p
Mail perl5-porters@perl.org to announce your new release, with a quote you prepa red earlier. Mail perl5-porters@perl.org to announce your new release, with a quote you prepa red earlier.
Get the SHA256 digests from the PAUSE email responses. Get the SHA256 digests from the PAUSE email responses.
Use the template at Porting/release_announcement_template.txt Use the template at Porting/release_announcement_template.txt
Send a carbon copy to C<noc@metacpan.org> Send a carbon copy to C<noc@metacpan.org>
If your email does not appear on the list, but does not obviously bounce If your email does not appear on the list, but does not obviously bounce
either, check that the email you are sending from is subscribed to the list. either, check that the email you are sending from is subscribed to the list.
=head3 merge release branch back to blead =head3 merge release branch back to blead
Merge the (local) release branch back into master now, and delete it. Merge the (local) release branch back into master now, and delete it.
git checkout blead git checkout blead
git pull git pull
git merge release-5.xx.yy git merge release-5.xx.yy
git push git push
git branch -d release-5.xx.yy git branch -d release-5.xx.yy
Note: The merge will create a merge commit if other changes have been pushed Note: The merge will create a merge commit if other changes have been pushed
to blead while you've been working on your release branch. Do NOT rebase your to blead while you've been working on your release branch. Do NOT rebase your
branch to avoid the merge commit (as you might normally do when merging a branch to avoid the merge commit (as you might normally do when merging a
small branch into blead) since doing so will invalidate the tag that you small branch into blead) since doing so will invalidate the tag that you
created earlier. created earlier.
=head3 publish the release tag =head3 publish the release tag
Now that you've shipped the new perl release to PAUSE and pushed your changes Now that you've shipped the new perl release to PAUSE and pushed your changes
to the Perl master repository, it's time to publish the tag you created to the Perl master repository, it's time to publish the tag you created
earlier too (e.g.): earlier too (e.g.):
$ git push origin tag v5.11.0 $ git push origin tag v5.11.0
=head3 update epigraphs.pod =head3 update epigraphs.pod
Add your quote to F<Porting/epigraphs.pod> and commit it. Add your quote to F<Porting/epigraphs.pod> and commit it.
You can include the customary link to the release announcement even before your You can include the customary link to the release announcement even before your
message reaches the web-visible archives by looking for the X-List-Archive message reaches the web-visible archives by looking for the X-List-Archive
header in your message after receiving it back via perl5-porters. header in your message after receiving it back via perl5-porters.
=head3 blog about your epigraph =head3 blog about your epigraph
skipping to change at line 1302 skipping to change at line 1302
=over 4 =over 4
=item * =item *
Confirm that you have a clean checkout with no local changes. Confirm that you have a clean checkout with no local changes.
=item * =item *
Run: Run:
perl Porting/new-perldelta.pl perl Porting/new-perldelta.pl
=item * =item *
Run the C<git add> commands it outputs to add new and modified files. Run the C<git add> commands it outputs to add new and modified files.
=item * =item *
Verify that the build still works, by running C<./Configure> and Verify that the build still works, by running C<./Configure> and
C<make test_porting>. (On Win32 use the appropriate make utility). C<make test_porting>. (On Win32 use the appropriate make utility).
=item * =item *
If F<t/porting/podcheck.t> spots errors in the new F<pod/perldelta.pod>, If F<t/porting/podcheck.t> spots errors in the new F<pod/perldelta.pod>,
run C<./perl -MTestInit t/porting/podcheck.t | less> for more detail. run C<./perl -MTestInit t/porting/podcheck.t | less> for more detail.
Skip to the end of its test output to see the options it offers you. Skip to the end of its test output to see the options it offers you.
=item * =item *
When C<make test_porting> passes, commit the new perldelta. When C<make test_porting> passes, commit the new perldelta.
git commit -m'New perldelta for 5.X.Y' git commit -m'New perldelta for 5.X.Y'
=back =back
At this point you may want to compare the commit with a previous bump to At this point you may want to compare the commit with a previous bump to
see if they look similar. See commit ba03bc34a4 for an example of a see if they look similar. See commit ba03bc34a4 for an example of a
previous version bump. previous version bump.
=for checklist skip MAINT RC =for checklist skip MAINT RC
=head3 bump version =head3 bump version
skipping to change at line 1345 skipping to change at line 1345
I<You MUST SKIP this step for RC and 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 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 series, 5.x.0 where x is even), then bump the version in the blead branch
in git, e.g. 5.12.0 to 5.13.0. in git, e.g. 5.12.0 to 5.13.0.
First, add a new feature bundle to F<regen/feature.pl>, initially by just First, add a new feature bundle to F<regen/feature.pl>, initially by just
copying the exiting entry, and bump the file's $VERSION (after the __END__ copying the exiting entry, and bump the file's $VERSION (after the __END__
marker); e.g. marker); e.g.
"5.14" => [qw(switch say state unicode_strings)], "5.14" => [qw(switch say state unicode_strings)],
+ "5.15" => [qw(switch say state unicode_strings)], + "5.15" => [qw(switch say state unicode_strings)],
Run F<regen/feature.pl> to propagate the changes to F<lib/feature.pm>. Run F<regen/feature.pl> to propagate the changes to F<lib/feature.pm>.
Then follow the section L<"Bump the version number"> to bump the version Then follow the section L<"Bump the version number"> to bump the version
in the remaining files and test and commit. in the remaining files and test and commit.
If this was a BLEAD-POINT release, then just follow the section If this was a BLEAD-POINT release, then just follow the section
L<"Bump the version number">. L<"Bump the version number">.
After bumping the version, follow the section L<"update INSTALL"> to After bumping the version, follow the section L<"update INSTALL"> to
skipping to change at line 1412 skipping to change at line 1412
Following the instructions output by F<t/porting/podcheck.t> on how to Following the instructions output by F<t/porting/podcheck.t> on how to
update its exceptions database. update its exceptions database.
=back =back
=head3 push commits =head3 push commits
Finally, push any commits done above. Finally, push any commits done above.
$ git push origin .... $ git push origin ....
=for checklist skip BLEAD-POINT MAINT RC =for checklist skip BLEAD-POINT MAINT RC
=head3 create maint branch =head3 create maint branch
I<You MUST SKIP this step for RC, BLEAD-POINT, MAINT> I<You MUST SKIP this step for RC, BLEAD-POINT, MAINT>
If this was a BLEAD-FINAL release (i.e. the first release of a new 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 create a new maint branch based on series, 5.x.0 where x is even), then create a new maint branch based on
the commit tagged as the current release. the commit tagged as the current release.
Assuming you're using git 1.7.x or newer: Assuming you're using git 1.7.x or newer:
$ git checkout -b maint-5.12 v5.12.0 $ git checkout -b maint-5.12 v5.12.0
$ git push origin -u maint-5.12 $ git push origin -u maint-5.12
=for checklist skip BLEAD-POINT MAINT RC =for checklist skip BLEAD-POINT MAINT RC
=head3 make the maint branch available in the APC =head3 make the maint branch available in the APC
Clone the new branch into /srv/gitcommon/branches on camel so the APC will Clone the new branch into /srv/gitcommon/branches on camel so the APC will
receive its changes. receive its changes.
$ git clone --branch maint-5.14 /gitroot/perl.git \ $ git clone --branch maint-5.14 /gitroot/perl.git \
? /srv/gitcommon/branches/perl-5.14.x ? /srv/gitcommon/branches/perl-5.14.x
$ chmod -R g=u /srv/gitcommon/branches/perl-5.14.x $ chmod -R g=u /srv/gitcommon/branches/perl-5.14.x
And nag the sysadmins to make this directory available via rsync. And nag the sysadmins to make this directory available via rsync.
XXX Who are the sysadmins? Contact info? XXX Who are the sysadmins? Contact info?
=for checklist skip BLEAD-POINT RC =for checklist skip BLEAD-POINT RC
=head3 copy perldelta.pod to blead =head3 copy perldelta.pod to blead
I<You MUST SKIP this step for RC, BLEAD-POINT> I<You MUST SKIP this step for RC, BLEAD-POINT>
skipping to change at line 1461 skipping to change at line 1461
$ cd ..../blead $ cd ..../blead
$ cp -i ../5.10.x/pod/perldelta.pod pod/perl5101delta.pod #for example $ cp -i ../5.10.x/pod/perldelta.pod pod/perl5101delta.pod #for example
$ git add pod/perl5101delta.pod $ git add pod/perl5101delta.pod
Don't forget to set the NAME correctly in the new file (e.g. perl5101delta Don't forget to set the NAME correctly in the new file (e.g. perl5101delta
rather than perldelta). rather than perldelta).
Edit F<pod/perl.pod> to add an entry for the file, e.g.: Edit F<pod/perl.pod> to add an entry for the file, e.g.:
perl5101delta Perl changes in version 5.10.1 perl5101delta Perl changes in version 5.10.1
Then rebuild various files: Then rebuild various files:
$ perl Porting/pod_rules.pl $ perl Porting/pod_rules.pl
Finally, commit and push: Finally, commit and push:
$ git commit -a -m 'Add perlXXXdelta' $ git commit -a -m 'Add perlXXXdelta'
$ git push origin .... $ git push origin ....
=for checklist skip BLEAD-POINT =for checklist skip BLEAD-POINT
=head3 copy perlhist.pod entries to blead =head3 copy perlhist.pod entries to blead
Make sure any recent F<pod/perlhist.pod> entries are copied to Make sure any recent F<pod/perlhist.pod> entries are copied to
F<perlhist.pod> on blead. e.g. F<perlhist.pod> on blead. e.g.
5.8.9 2008-Dec-14 5.8.9 2008-Dec-14
=head3 Relax! =head3 Relax!
I<You MUST RETIRE to your preferred PUB, CAFE or SEASIDE VILLA for some I<You MUST RETIRE to your preferred PUB, CAFE or SEASIDE VILLA for some
much-needed rest and relaxation>. much-needed rest and relaxation>.
Thanks for releasing perl! Thanks for releasing perl!
=head2 Building a release - the day after =head2 Building a release - the day after
skipping to change at line 1516 skipping to change at line 1516
=item * =item *
Bump the $VERSION in F<dist/Module-CoreList/lib/Module/CoreList.pm> Bump the $VERSION in F<dist/Module-CoreList/lib/Module/CoreList.pm>
and F<dist/Module-CoreList/lib/Module/CoreList/Utils.pm>. and F<dist/Module-CoreList/lib/Module/CoreList/Utils.pm>.
=item * =item *
If you have a local CPAN mirror, run: If you have a local CPAN mirror, run:
$ ./perl -Ilib Porting/corelist.pl ~/my-cpan-mirror $ ./perl -Ilib Porting/corelist.pl ~/my-cpan-mirror
Otherwise, run: Otherwise, run:
$ ./perl -Ilib Porting/corelist.pl cpan $ ./perl -Ilib Porting/corelist.pl cpan
This will update F<dist/Module-CoreList/lib/Module/CoreList.pm> and This will update F<dist/Module-CoreList/lib/Module/CoreList.pm> and
F<dist/Module-CoreList/lib/Module/CoreList/Utils.pm> as it did before, F<dist/Module-CoreList/lib/Module/CoreList/Utils.pm> as it did before,
but this time adding new sections for the next BLEAD-POINT release. but this time adding new sections for the next BLEAD-POINT release.
=item * =item *
Add the new $Module::CoreList::VERSION to Add the new $Module::CoreList::VERSION to
F<dist/Module-CoreList/Changes>. F<dist/Module-CoreList/Changes>.
=item * =item *
Remake perl to get your changed .pm files propagated into F<lib/> and Remake perl to get your changed .pm files propagated into F<lib/> and
then run at least the F<dist/Module-CoreList/t/*.t> tests and the then run at least the F<dist/Module-CoreList/t/*.t> tests and the
test_porting makefile target to check that they're ok. test_porting makefile target to check that they're ok.
$ cd t; ./TEST ../dist/Module-CoreList/t/*.t $ cd t; ./TEST ../dist/Module-CoreList/t/*.t
$ make test_porting $ make test_porting
=item * =item *
Run Run
$ ./perl -Ilib -MModule::CoreList \ $ ./perl -Ilib -MModule::CoreList \
-le 'print Module::CoreList->find_version($]) ? "ok" : "not ok"' -le 'print Module::CoreList->find_version($]) ? "ok" : "not ok"'
and check that it outputs "ok" to prove that Module::CoreList now knows and check that it outputs "ok" to prove that Module::CoreList now knows
about blead's current version. about blead's current version.
=item * =item *
Commit and push your changes. Commit and push your changes.
$ git add -u $ git add -u
$ git commit -m "Prepare Module::Corelist for 5.XX.Y" $ git commit -m "Prepare Module::Corelist for 5.XX.Y"
$ git push origin $ git push origin
=back =back
=head3 check tarball availability =head3 check tarball availability
Check various website entries to make sure the that tarball has appeared Check various website entries to make sure the that tarball has appeared
and is properly indexed: and is properly indexed:
=over 4 =over 4
 End of changes. 91 change blocks. 
177 lines changed or deleted 177 lines changed or added

Home  |  About  |  Features  |  All  |  Newest  |  Dox  |  Diffs  |  RSS Feeds  |  Screenshots  |  Comments  |  Imprint  |  Privacy  |  HTTP(S)