subsequent release candidates and the final release, it it not necessary to
bump the version further.
-There is a tool to semi-automate this process. It works in two stages.
-First, it generates a list of suggested changes, which you review and
-edit; then you feed this list back and it applies the edits. So, first
-scan the source directory looking for likely candidates. The command line
-arguments are the old and new version numbers, and -s means scan:
+There is a tool to semi-automate this process:
- $ ./perl -Ilib Porting/bump-perl-version -s 5.10.0 5.10.1 > /tmp/scan
+ $ ./perl -Ilib Porting/bump-perl-version -i 5.10.0 5.10.1
-This produces a file containing a list of suggested edits, e.g.:
+Remember that this tool is largely just grepping for '5.10.0' or whatever,
+so it will generate false positives. Be careful not change text like
+"this was fixed in 5.10.0"!
- NetWare/Makefile
-
- 89: -MODULE_DESC = "Perl 5.10.0 for NetWare"
- +MODULE_DESC = "Perl 5.10.1 for NetWare"
-
-i.e. in the file F<NetWare/Makefile>, line 89 would be changed as shown.
-Review the file carefully, and delete any -/+ line pairs that you don't
-want changing. You can also edit just the C<+> line to change the
-suggested replacement text. Remember that this tool is largely just
-grepping for '5.10.0' or whatever, so it will generate false positives. Be
-careful not change text like "this was fixed in 5.10.0"! Then run:
-
- $ ./perl -Ilib Porting/bump-perl-version -u < /tmp/scan
-
-which will update all the files shown.
+Use git status and git diff to select changes you want to keep.
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
The line in F<INSTALL> about "is binary incompatible with" requires a
correct choice of earlier version to declare incompatibility with.
-Also note that this tool
-currently only detects a single substitution per line: so in particular,
-this line in README.vms needs special handling:
-
- rename perl-5^.10^.1.dir perl-5_10_1.dir
-
When doing a BLEAD-POINT or BLEAD-FINAL release, also make sure the
C<PERL_API_*> constants in F<patchlevel.h> are in sync with the version
you're releasing, unless you're
Commit your changes:
- $ git st
+ $ git status
$ git diff
B<review the delta carefully>
For BLEAD-POINT releases, it needs to refer to the previous BLEAD-POINT
release (so for 5.15.3 this would be 5.15.2).
-
-=head3 update Changes
-
-Update the F<Changes> file to contain the git log command which would show
-all the changes in this release. You will need assume the existence of a
-not-yet created tag for the forthcoming release; e.g.
-
- git log ... perl-5.10.0..perl-5.12.0
-
-Due to warts in the perforce-to-git migration, some branches require extra
-exclusions to avoid other branches being pulled in. Make sure you have the
-correct incantation: replace the not-yet-created tag with C<HEAD> and see
-if C<git log> produces roughly the right number of commits across roughly the
-right time period (you may find C<git log --pretty=oneline | wc> useful).
-
-
=head3 Check more build configurations
Check some more build configurations. The check that setuid builds and
=head3 finalize perldelta
Finalize the perldelta. In particular, fill in the Acknowledgements
-section. You can generate a list of contributors with checkAUTHORS.pl.
-For example:
-
- $ git log --pretty=fuller v5.13.${last}..HEAD | \
- perl Porting/checkAUTHORS.pl --who -
+section, which can be generated with something like:
-Look at the previous L<perldelta> for how to write the opening
-paragraph of the Acknowledgements section. To get the amount of
-changed files and number of lines use this command:
-
- $ git diff --shortstat v5.13.${last}..HEAD | \
- ./perl -Ilib -nE 'my ($files, $insert, $delete) = /(\d+)/ga; say "$files files and ", $insert + $delete, " lines changed"'
-
-Making sure to round off the number of lines changed.
+ $ perl Porting/acknowledgements.pl v5.15.0..HEAD
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
Also, you may want to generate and view an HTML version of it to check
formatting, e.g.
- $ ./perl -Ilib ext/Pod-Html/pod2html pod/perldelta.pod > /tmp/perldelta.html
+ $ ./perl -Ilib ext/Pod-Html/bin/pod2html pod/perldelta.pod > /tmp/perldelta.html
Another good HTML preview option is http://search.cpan.org/pod2html
If you make changes, be sure to commit them.
+=head3 remove stale 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
+now been consolidated into the current perldelta, and hence are now just
+useless clutter. They can be removed using:
+
+ $ git rm <file1> <file2> ...
+
+For example, for RC0 of 5.16.0:
+
+ $ cd pod
+ $ git rm perldelta515*.pod
+
+All mention to them should also be removed. Currently the files that
+need to be edited for this task are F<MANIFEST>, F<pod.list>,
+F<pod/perl.pod>, and F<win32/pod.mak> (including C<.man>, C<.html>, and
+C<.tex> entries for each removed pod).
+
+Then build a clean perl and do a full test
+
+ $ git status
+ $ git clean -dxf
+ $ ./Configure -Dusedevel -des
+ $ make
+ $ make test
+
+Once all tests pass, commit your changes.
=head3 build a clean perl
-Make sure you have a gitwise-clean perl directory (no modified files,
+If you skipped the previous step (removing the stale perldeltas)
+make sure you have a gitwise-clean perl directory (no modified files,
unpushed commits etc):
$ git status
$ ./Configure -Dusedevel -des && make
-
=head3 update Module::CoreList
Update C<Module::CoreList> with module version data for the new release.
$ make
-If this not the first update for this version (e.g. if it was updated
+If this is not the first update for this version (e.g. if it was updated
when the version number was originally bumped), first edit
F<dist/Module-CoreList/lib/Module/CoreList.pm> to delete the existing
entries for this version from the C<%released> and C<%version> hashes:
If necessary, bump C<$VERSION> (there's no need to do this for
every RC; in RC1, bump the version to a new clean number that will
appear in the final release, and leave as-is for the later RCs and final).
+It may also happen that C<Module::CoreList> has been modified in blead, and
+hence has a new version number already. (But make sure it is not the same
+number as a CPAN release.)
Edit the version number in the new C<< 'Module::CoreList' => 'X.YZ' >>
entry, as that is likely to reflect the previous version number.
Add a perldelta entry for the new Module::CoreList version.
-You should also add the version you're about to release to the
-L<Module::CoreList/CAVEATS> section which enumerates the perl releases
-that Module::CoreList covers.
-
In addition, if this is a final release (rather than a release candidate):
=over 4
$ git commit -m 'Update Module::CoreList for 5.x.y' dist/Module-CoreList/lib/Module/CoreList.pm
-=head3 check MANIFEST
-
-Check that the manifest is sorted and correct:
-
- $ make distclean
- $ git clean -xdf # This shouldn't be necessary if distclean is correct
- $ perl Porting/manicheck
-
-If manicheck turns up anything wrong, update MANIFEST and begin this step again.
-
- $ ./configure -des -Dusedevel
- $ make test_porting
- $ git commit -m 'Update MANIFEST' MANIFEST
-
-
=head3 update perlhist.pod
I<You MUST SKIP this step for a RC release>
=head3 build the tarball
+Before you run the following, you might want to install 7-Zip (the
+C<p7zip-full> package under Debian or the C<p7zip> port on MacPorts) or
+the AdvanceCOMP suite (e.g. the C<advancecomp> package under Debian,
+or the C<advancecomp> port on macports - 7-Zip on Windows is the
+same code as AdvanceCOMP, so Windows users get the smallest files
+first time). These compress about 5% smaller than gzip and bzip2.
+Over the lifetime of your distribution this will save a lot of
+people a small amount of download time and disk space, which adds
+up.
+
Create a tarball. Use the C<-s> option to specify a suitable suffix for
the tarball and directory name:
XXX if we go for extra tags and branches stuff, then add the extra details
here
-Optionally, you might want to compress your tarball more. Unix F<gzip>
-doesn't actually produce the smallest possible DEFLATE output. If you have the
-AdvanceCOMP suite (e.g. the C<advancecomp> port on macports), you can run
-
- $ advdef -z -4 ../perl-x.y.z-RC1.tar.gz
-
-which will probably shrink your tarball by about 5%. Over the lifetime of
-your distribution this will save a lot of people a small amount of download
-time and disk space, which adds up.
-
-(7-Zip on Windows is the same code as AdvanceCOMP, so Windows users get the
-smallest files first time)
-
-
Finally, clean up the temporary directory, e.g.
$ rm -rf ../perl-x.y.z-RC1
Upload both the .gz and .bz2 versions of the tarball.
-Wait until you receive notification emails from the PAUSE indexer
-confirming that your uploads have been received. IMPORTANT -- you will
-probably get an email that indexing has failed, due to module permissions.
-This is considered normal.
-
Do not proceed any further until you are sure that your tarballs are on
CPAN. Check your authors directory on one of the "fast" CPAN mirrors
(e.g., cpan.hexten.net
or cpan.cpantesters.org) to confirm that your uploads have been successful.
+I<You MUST SKIP this step for RC>
+
+Wait until you receive notification emails from the PAUSE indexer
+confirming that your uploads have been received. IMPORTANT -- you will
+probably get an email that indexing has failed, due to module permissions.
+This is considered normal.
+
=head3 publish tag
Mail p5p to announce your new release, with a quote you prepared earlier.
+Use the template at Porting/release_announcement_template.txt
=head3 update epigraphs.pod
Add your quote to F<Porting/epigraphs.pod> and commit it.
-
+Your release announcement will probably not have reached the web-visible
+archives yet, so you won't be able to include the customary link to the
+release announcement yet.
=head3 Module::CoreList nagging
Now you need to update various tables of contents related to perldelta,
most of which can be generated automatically.
-Edit F<pod.lst>: add the new entry, flagged as 'd', and unflag the previous
-entry from being 'd'; for example:
-
- -d perl5101delta Perl changes in version 5.10.1
- +d perl5102delta Perl changes in version 5.10.2
- + perl5101delta Perl changes in version 5.10.1
+Edit F<pod.lst>: add the new entry for the perlNNNdelta file for the
+current version (the file that will be symlinked to perldelta).
Manually create a temporary link to the new delta file; normally this is
done from the Makefile, but the Makefile is updated by buildtoc, and
buildtoc won't run without the file there:
- $ ln -s perldelta.pod pod/perl5102delta.pod
+ $ ln -s pod/perldelta.pod pod/perl5102delta.pod
Run C<perl pod/buildtoc --build-all> to update the F<perldelta> version in
the following files:
in the remaining files and test and commit.
+=head3 clean build and test
+
+Run a clean build and test to make sure nothing obvious is broken.
+
+In particular, F<Porting/perldelta_template.pod> is intentionally exempted
+from podchecker tests, to avoid false positives about placeholder text.
+However, once it's copied to F<pod/perldelta.pod> the contents can now
+cause test failures. Problems should resolved by doing one of the
+following:
+
+=over
+
+=item 1
+
+Replace placeholder text with correct text.
+
+=item 2
+
+If the problem is from a broken placeholder link, you can add it to the
+array C<@perldelta_ignore_links> in F<t/porting/podcheck.t>. Lines
+containing such links should be marked with C<XXX> so that they get
+cleaned up before the next release.
+
+=item 3
+
+Following the instructions output by F<t/porting/podcheck.t> on how to
+update its exceptions database.
+
+=back
+
=head3 push commits
Finally, push any commits done above.
=head3 bump RT version number
-If necessary, send an email to C<perlbug-admin at perl.org> requesting
-that new version numbers be added to the RT fields C<Perl Version> and
-C<Fixed In>.
-
+Log into http://rt.perl.org/ and check whether the new version is
+in the RT fields C<Perl Version> and C<Fixed In>. If not, send an
+email to C<perlbug-admin at perl.org> requesting this.
=head3 Relax!
=head2 Building a release - the day after
+=head3 link announcement in epigraphs.pod
+
+Add, to your quote to F<Porting/epigraphs.pod>, a link to the release
+announcement in the web-visible mailing list archive. Commit it.
+
=head3 check tarball availability
Check various website entries to make sure the that tarball has appeared
=head3 update dev.perl.org
-I<This step ONLY for BLEAD-POINT and MAINT>
+I<This step ONLY for BLEAD-FINAL and MAINT>
-Ask Rafael to update L<http://dev.perl.org/perl5/>.
+Ask Leo Lapworth to update L<http://dev.perl.org/perl5/>.
=head1 SOURCE
https://perl5.git.perl.org / perl5.git / blobdiff