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