release_managers_guide.pod revision 1.5
1=encoding utf8 2 3=head1 NAME 4 5release_managers_guide - Releasing a new version of perl 5.x 6 7Note that things change at each release, so there may be new things not 8covered here, or tools may need updating. 9 10=head1 MAKING A CHECKLIST 11 12If you are preparing to do a release, you can run the 13F<Porting/make-rmg-checklist> script to generate a new version of this 14document that starts with a checklist for your release. 15 16This script is run as: 17 18 perl Porting/make-rmg-checklist \ 19 --version [5.x.y-RC#] > /tmp/rmg.pod 20 21You can also pass the C<--html> flag to generate an HTML document instead of 22POD. 23 24 perl Porting/make-rmg-checklist --html \ 25 --version [5.x.y-RC#] > /tmp/rmg.html 26 27=head1 SYNOPSIS 28 29This document describes the series of tasks required - some automatic, some 30manual - to produce a perl release of some description, be that a release 31candidate, or final, numbered release of maint or blead. 32 33The release process has traditionally been executed by the current 34pumpking. Blead releases from 5.11.0 forward are made each month on the 3520th by a non-pumpking release engineer. The release engineer roster 36and schedule can be found in Porting/release_schedule.pod. 37 38This document both helps as a check-list for the release engineer 39and is a base for ideas on how the various tasks could be automated 40or distributed. 41 42The checklist of a typical release cycle is as follows: 43 44 (5.10.1 is released, and post-release actions have been done) 45 46 ...time passes... 47 48 a few weeks before the release, a number of steps are performed, 49 including bumping the version to 5.10.2 50 51 ...a few weeks pass... 52 53 perl-5.10.2-RC1 is released 54 55 perl-5.10.2 is released 56 57 post-release actions are performed, including creating new 58 perldelta.pod 59 60 ... the cycle continues ... 61 62=head1 DETAILS 63 64Some of the tasks described below apply to all four types of 65release of Perl. (blead, RC, final release of maint, final 66release of blead). Some of these tasks apply only to a subset 67of these release types. If a step does not apply to a given 68type of release, you will see a notation to that effect at 69the beginning of the step. 70 71=head2 Release types 72 73=over 4 74 75=item Release Candidate (RC) 76 77A release candidate is an attempt to produce a tarball that is a close as 78possible to the final release. Indeed, unless critical faults are found 79during the RC testing, the final release will be identical to the RC 80barring a few minor fixups (updating the release date in F<perlhist.pod>, 81removing the RC status from F<patchlevel.h>, etc). If faults are found, 82then the fixes should be put into a new release candidate, never directly 83into a final release. 84 85 86=item Stable/Maint release (MAINT). 87 88A release with an even version number, and subversion number > 0, such as 895.14.1 or 5.14.2. 90 91At this point you should have a working release candidate with few or no 92changes since. 93 94It's essentially the same procedure as for making a release candidate, but 95with a whole bunch of extra post-release steps. 96 97Note that for a maint release there are two versions of this guide to 98consider: the one in the maint branch, and the one in blead. Which one to 99use is a fine judgement. The blead one will be most up-to-date, while 100it might describe some steps or new tools that aren't applicable to older 101maint branches. It is probably best to review both versions of this 102document, but to most closely follow the steps in the maint version. 103 104=item A blead point release (BLEAD-POINT) 105 106A release with an odd version number, such as 5.15.0 or 5.15.1. 107 108This isn't for production, so it has less stability requirements than for 109other release types, and isn't preceded by RC releases. Other than that, 110it is similar to a MAINT release. 111 112=item Blead final release (BLEAD-FINAL) 113 114A release with an even version number, and subversion number == 0, such as 1155.14.0. That is to say, it's the big new release once per year. 116 117It's essentially the same procedure as for making a release candidate, but 118with a whole bunch of extra post-release steps, even more than for MAINT. 119 120=back 121 122=for checklist begin 123 124=head2 Prerequisites 125 126Before you can make an official release of perl, there are a few 127hoops you need to jump through: 128 129=head3 PAUSE account with pumpkin status 130 131Make sure you have a PAUSE account suitable for uploading a perl release. 132If you don't have a PAUSE account, then request one: 133 134 https://pause.perl.org/pause/query?ACTION=request_id 135 136Check that your account is allowed to upload perl distros: go to 137L<https://pause.perl.org/pause/authenquery?ACTION=who_pumpkin> and check that 138your PAUSE ID is listed there. If not, ask Andreas KE<0xf6>nig to add your ID 139to the list of people allowed to upload something called perl. You can find 140Andreas' email address at: 141 142 https://pause.perl.org/pause/query?ACTION=pause_04imprint 143 144=head3 rt.perl.org update access 145 146Make sure you have permission to close tickets on L<http://rt.perl.org/> 147so you can respond to bug reports as necessary during your stint. If you 148don't, make an account (if you don't have one) and contact the pumpking 149with your username to get ticket-closing permission. 150 151=head3 git checkout and commit bit 152 153You will need a working C<git> installation, checkout of the perl 154git repository and perl commit bit. For information about working 155with perl and git, see F<pod/perlgit.pod>. 156 157If you are not yet a perl committer, you won't be able to make a 158release. Have a chat with whichever evil perl porter tried to talk 159you into the idea in the first place to figure out the best way to 160resolve the issue. 161 162=head3 web-based file share 163 164You will need to be able to share tarballs with #p5p members for 165pre-release testing, and you may wish to upload to PAUSE via URL. 166Make sure you have a way of sharing files, such as a web server or 167file-sharing service. 168 169Porters have access to the "dromedary" server (users.perl5.git.perl.org), 170which has a F<public_html> directory to share files with. 171(L<http://users.perl5.git.perl.org/~username/perl-5.xx.y.tar.gz>) 172 173If you use Dropbox, you can append "raw=1" as a parameter to their usual 174sharing link to allow direct download (albeit with redirects). 175 176=head3 Quotation for release announcement epigraph 177 178You will need a quotation to use as an epigraph to your release announcement. 179It will live forever (along with Perl), so make it a good one. 180 181=head3 Install the previous version of perl 182 183During the testing phase of the release you have created, you will be 184asked to compare the installed files with a previous install. Save yourself 185some time on release day, and have a (clean) install of the previous 186version ready. 187 188=head2 Building a release - advance actions 189 190The work of building a release candidate for an even numbered release 191(BLEAD-FINAL) of perl generally starts several weeks before the first 192release candidate. Some of the following steps should be done regularly, 193but all I<must> be done in the run up to a release. 194 195=head3 dual-life CPAN module synchronisation 196 197To see which core distro versions differ from the current CPAN versions: 198 199 $ ./perl -Ilib Porting/core-cpan-diff -x -a 200 201However, this only checks whether the version recorded in 202F<Porting/Maintainers.pl> differs from the latest on CPAN. It doesn't tell you 203if the code itself has diverged from CPAN. 204 205You can also run an actual diff of the contents of the modules, comparing core 206to CPAN, to ensure that there were no erroneous/extraneous changes that need to 207be dealt with. You do this by not passing the C<-x> option: 208 209 $ ./perl -Ilib Porting/core-cpan-diff -a -o /tmp/corediffs 210 211Passing C<-u cpan> will probably be helpful, since it limits the search to 212distributions with 'cpan' upstream source. (It's OK for blead upstream to 213differ from CPAN because those dual-life releases usually come I<after> perl 214is released.) 215 216See also the C<-d> and C<-v> options for more detail (and the C<-u> option as 217mentioned above). You'll probably want to use the C<-c cachedir> option to 218avoid repeated CPAN downloads and may want to use C<-m file:///mirror/path> if 219you made a local CPAN mirror. Note that a minicpan mirror won't actually work, 220but can provide a good first pass to quickly get a list of modules which 221definitely haven't changed, to avoid having to download absolutely everything. 222 223For a BLEAD-POINT or BLEAD-FINAL release with 'cpan' upstream, if a CPAN 224release appears to be ahead of blead, then consider updating it (or asking the 225relevant porter to do so). (However, if this is a BLEAD-FINAL release or one of 226the last BLEAD-POINT releases before it and hence blead is in some kind of 227"code freeze" state (e.g. the sequence might be "contentious changes freeze", 228then "user-visible changes freeze" and finally "full code freeze") then any 229CPAN module updates must be subject to the same restrictions, so it may not be 230possible to update all modules until after the BLEAD-FINAL release.) If blead 231contains edits to a 'cpan' upstream module, this is naughty but sometimes 232unavoidable to keep blead tests passing. Make sure the affected file has a 233CUSTOMIZED entry in F<Porting/Maintainers.pl>. 234 235If you are making a MAINT release, run C<core-cpan-diff> on both blead and 236maint, then diff the two outputs. Compare this with what you expect, and if 237necessary, fix things up. For example, you might think that both blead 238and maint are synchronised with a particular CPAN module, but one might 239have some extra changes. 240 241=head4 Sync CPAN modules with the corresponding cpanE<sol> distro 242 243In most cases, once a new version of a distribution shipped with core has been 244uploaded to CPAN, the core version thereof can be synchronized automatically 245with the program F<Porting/sync-with-cpan>. (But see the comments at the 246beginning of that program. In particular, it has not yet been exercised on 247Windows as much as it has on Unix-like platforms.) 248 249If, however, F<Porting/sync-with-cpan> does not provide good results, follow 250the steps below. 251 252=over 4 253 254=item * 255 256Fetch the most recent version from CPAN. 257 258=item * 259 260Unpack the retrieved tarball. Rename the old directory; rename the new 261directory to the original name. 262 263=item * 264 265Restore any F<.gitignore> file. This can be done by issuing 266C<git checkout .gitignore> in the F<cpan/Distro> directory. 267 268=item * 269 270Remove files we do not need. That is, remove any files that match the 271entries in C<@IGNORABLE> in F<Porting/Maintainers.pl>, and anything that 272matches the C<EXCLUDED> section of the distro's entry in the C<%Modules> 273hash. 274 275=item * 276 277Restore any files mentioned in the C<CUSTOMIZED> section, using 278C<git checkout>. Make any new customizations if necessary. Also, 279restore any files that are mentioned in C<@IGNORE>, but were checked 280into the repository anyway. 281 282=item * 283 284For any new files in the distro, determine whether they are needed. 285If not, delete them, and list them in either C<EXCLUDED> or C<@IGNORABLE>. 286Otherwise, add them to C<MANIFEST>, and run C<git add> to add the files 287to the repository. 288 289=item * 290 291For any files that are gone, remove them from C<MANIFEST>, and use 292C<git rm> to tell git the files will be gone. 293 294=item * 295 296If the C<MANIFEST> file was changed in any of the previous steps, run 297C<perl Porting/manisort --output MANIFEST.sort; mv MANIFEST.sort MANIFEST>. 298 299=item * 300 301For any files that have an execute bit set, either remove the execute 302bit, or edit F<Porting/exec-bit.txt> 303 304=item * 305 306Run C<make> (or C<nmake> on Windows), see if C<perl> compiles. 307 308=item * 309 310Run the tests for the package. 311 312=item * 313 314Run the tests in F<t/porting> (C<make test_porting>). 315 316=item * 317 318Update the C<DISTRIBUTION> entry in F<Porting/Maintainers.pl>. 319 320=item * 321 322Run a full configure/build/test cycle. 323 324=item * 325 326If everything is ok, commit the changes. 327 328=back 329 330For entries with a non-simple C<FILES> section, or with a C<MAP>, you 331may have to take more steps than listed above. 332 333=head3 Ensure dual-life CPAN module stability 334 335This comes down to: 336 337 for each module that fails its regression tests on $current 338 did it fail identically on $previous? 339 if yes, "SEP" (Somebody Else's Problem, but try to make sure a 340 bug ticket is filed) 341 else work out why it failed (a bisect is useful for this) 342 343 attempt to group failure causes 344 345 for each failure cause 346 is that a regression? 347 if yes, figure out how to fix it 348 (more code? revert the code that broke it) 349 else 350 (presumably) it's relying on something un-or-under-documented 351 should the existing behaviour stay? 352 yes - goto "regression" 353 no - note it in perldelta as a significant bugfix 354 (also, try to inform the module's author) 355 356=head3 monitor smoke tests for failures 357 358Similarly, monitor the smoking of core tests, and try to fix. See 359L<https://tux.nl/perl5/smoke/index.html>, L<http://perl5.test-smoke.org/> 360and L<http://perl.develop-help.com> for a summary. See also 361L<http://www.nntp.perl.org/group/perl.daily-build.reports/> which has 362the raw reports. 363 364Similarly, monitor the smoking of perl for compiler warnings, and try to 365fix. 366 367=for checklist skip BLEAD-POINT 368 369=head3 monitor CPAN testers for failures 370 371For any release except a BLEAD-POINT: Examine the relevant analysis report(s) 372at L<http://analysis.cpantesters.org/beforemaintrelease> to see how the 373impending release is performing compared to previous releases with 374regard to building and testing CPAN modules. 375 376That page accepts a query parameter, C<pair> that takes a pair of 377colon-delimited versions to use for comparison. For example: 378 379L<http://analysis.cpantesters.org/beforemaintrelease?pair=5.20.2:5.22.0%20RC1> 380 381=head3 update perldelta 382 383Get perldelta in a mostly finished state. 384 385Read F<Porting/how_to_write_a_perldelta.pod>, and try to make sure that 386every section it lists is, if necessary, populated and complete. Copy 387edit the whole document. 388 389You won't be able to automatically fill in the "Updated Modules" section until 390after Module::CoreList is updated (as described below in 391L<"update Module::CoreList">). 392 393=head3 Bump the version number 394 395Do not do this yet for a BLEAD-POINT release! You will do this at the end of 396the release process. 397 398Increase the version number (e.g. from 5.12.0 to 5.12.1). 399 400For a release candidate for a stable perl, this should happen a week or two 401before the first release candidate to allow sufficient time for testing and 402smoking with the target version built into the perl executable. For 403subsequent release candidates and the final release, it is not necessary to 404bump the version further. 405 406There is a tool to semi-automate this process: 407 408 $ ./perl -Ilib Porting/bump-perl-version -i 5.10.0 5.10.1 409 410Remember that this tool is largely just grepping for '5.10.0' or whatever, 411so it will generate false positives. Be careful not change text like 412"this was fixed in 5.10.0"! 413 414Use git status and git diff to select changes you want to keep. 415 416Be particularly careful with F<INSTALL>, which contains a mixture of 417C<5.10.0>-type strings, some of which need bumping on every release, and 418some of which need to be left unchanged. 419See below in L<"update INSTALL"> for more details. 420 421For the first RC release leading up to a BLEAD-FINAL release, update the 422description of which releases are now "officially" supported in 423F<pod/perlpolicy.pod>. 424 425When doing a BLEAD-POINT or BLEAD-FINAL release, also make sure the 426C<PERL_API_*> constants in F<patchlevel.h> are in sync with the version 427you're releasing, unless you're absolutely sure the release you're about to 428make is 100% binary compatible to an earlier release. When releasing a MAINT 429perl version, the C<PERL_API_*> constants C<MUST NOT> be changed as we aim 430to guarantee binary compatibility in maint branches. 431 432After editing, regenerate uconfig.h (this must be run on a system with a 433/bin/sh available): 434 435 $ perl regen/uconfig_h.pl 436 437This might not cause any new changes. 438 439You may also need to regen opcodes: 440 441 $ ./perl -Ilib regen/opcode.pl 442 443Test your changes: 444 445 $ git clean -xdf # careful if you don't have local files to keep! 446 $ ./Configure -des -Dusedevel 447 $ make 448 $ make test 449 450Do note that at this stage, porting tests will fail. They will continue 451to fail until you've updated Module::CoreList, as described below. 452 453Commit your changes: 454 455 $ git status 456 $ git diff 457 B<review the delta carefully> 458 459 $ git commit -a -m 'Bump the perl version in various places for 5.x.y' 460 461At this point you may want to compare the commit with a previous bump to 462see if they look similar. See commit f7cf42bb69 for an example of a 463previous version bump. 464 465When the version number is bumped, you should also update Module::CoreList 466(as described below in L<"update Module::CoreList">) to reflect the new 467version number. 468 469=head3 update INSTALL 470 471Review and update INSTALL to account for the change in version number. 472The lines in F<INSTALL> about "is not binary compatible with" may require a 473correct choice of earlier version to declare incompatibility with. These are 474in the "Changes and Incompatibilities" and "Coexistence with earlier versions 475of perl 5" sections. 476 477Be particularly careful with the section "Upgrading from 5.X.Y or earlier". 478The "X.Y" needs to be changed to the most recent version that we are 479I<not> binary compatible with. 480 481For MAINT and BLEAD-FINAL releases, this needs to refer to the last 482release in the previous development cycle (so for example, for a 5.14.x 483release, this would be 5.13.11). 484 485For BLEAD-POINT releases, it needs to refer to the previous BLEAD-POINT 486release (so for 5.15.3 this would be 5.15.2). If the last release manager 487followed instructions, this should have already been done after the last 488blead release, so you may find nothing to do here. 489 490=head3 Check copyright years 491 492Check that the copyright years are up to date by running: 493 494 $ pushd t; ./perl -I../lib porting/copyright.t --now 495 496Remedy any test failures by editing README or perl.c accordingly (search for 497the "Copyright"). If updating perl.c, check if the file's own copyright date in 498the C comment at the top needs updating, as well as the one printed by C<-v>. 499 500=head3 Check more build configurations 501 502Try running the full test suite against multiple Perl configurations. Here are 503some sets of Configure flags you can try: 504 505=over 4 506 507=item * 508 509C<-Duseshrplib -Dusesitecustomize> 510 511=item * 512 513C<-Duserelocatableinc> 514 515=item * 516 517C<-Dusethreads> 518 519=back 520 521If you have multiple compilers on your machine, you might also consider 522compiling with C<-Dcc=$other_compiler>. 523 524=head3 update perlport 525 526L<perlport> has a section currently named I<Supported Platforms> that 527indicates which platforms are known to build in the current release. 528If necessary update the list and the indicated version number. 529 530=head3 check a readonly build 531 532Even before other prep work, follow the steps in L<build the tarball> and test 533it locally. Because a perl source tarballs sets many files read-only, it could 534test differently than tests run from the repository. After you're sure 535permissions aren't a problem, delete the generated directory and tarballs. 536 537 538=head2 Building a release - on the day 539 540This section describes the actions required to make a release 541that are performed near to, or on the actual release day. 542 543=head3 re-check earlier actions 544 545Review all the actions in the previous section, 546L<"Building a release - advance actions"> to ensure they are all done and 547up-to-date. 548 549=head3 create a release branch 550 551For BLEAD-POINT releases, making a release from a release branch avoids the 552need to freeze blead during the release. This is less important for 553BLEAD-FINAL, MAINT, and RC releases, since blead will already be frozen in 554those cases. Create the branch by running 555 556 git checkout -b release-5.xx.yy 557 558=head3 build a clean perl 559 560Make sure you have a gitwise-clean perl directory (no modified files, 561unpushed commits etc): 562 563 $ git status 564 $ git clean -dxf 565 566then configure and build perl so that you have a Makefile and porting tools: 567 568 $ ./Configure -Dusedevel -des && make 569 570=head3 Check module versions 571 572For each Perl release since the previous release of the current branch, check 573for modules that have identical version numbers but different contents by 574running: 575 576 $ ./perl -Ilib Porting/cmpVERSION.pl --tag=v5.X.YY 577 578(This is done automatically by F<t/porting/cmp_version.t> for the previous 579release of the current branch, but not for any releases from other branches.) 580 581Any modules that fail will need a version bump, plus a nudge to the upstream 582maintainer for 'cpan' upstream modules. 583 584=head3 update Module::CoreList 585 586=head4 Bump Module::CoreList* $VERSIONs 587 588If necessary, bump C<$VERSION> (there's no need to do this 589for every RC; in RC1, bump the version to a new clean number that will 590appear in the final release, and leave as-is for the later RCs and final). 591It may also happen that C<Module::CoreList> has been modified in blead, and 592hence has a new version number already. (But make sure it is not the same 593number as a CPAN release.) 594 595C<$Module::CoreList::Utils::VERSION> should always be equal to 596C<$Module::CoreList::VERSION>. If necessary, bump those two versions to match 597before proceeding. 598 599Once again, the files to modify are: 600 601=over 4 602 603=item * 604 605F<dist/Module-CoreList/lib/Module/CoreList.pm> 606 607=item * 608 609F<dist/Module-CoreList/lib/Module/CoreList/Utils.pm> 610 611=back 612 613=head4 Update C<Module::CoreList> with module version data for the new release. 614 615Note that if this is a MAINT release, you should run the following actions 616from the maint branch, but commit the C<CoreList.pm> changes in 617I<blead> and subsequently cherry-pick any releases since the last 618maint release and then your recent commit. XXX need a better example 619 620[ Note that the procedure for handling Module::CoreList in maint branches 621is a bit complex, and the RMG currently don't describe a full and 622workable approach. The main issue is keeping Module::CoreList 623and its version number synchronised across all maint branches, blead and 624CPAN, while having to bump its version number for every RC release. 625See this brief p5p thread: 626 627 Message-ID: <20130311174402.GZ2294@iabyn.com> 628 629If you can devise a workable system, feel free to try it out, and to 630update the RMG accordingly! 631 632DAPM May 2013 ] 633 634F<corelist.pl> uses ftp.funet.fi to verify information about dual-lived 635modules on CPAN. It can use a full, local CPAN mirror and/or fall back 636on HTTP::Tiny to fetch package metadata remotely. 637 638(If you'd prefer to have a full CPAN mirror, see 639L<http://www.cpan.org/misc/cpan-faq.html#How_mirror_CPAN>) 640 641Change to your perl checkout, and if necessary, 642 643 $ make 644 645Then, If you have a local CPAN mirror, run: 646 647 $ ./perl -Ilib Porting/corelist.pl ~/my-cpan-mirror 648 649Otherwise, run: 650 651 $ ./perl -Ilib Porting/corelist.pl cpan 652 653This will chug for a while, possibly reporting various warnings about 654badly-indexed CPAN modules unrelated to the modules actually in core. 655Assuming all goes well, it will update 656F<dist/Module-CoreList/lib/Module/CoreList.pm> and possibly 657F<dist/Module-CoreList/lib/Module/CoreList/Utils.pm>. 658 659Check those files over carefully: 660 661 $ git diff dist/Module-CoreList/lib/Module/CoreList.pm 662 $ git diff dist/Module-CoreList/lib/Module/CoreList/Utils.pm 663 664=head4 Bump version in Module::CoreList F<Changes> 665 666Also edit Module::CoreList's new version number in its F<Changes> file. 667This file is F<dist/Module-CoreList/Changes>. 668(BLEAD-POINT releases should have had this done already as a post-release 669action from the last commit.) 670 671=head4 Add Module::CoreList version bump to perldelta 672 673Add a perldelta entry for the new Module::CoreList version. You only 674need to do this if you want to add notes about the changes included 675with this version of Module::CoreList. Otherwise, its version bump 676will be automatically filled in below in L<finalize perldelta>. 677 678=for checklist skip RC 679 680=head4 Update C<%Module::CoreList::released> 681 682For any release except an RC: Update this version's entry in the C<%released> 683hash with today's date. 684 685=head4 Commit Module::CoreList changes 686 687Finally, commit the new version of Module::CoreList: 688(unless this is for MAINT; in which case commit it to blead first, then 689cherry-pick it back). 690 691 $ git commit -m 'Update Module::CoreList for 5.x.y' \ 692 dist/Module-CoreList/Changes \ 693 dist/Module-CoreList/lib/Module/CoreList.pm \ 694 dist/Module-CoreList/lib/Module/CoreList/Utils.pm 695 696=head4 Rebuild and test 697 698Build and test to get the changes into the currently built lib directory and to 699ensure all tests are passing. 700 701=head3 finalize perldelta 702 703Finalize the perldelta. In particular, fill in the Acknowledgements 704section, which can be generated with something like: 705 706 $ perl Porting/acknowledgements.pl v5.15.0..HEAD 707 708Fill in the "New/Updated Modules" sections now that Module::CoreList is 709updated: 710 711 $ ./perl -Ilib Porting/corelist-perldelta.pl \ 712 --mode=update pod/perldelta.pod 713 714For a MAINT release use something like this instead: 715 716 $ ./perl -Ilib Porting/corelist-perldelta.pl 5.020001 5.020002 \ 717 --mode=update pod/perldelta.pod 718 719Ideally, also fill in a summary of the major changes to each module for which 720an entry has been added by F<corelist-perldelta.pl>. 721 722Re-read the perldelta to try to find any embarrassing typos and thinkos; 723remove any C<TODO> or C<XXX> flags; update the "Known Problems" section 724with any serious issues for which fixes are not going to happen now; and 725run through pod and spell checkers, e.g. 726 727 $ podchecker -warnings -warnings pod/perldelta.pod 728 $ spell pod/perldelta.pod 729 $ aspell list < pod/perldelta.pod | sort -u 730 731Also, you may want to generate and view an HTML version of it to check 732formatting, e.g. 733 734 $ ./perl -Ilib ext/Pod-Html/bin/pod2html pod/perldelta.pod > \ 735 /tmp/perldelta.html 736 737If you make changes, be sure to commit them. 738 739=for checklist skip BLEAD-POINT MAINT RC 740 741=head3 remove stale perldeltas 742 743For the first RC release that is ONLY for a BLEAD-FINAL, the perldeltas 744from the BLEAD-POINT releases since the previous BLEAD-FINAL should have 745now been consolidated into the current perldelta, and hence are now just 746useless clutter. They can be removed using: 747 748 $ git rm <file1> <file2> ... 749 750For example, for RC0 of 5.16.0: 751 752 $ cd pod 753 $ git rm perldelta515*.pod 754 755=for checklist skip BLEAD-FINAL BLEAD-POINT 756 757=head3 add recent perldeltas 758 759For the first RC for a MAINT release, copy in any recent perldeltas from 760blead that have been added since the last release on this branch. This 761should include any recent maint releases on branches older than your one, 762but not newer. For example if you're producing a 5.14.x release, copy any 763perldeltas from recent 5.10.x, 5.12.x etc maint releases, but not from 7645.16.x or higher. Remember to 765 766 $ git add <file1> <file2> ... 767 768=head3 update and commit perldelta files 769 770If you have added or removed any perldelta files via the previous two 771steps, then edit F<pod/perl.pod> to add/remove them from its table of 772contents, then run F<Porting/pod_rules.pl> to propagate your changes there 773into all the other files that mention them (including F<MANIFEST>). You'll 774need to C<git add> the files that it changes. 775 776Then build a clean perl and do a full test 777 778 $ git status 779 $ git clean -dxf 780 $ ./Configure -Dusedevel -des 781 $ make 782 $ make test 783 784Once all tests pass, commit your changes. 785 786=head3 build a clean perl 787 788If you skipped the previous step (adding/removing perldeltas), 789again, make sure you have a gitwise-clean perl directory (no modified files, 790unpushed commits etc): 791 792 $ git status 793 $ git clean -dxf 794 795then configure and build perl so that you have a Makefile and porting tools: 796 797 $ ./Configure -Dusedevel -des && make 798 799=for checklist skip BLEAD-FINAL BLEAD-POINT 800 801=head3 synchronise from blead's perlhist.pod 802 803For the first RC for a MAINT release, copy in the latest 804F<pod/perlhist.pod> from blead; this will include details of newer 805releases in all branches. In theory, blead's version should be a strict 806superset of the one in this branch, but it's probably safest to examine the 807changes first, to ensure that there's nothing in this branch that was 808forgotten from blead. An easy way to do that is with C<< git checkout -p >>, 809to selectively apply any changes from the blead version to your current 810branch: 811 812 $ git fetch origin 813 $ git checkout -p origin/blead pod/perlhist.pod 814 $ git commit -m 'sync perlhist from blead' pod/perlhist.pod 815 816=head3 update perlhist.pod 817 818Add an entry to F<pod/perlhist.pod> with the release date, e.g.: 819 820 David 5.10.1 2009-Aug-06 821 822List yourself in the left-hand column, and if this is the first release 823that you've ever done, make sure that your name is listed in the section 824entitled C<THE KEEPERS OF THE PUMPKIN>. 825 826I<If you're making a BLEAD-FINAL release>, also update the "SELECTED 827RELEASE SIZES" section with the output of 828F<Porting/perlhist_calculate.pl>. 829 830Be sure to commit your changes: 831 832 $ git commit -m 'add new release to perlhist' pod/perlhist.pod 833 834=for checklist skip BLEAD-POINT 835 836=head3 update patchlevel.h 837 838I<You MUST SKIP this step for a BLEAD-POINT release> 839 840Update F<patchlevel.h> to add a C<-RC1>-or-whatever string; or, if this is 841a final release, remove it. For example: 842 843 static const char * const local_patches[] = { 844 NULL 845 + ,"RC1" 846 #ifdef PERL_GIT_UNCOMMITTED_CHANGES 847 ,"uncommitted-changes" 848 #endif 849 850Be sure to commit your change: 851 852 $ git commit -m 'bump version to RCnnn' patchlevel.h 853 854=head3 run makemeta to update META files 855 856 $ ./perl -Ilib Porting/makemeta 857 858Be sure to commit any changes (if applicable): 859 860 $ git status # any changes? 861 $ git commit -m 'Update META files' META.* 862 863=head3 build, test and check a fresh perl 864 865Build perl, then make sure it passes its own test suite, and installs: 866 867 $ git clean -xdf 868 $ ./Configure -des -Dprefix=/tmp/perl-5.x.y-pretest 869 870 # or if it's an odd-numbered version: 871 $ ./Configure -des -Dusedevel -Dprefix=/tmp/perl-5.x.y-pretest 872 873 $ make test install 874 875Check that the output of C</tmp/perl-5.x.y-pretest/bin/perl -v> and 876C</tmp/perl-5.x.y-pretest/bin/perl -V> are as expected, 877especially as regards version numbers, patch and/or RC levels, and @INC 878paths. Note that as they have been built from a git working 879directory, they will still identify themselves using git tags and 880commits. (Note that for an odd-numbered version, perl will install 881itself as C<perl5.x.y>). C<perl -v> will identify itself as: 882 883 This is perl 5, version X, subversion Y (v5.X.Y (v5.X.Z-NNN-gdeadbeef)) 884 885where 5.X.Z is the latest tag, NNN the number of commits since this tag, 886and C<< deadbeef >> commit of that tag. 887 888Then delete the temporary installation. 889 890=head3 create the release tag 891 892Create the tag identifying this release (e.g.): 893 894 $ git tag v5.11.0 -m "First release of the v5.11 series!" 895 896It is B<VERY> important that from this point forward, you not push 897your git changes to the Perl master repository. If anything goes 898wrong before you publish your newly-created tag, you can delete 899and recreate it. Once you push your tag, we're stuck with it 900and you'll need to use a new version number for your release. 901 902=head3 build the tarball 903 904Before you run the following, you might want to install 7-Zip (the 905C<p7zip-full> package under Debian or the C<p7zip> port on MacPorts) or 906the AdvanceCOMP suite (e.g. the C<advancecomp> package under Debian, 907or the C<advancecomp> port on macports - 7-Zip on Windows is the 908same code as AdvanceCOMP, so Windows users get the smallest files 909first time). These compress about 5% smaller than gzip and bzip2. 910Over the lifetime of your distribution this will save a lot of 911people a small amount of download time and disk space, which adds 912up. 913 914In order to produce the C<xz> tarball, XZ Utils are required. The C<xz> 915utility is included with most modern UNIX-type operating systems and 916is available for Cygwin. A Windows port is available from 917L<http://tukaani.org/xz/>. 918 919B<IMPORTANT>: if you are on OS X, you must export C<COPYFILE_DISABLE=1> 920to prevent OS X resource files from being included in your tarball. After 921creating the tarball following the instructions below, inspect it to ensure 922you don't have files like F<._foobar>. 923 924Create a tarball. Use the C<-s> option to specify a suitable suffix for 925the tarball and directory name: 926 927 $ cd root/of/perl/tree 928 $ make distclean # make sure distclean works 929 $ git clean -xdf # make sure perl and git agree on files 930 # git clean should not output anything! 931 $ git status --ignored # and there's nothing lying around 932 933 $ perl Porting/makerel -x -s RC1 # for a release candidate 934 $ perl Porting/makerel -x # for the release itself 935 936This creates the directory F<../perl-x.y.z-RC1> or similar, copies all 937the MANIFEST files into it, sets the correct permissions on them, then 938tars it up as F<../perl-x.y.z-RC1.tar.gz>. The C<-x> also produces a 939C<tar.xz> file. 940 941If you're getting your tarball suffixed with -uncommitted and you're sure 942your changes were all committed, you can override the suffix with: 943 944 $ perl Porting/makerel -x -s '' 945 946XXX if we go for extra tags and branches stuff, then add the extra details 947here 948 949Finally, clean up the temporary directory, e.g. 950 951 $ rm -rf ../perl-x.y.z-RC1 952 953=head3 test the tarball 954 955Once you have a tarball it's time to test the tarball (not the repository). 956 957=head4 Copy the tarball to a web server 958 959Copy the tarballs (.gz and .xz) to a web server somewhere you have access to. 960 961=head4 Download the tarball to another machine and unpack it 962 963Download the tarball to some other machine. For a release candidate, 964you really want to test your tarball on two or more different platforms 965and architectures. 966 967=head4 Ask #p5p to test the tarball on different platforms 968 969Once you've verified the tarball can be downloaded and unpacked, 970ask the #p5p IRC channel on irc.perl.org for volunteers to test the 971tarballs on whatever platforms they can. 972 973If you're not confident in the tarball, you can defer this step until after 974your own tarball testing, below. 975 976=head4 Check that F<Configure> works 977 978Check that basic configuration and tests work on each test machine: 979 980 $ ./Configure -des && make all minitest test 981 982 # Or for a development release: 983 $ ./Configure -Dusedevel -des && make all minitest test 984 985=head4 Run the test harness and install 986 987Check that the test harness and install work on each test machine: 988 989 $ make distclean 990 $ ./Configure -des -Dprefix=/install/path && make all test_harness install 991 $ cd /install/path 992 993=head4 Check C<perl -v> and C<perl -V> 994 995Check that the output of C<perl -v> and C<perl -V> are as expected, 996especially as regards version numbers, patch and/or RC levels, and @INC 997paths. 998 999Note that the results may be different without a F<.git/> directory, 1000which is why you should test from the tarball. 1001 1002=head4 Run the Installation Verification Procedure utility 1003 1004 $ ./perl utils/perlivp 1005 ... 1006 All tests successful. 1007 $ 1008 1009=head4 Compare the installed paths to the last release 1010 1011Compare the pathnames of all installed files with those of the previous 1012release (i.e. against the last installed tarball on this branch which you 1013have previously verified using this same procedure). In particular, look 1014for files in the wrong place, or files no longer included which should be. 1015For example, suppose the about-to-be-released version is 5.10.1 and the 1016previous is 5.10.0: 1017 1018 cd installdir-5.10.0/ 1019 find . -type f | perl -pe's/5\.10\.0/5.10.1/g' | sort > /tmp/f1 1020 cd installdir-5.10.1/ 1021 find . -type f | sort > /tmp/f2 1022 diff -u /tmp/f[12] 1023 1024=head4 Bootstrap the CPAN client 1025 1026Bootstrap the CPAN client on the clean install: 1027 1028 $ bin/cpan 1029 1030 # Or, perhaps: 1031 $ bin/cpan5.xx.x 1032 1033=head4 Install the Inline module with CPAN and test it 1034 1035If you're using C<local::lib>, you should reset your environment before 1036performing these actions: 1037 1038 $ unset PERL5LIB PERL_MB_OPT PERL_LOCAL_LIB_ROOT PERL_MM_OPT 1039 1040Try installing a popular CPAN module that's reasonably complex and that 1041has dependencies; for example: 1042 1043 CPAN> install Inline::C 1044 CPAN> quit 1045 1046Check that your perl can run this: 1047 1048 $ bin/perl -lwe "use Inline C => q[int f() { return 42;}]; print f" 1049 42 1050 $ 1051 1052=head4 Make sure that perlbug works 1053 1054Test L<perlbug> with the following: 1055 1056 $ bin/perlbug 1057 ... 1058 Subject: test bug report 1059 Local perl administrator [yourself]: 1060 Editor [vi]: 1061 Module: 1062 Category [core]: 1063 Severity [low]: 1064 (edit report) 1065 Action (Send/Display/Edit/Subject/Save to File): f 1066 Name of file to save message in [perlbug.rep]: 1067 Action (Send/Display/Edit/Subject/Save to File): q 1068 1069and carefully examine the output (in F<perlbug.rep]>), especially 1070the "Locally applied patches" section. If everything appears okay, then 1071delete the file, and try it again, this time actually submitting the bug 1072report. Check that it shows up, then remember to close it! 1073 1074=for checklist skip BLEAD-POINT 1075 1076=head3 monitor smokes 1077 1078XXX This is probably irrelevant if working on a release branch, though 1079MAINT or RC might want to push a smoke branch and wait. 1080 1081Wait for the smoke tests to catch up with the commit which this release is 1082based on (or at least the last commit of any consequence). 1083 1084Then check that the smoke tests pass (particularly on Win32). If not, go 1085back and fix things. 1086 1087Note that for I<BLEAD-POINT> releases this may not be practical. It takes a 1088long time for the smokers to catch up, especially the Win32 1089smokers. This is why we have a RC cycle for I<MAINT> and I<BLEAD-FINAL> 1090releases, but for I<BLEAD-POINT> releases sometimes the best you can do is 1091to plead with people on IRC to test stuff on their platforms, fire away, 1092and then hope for the best. 1093 1094=head3 upload to PAUSE 1095 1096Once smoking is okay, upload it to PAUSE. This is the point of no return. 1097If anything goes wrong after this point, you will need to re-prepare 1098a new release with a new minor version or RC number. 1099 1100 https://pause.perl.org/ 1101 1102(Log in, then select 'Upload a file to CPAN') 1103 1104If your workstation is not connected to a high-bandwidth, 1105high-reliability connection to the Internet, you should probably use the 1106"GET URL" feature (rather than "HTTP UPLOAD") to have PAUSE retrieve the 1107new release from wherever you put it for testers to find it. This will 1108eliminate anxious gnashing of teeth while you wait to see if your 110915 megabyte HTTP upload successfully completes across your slow, twitchy 1110cable modem. 1111 1112You can make use of your home directory on dromedary for 1113this purpose: F<http://users.perl5.git.perl.org/~USERNAME> maps to 1114F</home/USERNAME/public_html>, where F<USERNAME> is your login account 1115on dromedary. 1116 1117I<Remember>: if your upload is partially successful, you 1118may need to contact a PAUSE administrator or even bump the version of perl. 1119 1120Upload the .gz and .xz versions of the tarball. 1121 1122Note: You can also use the command-line utility to upload your tarballs, if 1123you have it configured: 1124 1125 cpan-upload perl-5.X.Y.tar.gz 1126 cpan-upload perl-5.X.Y.tar.xz 1127 1128Do not proceed any further until you are sure that your tarballs are on CPAN. 1129Check your authors directory www.cpan.org (the globally balanced "fast" 1130mirror) to confirm that your uploads have been successful. 1131 1132=for checklist skip RC BLEAD-POINT 1133 1134=head3 wait for indexing 1135 1136I<You MUST SKIP this step for RC and BLEAD-POINT> 1137 1138Wait until you receive notification emails from the PAUSE indexer 1139confirming that your uploads have been received. IMPORTANT -- you will 1140probably get an email that indexing has failed, due to module permissions. 1141This is considered normal. 1142 1143=for checklist skip BLEAD-POINT 1144 1145=head3 disarm patchlevel.h 1146 1147I<You MUST SKIP this step for BLEAD-POINT release> 1148 1149Disarm the F<patchlevel.h> change; for example, 1150 1151 static const char * const local_patches[] = { 1152 NULL 1153 - ,"RC1" 1154 #ifdef PERL_GIT_UNCOMMITTED_CHANGES 1155 ,"uncommitted-changes" 1156 #endif 1157 1158Be sure to commit your change: 1159 1160 $ git commit -m 'disarm RCnnn bump' patchlevel.h 1161 1162=head3 announce to p5p 1163 1164Mail perl5-porters@perl.org to announce your new release, with a quote you prepared earlier. 1165Get the SHA1 digests from the PAUSE email responses. 1166 1167Use the template at Porting/release_announcement_template.txt 1168 1169Send a carbon copy to C<noc@metacpan.org> 1170 1171=head3 merge release branch back to blead 1172 1173Merge the (local) release branch back into master now, and delete it. 1174 1175 git checkout blead 1176 git pull 1177 git merge release-5.xx.yy 1178 git push 1179 git branch -d release-5.xx.yy 1180 1181Note: The merge will create a merge commit if other changes have been pushed 1182to blead while you've been working on your release branch. Do NOT rebase your 1183branch to avoid the merge commit (as you might normally do when merging a 1184small branch into blead) since doing so will invalidate the tag that you 1185created earlier. 1186 1187=head3 publish the release tag 1188 1189Now that you've shipped the new perl release to PAUSE and pushed your changes 1190to the Perl master repository, it's time to publish the tag you created 1191earlier too (e.g.): 1192 1193 $ git push origin tag v5.11.0 1194 1195=head3 update epigraphs.pod 1196 1197Add your quote to F<Porting/epigraphs.pod> and commit it. 1198You can include the customary link to the release announcement even before your 1199message reaches the web-visible archives by looking for the X-List-Archive 1200header in your message after receiving it back via perl5-porters. 1201 1202=head3 blog about your epigraph 1203 1204If you have a blog, please consider writing an entry in your blog explaining 1205why you chose that particular quote for your epigraph. 1206 1207=for checklist skip RC 1208 1209=head3 Release schedule 1210 1211I<You MUST SKIP this step for RC> 1212 1213Tick the entry for your release in F<Porting/release_schedule.pod>. 1214 1215=for checklist skip RC 1216 1217=head3 Module::CoreList nagging 1218 1219I<You MUST SKIP this step for RC> 1220 1221Remind the current maintainer of C<Module::CoreList> to push a new release 1222to CPAN. 1223 1224=for checklist skip RC 1225 1226=head3 new perldelta 1227 1228I<You MUST SKIP this step for RC> 1229 1230Create a new perldelta. 1231 1232=over 4 1233 1234=item * 1235 1236Confirm that you have a clean checkout with no local changes. 1237 1238=item * 1239 1240Run: 1241 perl Porting/new-perldelta.pl 1242 1243=item * 1244 1245Run the C<git add> commands it outputs to add new and modified files. 1246 1247=item * 1248 1249Verify that the build still works, by running C<./Configure> and 1250C<make test_porting>. (On Win32 use the appropriate make utility). 1251 1252=item * 1253 1254If F<t/porting/podcheck.t> spots errors in the new F<pod/perldelta.pod>, 1255run C<./perl -MTestInit t/porting/podcheck.t | less> for more detail. 1256Skip to the end of its test output to see the options it offers you. 1257 1258=item * 1259 1260When C<make test_porting> passes, commit the new perldelta. 1261 1262 git commit -m'new perldelta for 5.X.Y' 1263 1264=back 1265 1266At this point you may want to compare the commit with a previous bump to 1267see if they look similar. See commit ba03bc34a4 for an example of a 1268previous version bump. 1269 1270=for checklist skip MAINT RC 1271 1272=head3 bump version 1273 1274I<You MUST SKIP this step for RC and MAINT> 1275 1276If this was a BLEAD-FINAL release (i.e. the first release of a new maint 1277series, 5.x.0 where x is even), then bump the version in the blead branch 1278in git, e.g. 5.12.0 to 5.13.0. 1279 1280First, add a new feature bundle to F<regen/feature.pl>, initially by just 1281copying the exiting entry, and bump the file's $VERSION (after the __END__ 1282marker); e.g. 1283 1284 "5.14" => [qw(switch say state unicode_strings)], 1285 + "5.15" => [qw(switch say state unicode_strings)], 1286 1287Run F<regen/feature.pl> to propagate the changes to F<lib/feature.pm>. 1288 1289Then follow the section L<"Bump the version number"> to bump the version 1290in the remaining files and test and commit. 1291 1292If this was a BLEAD-POINT release, then just follow the section 1293L<"Bump the version number">. 1294 1295After bumping the version, follow the section L<"update INSTALL"> to 1296ensure all version number references are correct. 1297 1298(Note: The version is NOT bumped immediately after a MAINT release in order 1299to avoid confusion and wasted time arising from bug reports relating to 1300"intermediate versions" such as 5.20.1-and-a-bit: If the report is caused 1301by a bug that gets fixed in 5.20.2 and this intermediate version already 1302calls itself 5.20.2 then much time can be wasted in figuring out why there 1303is a failure from something that "should have been fixed". If the bump is 1304late then there is a much smaller window of time for such confusing bug 1305reports to arise. (The opposite problem -- trying to figure out why there 1306*is* a bug in something calling itself 5.20.1 when in fact the bug was 1307introduced later -- shouldn't arise for MAINT releases since they should, 1308in theory, only contain bug fixes but never regressions.)) 1309 1310=head3 clean build and test 1311 1312Run a clean build and test to make sure nothing obvious is broken. 1313 1314In particular, F<Porting/perldelta_template.pod> is intentionally exempted 1315from podchecker tests, to avoid false positives about placeholder text. 1316However, once it's copied to F<pod/perldelta.pod> the contents can now 1317cause test failures. Problems should be resolved by doing one of the 1318following: 1319 1320=over 1321 1322=item 1 1323 1324Replace placeholder text with correct text. 1325 1326=item 2 1327 1328If the problem is from a broken placeholder link, you can add it to the 1329array C<@perldelta_ignore_links> in F<t/porting/podcheck.t>. Lines 1330containing such links should be marked with C<XXX> so that they get 1331cleaned up before the next release. 1332 1333=item 3 1334 1335Following the instructions output by F<t/porting/podcheck.t> on how to 1336update its exceptions database. 1337 1338=back 1339 1340=head3 push commits 1341 1342Finally, push any commits done above. 1343 1344 $ git push origin .... 1345 1346=for checklist skip BLEAD-POINT MAINT RC 1347 1348=head3 create maint branch 1349 1350I<You MUST SKIP this step for RC, BLEAD-POINT, MAINT> 1351 1352If this was a BLEAD-FINAL release (i.e. the first release of a new maint 1353series, 5.x.0 where x is even), then create a new maint branch based on 1354the commit tagged as the current release. 1355 1356Assuming you're using git 1.7.x or newer: 1357 1358 $ git checkout -b maint-5.12 v5.12.0 1359 $ git push origin -u maint-5.12 1360 1361 1362=for checklist skip BLEAD-POINT MAINT RC 1363 1364=head3 make the maint branch available in the APC 1365 1366Clone the new branch into /srv/gitcommon/branches on camel so the APC will 1367receive its changes. 1368 1369 $ git clone --branch maint-5.14 /gitroot/perl.git \ 1370 ? /srv/gitcommon/branches/perl-5.14.x 1371 $ chmod -R g=u /srv/gitcommon/branches/perl-5.14.x 1372 1373And nag the sysadmins to make this directory available via rsync. 1374 1375XXX Who are the sysadmins? Contact info? 1376 1377=for checklist skip BLEAD-POINT RC 1378 1379=head3 copy perldelta.pod to blead 1380 1381I<You MUST SKIP this step for RC, BLEAD-POINT> 1382 1383Copy the perldelta.pod for this release into blead; for example: 1384 1385 $ cd ..../blead 1386 $ cp -i ../5.10.x/pod/perldelta.pod pod/perl5101delta.pod #for example 1387 $ git add pod/perl5101delta.pod 1388 1389Don't forget to set the NAME correctly in the new file (e.g. perl5101delta 1390rather than perldelta). 1391 1392Edit F<pod/perl.pod> to add an entry for the file, e.g.: 1393 1394 perl5101delta Perl changes in version 5.10.1 1395 1396Then rebuild various files: 1397 1398 $ perl Porting/pod_rules.pl 1399 1400Finally, commit and push: 1401 1402 $ git commit -a -m 'add perlXXXdelta' 1403 $ git push origin .... 1404 1405=for checklist skip BLEAD-POINT 1406 1407=head3 copy perlhist.pod entries to blead 1408 1409Make sure any recent F<pod/perlhist.pod> entries are copied to 1410F<perlhist.pod> on blead. e.g. 1411 1412 5.8.9 2008-Dec-14 1413 1414=head3 Relax! 1415 1416I<You MUST RETIRE to your preferred PUB, CAFE or SEASIDE VILLA for some 1417much-needed rest and relaxation>. 1418 1419Thanks for releasing perl! 1420 1421=head2 Building a release - the day after 1422 1423=for checklist skip BLEAD-FINAL MAINT RC 1424 1425=head3 update Module::CoreList 1426 1427I<After a BLEAD-POINT release only> 1428 1429After Module::CoreList has shipped to CPAN by the maintainer, update 1430Module::CoreList in the source so that it reflects the new blead 1431version number: 1432 1433=over 4 1434 1435=item * 1436 1437Update F<Porting/Maintainers.pl> to list the new DISTRIBUTION on CPAN, 1438which should be identical to what is currently in blead. 1439 1440=item * 1441 1442Bump the $VERSION in F<dist/Module-CoreList/lib/Module/CoreList.pm> 1443and F<dist/Module-CoreList/lib/Module/CoreList/Utils.pm>. 1444 1445=item * 1446 1447If you have a local CPAN mirror, run: 1448 1449 $ ./perl -Ilib Porting/corelist.pl ~/my-cpan-mirror 1450 1451Otherwise, run: 1452 1453 $ ./perl -Ilib Porting/corelist.pl cpan 1454 1455This will update F<dist/Module-CoreList/lib/Module/CoreList.pm> and 1456F<dist/Module-CoreList/lib/Module/CoreList/Utils.pm> as it did before, 1457but this time adding new sections for the next BLEAD-POINT release. 1458 1459=item * 1460 1461Add the new $Module::CoreList::VERSION to 1462F<dist/Module-CoreList/Changes>. 1463 1464=item * 1465 1466Update F<pod/perldelta.pod> to mention the upgrade to Module::CoreList. 1467 1468=item * 1469 1470Remake perl to get your changed .pm files propagated into F<lib/> and 1471then run at least the F<dist/Module-CoreList/t/*.t> tests and the 1472test_porting makefile target to check that they're ok. 1473 1474=item * 1475 1476Run 1477 1478 $ ./perl -Ilib -MModule::CoreList \ 1479 -le 'print Module::CoreList->find_version($]) ? "ok" : "not ok"' 1480 1481and check that it outputs "ok" to prove that Module::CoreList now knows 1482about blead's current version. 1483 1484=item * 1485 1486Commit and push your changes. 1487 1488=back 1489 1490=head3 check tarball availability 1491 1492Check various website entries to make sure the that tarball has appeared 1493and is properly indexed: 1494 1495=over 4 1496 1497=item * 1498 1499Check your author directory under L<http://www.cpan.org/authors/id/> 1500to ensure that the tarballs are available on the website. 1501 1502=item * 1503 1504Check F</src> on CPAN (on a fast mirror) to ensure that links to 1505the new tarballs have appeared: There should be links in F</src/5.0> 1506(which is accumulating all new versions), and (for BLEAD-FINAL and 1507MAINT only) an appropriate mention in F</src/README.html> (which describes 1508the latest versions in each stable branch, with links). 1509 1510The F</src/5.0> links should appear automatically, some hours after upload. 1511If they don't, or the F</src> description is inadequate, 1512ask Ask <ask@perl.org>. 1513 1514=item * 1515 1516Check L<http://www.cpan.org/src/> to ensure that the F</src> updates 1517have been correctly mirrored to the website. 1518If they haven't, ask Ask <ask@perl.org>. 1519 1520=item * 1521 1522Check L<http://search.cpan.org> to see if it has indexed the distribution. 1523It should be visible at a URL like C<http://search.cpan.org/dist/perl-5.10.1/>. 1524 1525=back 1526 1527=head3 update release manager's guide 1528 1529Go over your notes from the release (you did take some, right?) and update 1530F<Porting/release_managers_guide.pod> with any fixes or information that 1531will make life easier for the next release manager. 1532 1533=for checklist end 1534 1535=head1 SOURCE 1536 1537Based on 1538L<http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2009-05/msg00608.html>, 1539plus a whole bunch of other sources, including private correspondence. 1540 1541=cut 1542 1543