X-Git-Url: https://perl5.git.perl.org/perl5.git/blobdiff_plain/606d51b7e00905cb4fd0fed6ee20d666006f4f1a..7ac0c33863364a2c29767a548fa0fc588e55d7cb:/Porting/release_managers_guide.pod diff --git a/Porting/release_managers_guide.pod b/Porting/release_managers_guide.pod index 935394b..e684860 100644 --- a/Porting/release_managers_guide.pod +++ b/Porting/release_managers_guide.pod @@ -7,6 +7,22 @@ release_managers_guide - Releasing a new version of perl 5.x Note that things change at each release, so there may be new things not covered here, or tools may need updating. +=head1 MAKING A CHECKLIST + +If you are preparing to do a release, you can run the +F script to generate a new version of this +document that starts with a checklist for your release. + +This script is run as: + + perl Porting/make-rmg-checklist \ + --type [BLEAD-POINT or MAINT or ...] > /tmp/rmg.pod + +You can also pass the C<--html> flag to generate an HTML document instead of +POD. + + perl Porting/make-rmg-checklist --html \ + --type [BLEAD-POINT or MAINT or ...] > /tmp/rmg.html =head1 SYNOPSIS @@ -19,11 +35,11 @@ pumpking. Blead releases from 5.11.0 forward are made each month on the 20th by a non-pumpking release engineer. The release engineer roster and schedule can be found in Porting/release_schedule.pod. -This document both helps as a check-list for the release engineer -and is a base for ideas on how the various tasks could be automated +This document both helps as a check-list for the release engineer +and is a base for ideas on how the various tasks could be automated or distributed. -The outline 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) @@ -49,7 +65,7 @@ The outline of a typical release cycle is as follows: Some of the tasks described below apply to all four types of release of Perl. (blead, RC, final release of maint, final release of blead). Some of these tasks apply only to a subset -of these release types. If a step does not apply to a given +of these release types. If a step does not apply to a given type of release, you will see a notation to that effect at the beginning of the step. @@ -80,6 +96,13 @@ changes since. It's essentially the same procedure as for making a release candidate, but with a whole bunch of extra post-release steps. +Note that for a maint release there are two versions of this guide to +consider: the one in the maint branch, and the one in blead. Which one to +use is a fine judgement. The blead one will be most up-to-date, while +it might describe some steps or new tools that aren't applicable to older +maint branches. It is probably best to review both versions of this +document, but to most closely follow the steps in the maint version. + =item A blead point release (BLEAD-POINT) A release with an odd version number, such as 5.15.0 or 5.15.1. @@ -98,15 +121,14 @@ with a whole bunch of extra post-release steps, even more than for MAINT. =back +=for checklist begin =head2 Prerequisites Before you can make an official release of perl, there are a few hoops you need to jump through: -=over 4 - -=item PAUSE account +=head3 PAUSE account with pumpkin status Make sure you have a PAUSE account suitable for uploading a perl release. If you don't have a PAUSE account, then request one: @@ -121,19 +143,20 @@ Andreas' email address at: https://pause.perl.org/pause/query?ACTION=pause_04imprint -=item search.cpan.org +=head3 search.cpan.org pumpkin status Make sure that search.cpan.org knows that you're allowed to upload perl distros. Contact Graham Barr to make sure that you're on the right list. -=item CPAN mirror +=head3 rt.perl.org update access -Some release engineering steps require a full mirror of the CPAN. -Work to fall back to using a remote mirror via HTTP is incomplete -but ongoing. (No, a minicpan mirror is not sufficient) +Make sure you have permission to close tickets on L +so you can respond to bug report as necessary during your stint. If you +don't, make an account (if you don't have one) and contact the pumpking +with your username to get ticket-closing permission. -=item git checkout and commit bit +=head3 git checkout and commit bit You will need a working C installation, checkout of the perl git repository and perl commit bit. For information about working @@ -144,48 +167,146 @@ release. Have a chat with whichever evil perl porter tried to talk you into the idea in the first place to figure out the best way to resolve the issue. +=head3 git clone of https://github.com/perlorg/perlweb + +For updating the L web pages, either a Github account or +sweet-talking somebody with a Github account into obedience is needed. This +is only needed on the day of the release or shortly afterwards. -=item Quotation for release announcement epigraph +=for checklist skip RC + +=head3 Quotation for release announcement epigraph I For all except an RC release of perl, you will need a quotation to use as an epigraph to your release announcement. - -=back - - =head2 Building a release - advance actions -The work of building a release candidate for a numbered release of -perl generally starts several weeks before the first release candidate. -Some of the following steps should be done regularly, but all I be -done in the run up to a release. - +The work of building a release candidate for an even numbered release +(BLEAD-FINAL) of perl generally starts several weeks before the first +release candidate. Some of the following steps should be done regularly, +but all I be done in the run up to a release. =head3 dual-life CPAN module synchronisation -Ensure that dual-life CPAN modules are synchronised with CPAN. Basically, -run the following: +To see which core distro versions differ from the current CPAN versions: - $ ./perl -Ilib Porting/core-cpan-diff -a -o /tmp/corediffs + $ ./perl -Ilib Porting/core-cpan-diff -x -a -to see any inconsistencies between the core and CPAN versions of distros, -then fix the core, or cajole CPAN authors as appropriate. See also the -C<-d> and C<-v> options for more detail. You'll probably want to use the -C<-c cachedir> option to avoid repeated CPAN downloads and may want to -use C<-m file:///mirror/path> if you made a local CPAN mirror. +Passing C<-u cpan> (and maybe C<-u undef>) will probably be helpful, since +those are the only types of distributions that you can actually affect as a +perl release manager (as opposed to a CPAN module maintainer). -To see which core distro versions differ from the current CPAN versions: +You can also run an actual diff of the contents of the modules, comparing core +to CPAN, to ensure that there were no erroneous/extraneous changes that need to +be dealt with. You do this by not passing the C<-x> option: - $ ./perl -Ilib Porting/core-cpan-diff -x -a + $ ./perl -Ilib Porting/core-cpan-diff -a -o /tmp/corediffs + +then fix the core, or cajole CPAN authors as appropriate. See also the C<-d> +and C<-v> options for more detail (and the C<-u> option as mentioned above). +You'll probably want to use the C<-c cachedir> option to avoid repeated CPAN +downloads and may want to use C<-m file:///mirror/path> if you made a local +CPAN mirror. Note that a minicpan mirror won't actually work, but can provide a +good first pass to quickly get a list of modules which definitely haven't +changed, to avoid having to download absolutely everything. If you are making a MAINT release, run C on both blead and maint, then diff the two outputs. Compare this with what you expect, and if necessary, fix things up. For example, you might think that both blead and maint are synchronised with a particular CPAN module, but one might -have some extra changes. +have some extra changes. + +=head3 How to sync a CPAN module with a cpan/ distro + +=over 4 + +=item * + +Fetch the most recent version from CPAN. + +=item * + +Unpack the retrieved tarball. Rename the old directory; rename the new +directory to the original name. + +=item * + +Restore any F<.gitignore> file. This can be done by issuing +C in the F directory. + +=item * + +Remove files we do not need. That is, remove any files that match the +entries in C<@IGNORE> in F, and anything that +matches the C section of the distro's entry in the C<%Modules> +hash. + +=item * + +Restore any files mentioned in the C section, using +C. Make any new customizations if necessary. Also, +restore any files that are mentioned in C<@IGNORE>, but were checked +into the repository anyway. + +=item * + +For any new files in the distro, determine whether they are needed. +If not, delete them, and list them in either C or C<@INGORE>. +Otherwise, add them to C, and run C to add the files +to the repository. + +=item * + +For any files that are gone, remove them from C, and use +C to tell git the files will be gone. + +=item * + +If the C file was changed in any of the previous steps, run +C. + +=item * + +For any files that have an execute bit set, either remove the execute +bit, or edit F + +=item * + +Run C (or C on Windows), see if C compiles. + +=item * + +Run the tests for the package. + +=item * + +Run the tests in F. + +=item * + +Update the C entry in F. + +=item * + +Run a full configure/build/test cycle. + +=item * + +If everything is ok, commit the changes. + +=back + +For entries with a non-simple C section, or with a C, you +may have to take more steps than listed above. + +F is a script that automates most of the steps +above; but see the comments at the beginning of the file. In particular, +it has not yet been exercised on Windows, but will certainly require a set +of Unix tools such as Cygwin, and steps that run C will need to run +C instead. =head3 dual-life CPAN module stability @@ -211,10 +332,11 @@ Ensure dual-life CPAN modules are stable, which comes down to: (also, try to inform the module's author) -=head3 smoking +=head3 monitor smoke tests for failures Similarly, monitor the smoking of core tests, and try to fix. See -L for a summary. See also +L and L +for a summary. See also L which has the raw reports. @@ -222,7 +344,7 @@ Similarly, monitor the smoking of perl for compiler warnings, and try to fix. -=head3 perldelta +=head3 update perldelta Get perldelta in a mostly finished state. @@ -233,13 +355,15 @@ edit the whole document. =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 +subsequent release candidates and the final release, it is not necessary to bump the version further. There is a tool to semi-automate this process: @@ -271,6 +395,8 @@ After editing, regenerate uconfig.h (this must be run on a system with a $ 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! @@ -287,7 +413,7 @@ Commit your changes: $ git commit -a -m 'Bump the perl version in various places for 5.x.y' At this point you may want to compare the commit with a previous bump to -see if they look similar. See commit 8891dd8d for an example of a +see if they look similar. See commit 0e79a3d1bc for an example of a previous version bump. When the version number is bumped, you should also update Module::CoreList @@ -313,23 +439,27 @@ release (so for 5.15.3 this would be 5.15.2). =head3 Check more build configurations -Check some more build configurations. The check that setuid builds and -installs is for < 5.11.0 only. +Try running the full test suite against multiple Perl configurations. Here are +some sets of Configure flags you can try: - $ sh Configure -Dprefix=/tmp/perl-5.x.y -Uinstallusrbinperl \ - -Duseshrplib -Dd_dosuid - $ make - $ LD_LIBRARY_PATH=`pwd` make test # or similar for useshrplib +=over 4 + +=item * + +C<-Duseshrplib -Dusesitecustomize> - $ make suidperl - $ su -c 'make install' - $ ls -l .../bin/sperl - -rws--x--x 1 root root 69974 2009-08-22 21:55 .../bin/sperl +=item * + +C<-Duserelocatableinc> -(Then delete the installation directory.) +=item * -XXX think of other configurations that need testing. +C<-Dusethreads> +=back + +If you have multiple compilers on your machine, you might also consider +compiling with C<-Dcc=$other_compiler>. =head3 update perlport @@ -342,7 +472,7 @@ If necessary update the list and the indicated version number. =head2 Building a release - on the day This section describes the actions required to make a release -that are performed on the actual day. +that are performed near to, or on the actual release day. =head3 re-check earlier actions @@ -352,10 +482,14 @@ L<"Building a release - advance actions"> to ensure they are all done and 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, do that now. + git checkout -b release-5.xx.yy =head3 finalize perldelta @@ -376,16 +510,63 @@ run through pod and spell checkers, e.g. 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. +=for checklist skip BLEAD-POINT MAINT RC + +=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 ... + +For example, for RC0 of 5.16.0: + + $ cd pod + $ git rm perldelta515*.pod + +=for checklist skip BLEAD BLEAD-POINT + +=head3 add recent perldeltas + +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 +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 +perldeltas from recent 5.10.x, 5.12.x etc maint releases, but not from +5.16.x or higher. Remember to + + $ git add ... + +=head3 update and commit perldelta files + +If you have added or removed any perldelta files via the previous two +steps, then edit F to add/remove them from its table of +contents, then run F to propagate your changes there +into all the other files that mention them (including F). You'll +need to C the files that it changes. + +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 (adding/removing perldeltas) +make sure you have a gitwise-clean perl directory (no modified files, unpushed commits etc): $ git status @@ -395,7 +576,6 @@ then configure and build perl so that you have a Makefile and porting tools: $ ./Configure -Dusedevel -des && make - =head3 update Module::CoreList Update C with module version data for the new release. @@ -405,20 +585,33 @@ from the maint branch, but commit the C changes in I and subsequently cherry-pick any releases since the last maint release and then your recent commit. XXX need a better example +[ 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 +workable approach. The main issue is keeping Module::CoreList +and its version number synchronised across all maint branches, blead and +CPAN, while having to bump its version number for every RC release. +See this brief p5p thread: + + Message-ID: <20130311174402.GZ2294@iabyn.com> + +If you can devise a workable system, feel free to try it out, and to +update the RMG accordingly! + +DAPM May 2013 ] + + F uses ftp.funet.fi to verify information about dual-lived -modules on CPAN. It can use a full, local CPAN mirror or fall back -to C or C to fetch only package metadata remotely. (If you're -on Win32, then installing Cygwin is one way to have commands like C -and C available.) +modules on CPAN. It can use a full, local CPAN mirror and/or fall back +on HTTP::Tiny to fetch package metadata remotely. -(If you'd prefer to have a full CPAN mirror, see +(If you'd prefer to have a full CPAN mirror, see http://www.cpan.org/misc/cpan-faq.html#How_mirror_CPAN) Then change to your perl checkout, and if necessary, $ 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 to delete the existing entries for this version from the C<%released> and C<%version> hashes: @@ -444,7 +637,9 @@ Check that file over carefully: $ git diff dist/Module-CoreList/lib/Module/CoreList.pm -If necessary, bump C<$VERSION> (there's no need to do this for +=head4 Bump C<$Module::CoreList::VERSION> + +If necessary, bump C<$Module::CoreList::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 has been modified in blead, and @@ -454,14 +649,42 @@ 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. +=head4 Bump C<$Module::CoreList::TieHashDelta::VERSION> + +C<$Module::CoreList::TieHashDelta::VERSION> should always be equal to +C<$Module::CoreList::VERSION>. Make sure the two versions match before +proceeding. + +Edit the version number in the new +C<< 'Module::CoreList::TieHashDelta' => 'X.YZ' >> entry, as that is likely to +reflect the previous version number. + +=head4 Bump C<$Module::CoreList::Utils::VERSION> + +C<$Module::CoreList::Utils::VERSION> should always be equal to +C<$Module::CoreList::VERSION>. Make sure the two versions match before +proceeding. + +Edit the version number in the new +C<< 'Module::CoreList::Utils' => 'X.YZ' >> entry, as that is likely to +reflect the previous version number. + +=head4 Bump version in Module::CoreList F + Also edit Module::CoreList's new version number in its F file. +=head4 Add Module::CoreList version bump to perldelta + Add a perldelta entry for the new Module::CoreList version. +=for checklist skip RC + +=head4 Update C<%Module::CoreList::released> and C + In addition, if this is a final release (rather than a release candidate): -=over 4 +=over 4 =item * @@ -470,30 +693,35 @@ Update this version's entry in the C<%released> hash with today's date. =item * Make sure that the script has correctly updated the C section +(Note, the C section is in +F) =back +=head4 Commit Module::CoreList changes + Finally, commit the new version of Module::CoreList: (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 BLEAD BLEAD-POINT -=head3 check MANIFEST +=head3 synchronise from blead's perlhist.pod -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 +For the first RC for a MAINT release, copy in the latest +F from blead; this will include details of newer +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 diff them +first to ensure that there's nothing in this branch that was forgotten +from blead: -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 + $ diff pod/perlhist.pod ..../blead/pod/perlhist.pod + $ cp ..../blead/pod/perlhist.pod pod/ + $ git commit -m 'sync perlhist from blead' pod/perlhist.pod +=for checklist skip RC =head3 update perlhist.pod @@ -508,10 +736,15 @@ if this is the first release under the stewardship of a new pumpking, make sure that his or her name is listed in the section entitled C. +I, also update the "SELECTED +RELEASE SIZES" section with the output of +F. + Be sure to commit your changes: $ git commit -m 'add new release to perlhist' pod/perlhist.pod +=for checklist skip BLEAD-POINT =head3 update patchlevel.h @@ -529,6 +762,14 @@ Be sure to commit your change: $ git commit -m 'bump version to RCnnn' patchlevel.h +=head3 run makemeta to update META files + + $ ./perl -Ilib Porting/makemeta + +Be sure to commit any changes (if applicable): + + $ git status # any changes? + $ git commit -m 'Update META files' META.* =head3 build, test and check a fresh perl @@ -545,9 +786,15 @@ Build perl, then make sure it passes its own test suite, and installs: Check that the output of C and C are as expected, 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 +paths. Note that as they have 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). C 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. @@ -556,8 +803,7 @@ Then delete the temporary installation. Push all your recent commits: - $ git push origin .... - + $ git push origin release-5.xx.yy =head3 tag the release @@ -615,27 +861,27 @@ Finally, clean up the temporary directory, e.g. =head3 test the tarball -=over 4 +Once you have a tarball it's time to test the tarball (not the repository). -=item * +=head4 Copy the tarball to a web server Copy the tarballs (.gz and possibly .bz2) to a web server somewhere you have access to. -=item * +=head4 Download the tarball to another machine -Download the tarball to some other machine. For a release candidate, +Download the tarball to some other machine. For a release candidate, you really want to test your tarball on two or more different platforms and architectures. The #p5p IRC channel on irc.perl.org is a good place to find willing victims. -=item * +=head4 Check that F works Check that basic configuration and tests work on each test machine: $ ./Configure -des && make all test -=item * +=head4 Run the test harness and install Check that the test harness and install work on each test machine: @@ -643,25 +889,23 @@ Check that the test harness and install work on each test machine: $ ./Configure -des -Dprefix=/install/path && make all test_harness install $ cd /install/path -=item * +=head4 Check C and C Check that the output of C and C are as expected, especially as regards version numbers, patch and/or RC levels, and @INC -paths. +paths. Note that the results may be different without a F<.git/> directory, which is why you should test from the tarball. -=item * - -Run the Installation Verification Procedure utility: +=head4 Run the Installation Verification Procedure utility $ ./perl utils/perlivp ... All tests successful. $ -=item * +=head4 Compare the installed paths to the last release 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 @@ -676,17 +920,13 @@ previous is 5.10.0: find . -type f | sort > /tmp/f2 diff -u /tmp/f[12] -=item * +=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.) - -=item * +=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: @@ -700,40 +940,21 @@ Check that your perl can run this: 42 $ -=item * - -Bootstrap the CPANPLUS client on the clean install: +=head4 Make sure that perlbug works - $ 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 programs being found on -the PATH before those of the Perl that you're trying to test.) - -=item * - -Install an XS module, for example: - - CPAN Terminal> i DBI - CPAN Terminal> quit - $ bin/perl -MDBI -e 1 - $ - -=item * - -Check that the L utility works. Try the following: +Test L with the following: $ bin/perlbug ... Subject: test bug report - Local perl administrator [yourself]: - Editor [vi]: - Module: - Category [core]: - Severity [low]: + Local perl administrator [yourself]: + Editor [vi]: + Module: + Category [core]: + Severity [low]: (edit report) Action (Send/Display/Edit/Subject/Save to File): f - Name of file to save message in [perlbug.rep]: + Name of file to save message in [perlbug.rep]: Action (Send/Display/Edit/Subject/Save to File): q and carefully examine the output (in F), especially @@ -741,8 +962,7 @@ the "Locally applied patches" section. If everything appears okay, then delete the file, and try it again, this time actually submitting the bug report. Check that it shows up, then remember to close it! -=back - +=for checklist skip BLEAD-POINT =head3 monitor smokes @@ -784,16 +1004,22 @@ may need to contact a PAUSE administrator or even bump the version of perl. 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. +=for checklist skip RC + +=head3 wait for indexing + +I + +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 @@ -802,6 +1028,7 @@ time to publish the tag you created earlier to the public git repo (e.g.): $ git push origin tag v5.11.0 +=for checklist skip BLEAD-POINT =head3 disarm patchlevel.h @@ -825,6 +1052,21 @@ Be sure to commit your change: Mail p5p to announce your new release, with a quote you prepared earlier. +Use the template at Porting/release_announcement_template.txt + +Send a carbon copy to C + +=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 @@ -833,6 +1075,13 @@ 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 blog about your epigraph + +If you have a blog, please consider writing an entry in your blog explaining +why you chose that particular quote for your epigraph. + +=for checklist skip RC + =head3 Module::CoreList nagging I @@ -840,6 +1089,7 @@ I Remind the current maintainer of C to push a new release to CPAN. +=for checklist skip RC =head3 new perldelta @@ -847,91 +1097,66 @@ I Create a new perldelta. -B: currently, the buildtoc below must be run in a I perl source -directory, as at least one of the pod files it expects to find is -autogenerated: perluniprops.pod. But you can't build perl if you've added -the new perldelta file and not updated toc. So, make sure you have a built -perl (with a pod/perluniprops.pod file) now, I continuing. - -First, update the F file to ignore the next -release's generated F file rather than this release's -one which we are about to set in stone (where NNN is the perl version number -without the dots. i.e. 5135 for 5.13.5). - - $ (edit pod/.gitignore ) - $ git add pod/.gitignore +=over 4 -Then, move the existing F to F, -and edit the moved delta file to change the C from C to -C. For example, assuming you just released 5.10.1, and are -about to create the 5.10.2 perldelta: +=item * - $ rm pod/perl5101delta.pod # remove the auto-generated file, if any - $ git mv pod/perldelta.pod pod/perl5101delta.pod - $ (edit pod/perl5101delta.pod to retitle) - $ git add pod/perl5101delta.pod +Confirm that you have a clean checkout with no local changes. -Then create a new empty perldelta.pod file for the new release; see -F. You should be able to do this by -just copying in a skeleton template and then doing a quick fix up of the -version numbers. Then commit the move and the new file. +=item * - $ cp -i Porting/perldelta_template.pod pod/perldelta.pod - $ (edit pod/perldelta.pod) - $ git add pod/perldelta.pod - $ git commit -m 'create perldelta for 5.10.2' +Run F -=head3 update perldelta TOC and references +=item * -Now you need to update various tables of contents related to perldelta, -most of which can be generated automatically. +Run the C commands it outputs to add new and modified files. -Edit F: add the new entry for the perlNNNdelta file for the -current version (the file that will be symlinked to perldelta). +=item * -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: +Verify that the build still works, by running C<./Configure> and +C. (On Win32 use the appropriate make utility). - $ ln -s perldelta.pod pod/perl5102delta.pod +=item * -Run C to update the F version in -the following files: +If F spots errors in the new F, +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. - MANIFEST - Makefile.SH - pod/perl.pod - vms/descrip_mms.template - win32/Makefile - win32/makefile.mk - win32/pod.mak +=item * -Finally, commit: +When C passes, commit the new perldelta. - $ git commit -a -m 'update TOC for perlNNNdelta' +=back At this point you may want to compare the commit with a previous bump to -see if they look similar. See commit dd885b5 for an example of a +see if they look similar. See commit 4eabcf701b for an example of a previous version bump. +=for checklist skip MAINT RC =head3 bump version -I +I 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 in git, e.g. 5.12.0 to 5.13.0. -First, add a new feature bundle to F, initially by just -copying the exiting entry, and bump the file's $VERSION; e.g. +First, add a new feature bundle to F, initially by just +copying the exiting entry, and bump the file's $VERSION (after the __END__ +marker); e.g. "5.14" => [qw(switch say state unicode_strings)], + "5.15" => [qw(switch say state unicode_strings)], +Run F to propagate the changes to F. + 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 @@ -940,9 +1165,28 @@ Run a clean build and test to make sure nothing obvious is broken. In particular, F is intentionally exempted from podchecker tests, to avoid false positives about placeholder text. However, once it's copied to F the contents can now -cause test failures. Problems should resolved either by replacing placeholder -text with correct text, or following the instructions output by -F on how to update its exceptions database. +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. Lines +containing such links should be marked with C so that they get +cleaned up before the next release. + +=item 3 + +Following the instructions output by F on how to +update its exceptions database. + +=back =head3 push commits @@ -950,6 +1194,7 @@ Finally, push any commits done above. $ git push origin .... +=for checklist skip BLEAD-POINT MAINT RC =head3 create maint branch @@ -965,6 +1210,8 @@ Assuming you're using git 1.7.x or newer: $ git push origin -u maint-5.12 +=for checklist skip BLEAD-POINT MAINT RC + =head3 make the maint branch available in the APC Clone the new branch into /srv/gitcommon/branches on camel so the APC will @@ -976,44 +1223,48 @@ receive its changes. And nag the sysadmins to make this directory available via rsync. +=for checklist skip BLEAD-POINT RC -=head3 copy perldelta.pod to other branches +=head3 copy perldelta.pod to blead I -Copy the perldelta.pod for this release into the other branches; for -example: +Copy the perldelta.pod for this release into blead; for example: + $ cd ..../blead $ cp -i ../5.10.x/pod/perldelta.pod pod/perl5101delta.pod # for example $ git add pod/perl5101delta.pod -Edit F to add an entry for the file, e.g.: +Edit F to add an entry for the file, e.g.: perl5101delta Perl changes in version 5.10.1 Then rebuild various files: - $ perl pod/buildtoc --build-all + $ perl Porting/pod_rules.pl Finally, commit: $ git commit -a -m 'add perlXXXdelta' -=head3 update perlhist.pod in other branches +=head3 copy perlhist.pod entries to blead Make sure any recent F entries are copied to -F on other branches -e.g. +F on blead. e.g. 5.8.9 2008-Dec-14 =head3 bump RT version number -Log into http://rt.perl.org/ and check whether the new version is -in the RT fields C and C. If not, send an -email to C requesting this. +Log into http://rt.perl.org/ and check whether the new version is in the RT +fields C and C. The easiest way to determine this is +to go to L and click on the drop +downs next to the C and C labels. + +If the new version is not listed there, send an email to C requesting this. =head3 Relax! @@ -1030,6 +1281,16 @@ Thanks for releasing perl! Add, to your quote to F, a link to the release announcement in the web-visible mailing list archive. Commit it. +=head3 Update Module::CoreList + +XXX -- experimental in response to [perl #118195] + +I + +After Module::CoreList has shipped to CPAN by the maintainer, update +Module::CoreList in the source so that it reflects the new blead +version number. + =head3 check tarball availability Check various website entries to make sure the that tarball has appeared @@ -1046,12 +1307,11 @@ to ensure that the tarballs are available on the website. Check C on CPAN (on a fast mirror) to ensure that links to the new tarballs have appeared. There should be links in C -(which is accumulating all new versions), links in C (which shows -only the latest version on each branch), and an appropriate mention in -C (which describes the latest versions). +(which is accumulating all new versions), and an appropriate mention in +C (which describes the latest versions in each branch, with links). These links should appear automatically, some hours after upload. -If they don't, or the C description is inadequate, +If they don't, or the C description is inadequate, ask Ask . =item * @@ -1067,13 +1327,23 @@ It should be visible at a URL like C. =back +=for checklist skip RC =head3 update dev.perl.org -I +I + +In your C repository, link to the new release. For a new +latest-maint release, edit F. Otherwise, +edit F. + +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. -Ask Leo Lapworth to update L. +This repository can be found on L. +=for checklist end =head1 SOURCE