[PATCH] perlcommunity.pod: add information about OSDC.fr
[p5sagit/p5-mst-13.2.git] / Porting / release_managers_guide.pod
CommitLineData
7277a900 1=head1 NAME
2
3release_managers_guide - Releasing a new version of perl 5.x
4
c67d51c3 5As of August 2009, this file is mostly complete, although it is missing
6some detail on doing a major release (e.g. 5.10.0 -> 5.12.0). Note that
d60a1044 7things change at each release, so there may be new things not covered
8here, or tools may need updating.
f6af4394 9
7277a900 10=head1 SYNOPSIS
11
f6af4394 12This document describes the series of tasks required - some automatic, some
13manual - to produce a perl release of some description, be that a snaphot,
8c35d285 14release candidate, or final, numbered release of maint or blead.
f6af4394 15
8c35d285 16The release process has traditionally been executed by the current
ee76d676 17pumpking. Blead releases from 5.11.0 forward are made each month on the
1820th by a non-pumpking release engineer. The release engineer roster
19and schedule can be found in Porting/release_schedule.pod.
7277a900 20
8c35d285 21This document both helps as a check-list for the release engineer
22and is a base for ideas on how the various tasks could be automated
23or distributed.
7277a900 24
636a1918 25The outline of a typical release cycle is as follows:
f6af4394 26
636a1918 27 (5.10.1 is released, and post-release actions have been done)
f6af4394 28
29 ...time passes...
30
31 an occasional snapshot is released, that still identifies itself as
32 5.10.1
33
34 ...time passes...
35
36 a few weeks before the release, a number of steps are performed,
37 including bumping the version to 5.10.2
636a1918 38
39 ...a few weeks passes...
46743ef7 40
f6af4394 41 perl-5.10.2-RC1 is released
42
43 perl-5.10.2 is released
44
45 post-release actions are performed, including creating new
46 perl5103delta.pod
47
48 ... the cycle continues ...
7277a900 49
50=head1 DETAILS
51
8c35d285 52Some of the tasks described below apply to all four types of
53release of Perl. (snapshot, RC, final release of maint, final
54release of blead). Some of these tasks apply only to a subset
55of these release types. If a step does not apply to a given
56type of release, you will see a notation to that effect at
57the beginning of the step.
58
59=head2 Release types
60
61=over 4
62
63=item Snapshot
64
65A snapshot is intended to encourage in-depth testing from time-to-time,
66for example after a key point in the stabilisation of a branch. It
67requires fewer steps than a full release, and the version number of perl in
68the tarball will usually be the same as that of the previous release.
69
70=item Release Candidate (RC)
71
d60a1044 72A release candidate is an attempt to produce a tarball that is a close as
73possible to the final release. Indeed, unless critical faults are found
74during the RC testing, the final release will be identical to the RC
75barring a few minor fixups (updating the release date in F<perlhist.pod>,
76removing the RC status from F<patchlevel.h>, etc). If faults are found,
77then the fixes should be put into a new release candidate, never directly
78into a final release.
8c35d285 79
80=item Stable/Maint release
81
82At this point you should have a working release candidate with few or no
83changes since.
84
85It's essentially the same procedure as for making a release candidate, but
86with a whole bunch of extra post-release steps.
87
88=item Blead release
89
90It's essentially the same procedure as for making a release candidate, but
91with a whole bunch of extra post-release steps.
92
93=back
7277a900 94
fd838dcf 95=head2 Prerequisites
96
97Before you can make an official release of perl, there are a few
98hoops you need to jump through:
99
100=over 4
101
8c35d285 102=item PAUSE account
103
104I<SKIP this step for SNAPSHOT>
fd838dcf 105
106Make sure you have a PAUSE account suitable for uploading a perl release.
107If you don't have a PAUSE account, then request one:
108
109 https://pause.perl.org/pause/query?ACTION=request_id
110
111Check that your account is allowed to upload perl distros: goto
112https://pause.perl.org/, login, then select 'upload file to CPAN'; there
113should be a "For pumpkings only: Send a CC" tickbox. If not, ask Andreas
114König to add your ID to the list of people allowed to upload something
115called perl. You can find Andreas' email address at:
4d2c8158 116
fd838dcf 117 https://pause.perl.org/pause/query?ACTION=pause_04imprint
118
8c35d285 119=item CPAN mirror
120
121Some release engineering steps require a full mirror of the CPAN.
122Work to fall back to using a remote mirror via HTTP is incomplete
123but ongoing. (No, a minicpan mirror is not sufficient)
124
125=item git checkout and commit bit
fd838dcf 126
127You will need a working C<git> installation, checkout of the perl
128git repository and perl commit bit. For information about working
129with perl and git, see F<pod/perlrepository.pod>.
130
131If you are not yet a perl committer, you won't be able to make a
132release. Have a chat with whichever evil perl porter tried to talk
133you into the idea in the first place to figure out the best way to
134resolve the issue.
135
f6af4394 136
8c35d285 137=item Quotation for release announcement epigraph
f6af4394 138
8c35d285 139I<SKIP this step for SNAPSHOT and RC>
f6af4394 140
8c35d285 141For a numbered blead or maint release of perl, you will need a quotation
142to use as an epigraph to your release announcement. (There's no harm
143in having one for a snapshot, but it's not required).
46743ef7 144
f6af4394 145
146=back
147
f6af4394 148
2e831dfd 149=head2 Building a release - advance actions
8c35d285 150
151The work of building a release candidate for a numbered release of
152perl generally starts several weeks before the first release candidate.
52a66c2c 153Some of the following steps should be done regularly, but all I<must> be
154done in the run up to a release.
7277a900 155
156=over 4
157
f6af4394 158=item *
159
8c35d285 160I<You MAY SKIP this step for SNAPSHOT>
161
f6af4394 162Ensure that dual-life CPAN modules are synchronised with CPAN. Basically,
163run the following:
164
db3f805e 165 $ ./perl -Ilib Porting/core-cpan-diff -a -o /tmp/corediffs
7277a900 166
f6af4394 167to see any inconsistencies between the core and CPAN versions of distros,
168then fix the core, or cajole CPAN authors as appropriate. See also the
169C<-d> and C<-v> options for more detail. You'll probably want to use the
170C<-c cachedir> option to avoid repeated CPAN downloads.
7277a900 171
f6af4394 172To see which core distro versions differ from the current CPAN versions:
7277a900 173
db3f805e 174 $ ./perl -Ilib Porting/core-cpan-diff -x -a
7277a900 175
52a66c2c 176If you are making a maint release, run C<core-cpan-diff> on both blead and
636a1918 177maint, then diff the two outputs. Compare this with what you expect, and if
178necessary, fix things up. For example, you might think that both blead
179and maint are synchronised with a particular CPAN module, but one might
180have some extra changes.
181
f6af4394 182=item *
7277a900 183
8c35d285 184I<You MAY SKIP this step for SNAPSHOT>
185
f6af4394 186Ensure dual-life CPAN modules are stable, which comes down to:
7277a900 187
188 for each module that fails its regression tests on $current
f6af4394 189 did it fail identically on $previous?
190 if yes, "SEP" (Somebody Else's Problem)
191 else work out why it failed (a bisect is useful for this)
7277a900 192
193 attempt to group failure causes
194
195 for each failure cause
f6af4394 196 is that a regression?
197 if yes, figure out how to fix it
198 (more code? revert the code that broke it)
199 else
200 (presumably) it's relying on something un-or-under-documented
201 should the existing behaviour stay?
202 yes - goto "regression"
203 no - note it in perldelta as a significant bugfix
204 (also, try to inform the module's author)
1aff5354 205
f6af4394 206=item *
7277a900 207
8c35d285 208I<You MAY SKIP this step for SNAPSHOT>
209
f6af4394 210Similarly, monitor the smoking of core tests, and try to fix.
7277a900 211
f6af4394 212=item *
7277a900 213
8c35d285 214I<You MAY SKIP this step for SNAPSHOT>
215
636a1918 216Similarly, monitor the smoking of perl for compiler warnings, and try to
217fix.
218
219=item *
220
8c35d285 221I<You MAY SKIP this step for SNAPSHOT>
222
f6af4394 223Run F<Porting/cmpVERSION.pl> to compare the current source tree with the
224previous version to check for for modules that have identical version
225numbers but different contents, e.g.:
7277a900 226
f6af4394 227 $ cd ~/some-perl-root
228 $ ./perl -Ilib Porting/cmpVERSION.pl -xd ~/my_perl-tarballs/perl-5.10.0 .
229
230then bump the version numbers of any non-dual-life modules that have
231changed since the previous release, but which still have the old version
232number. If there is more than one maintenance branch (e.g. 5.8.x, 5.10.x),
233then compare against both.
234
235Note that some of the files listed may be generated (e.g. copied from ext/
236to lib/, or a script like lib/lib_pm.PL is run to produce lib/lib.pm);
237make sure you edit the correct file!
238
239Once all version numbers have been bumped, re-run the checks.
240
241Then run again without the -x option, to check that dual-life modules are
242also sensible.
243
54356a6f 244 $ ./perl -Ilib Porting/cmpVERSION.pl -d ~/my_perl-tarballs/perl-5.10.0 .
245
55878aed 246=item *
247
8c35d285 248I<You MAY SKIP this step for SNAPSHOT>
249
f6af4394 250Get perldelta in a mostly finished state.
db3f805e 251
636a1918 252Peruse F<Porting/how_to_write_a_perldelta.pod>, and try to make sure that
253every section it lists is, if necessary, populated and complete. Copy
254edit the whole document.
f6af4394 255
256=item *
257
8c35d285 258I<You MUST SKIP this step for SNAPSHOT>
259
2e831dfd 260A week or two before the first release candidate, bump the perl version
261number (e.g. from 5.10.0 to 5.10.1), to allow sufficient time for testing
262and smoking with the target version built into the perl executable. For
263subsequent release candidates and the final release, it it not necessary
264to bump the version further.
f6af4394 265
266There is a tool to semi-automate this process. It works in two stages.
267First, it generates a list of suggested changes, which you review and
268edit; then you feed this list back and it applies the edits. So, first
52a66c2c 269scan the source directory looking for likely candidates. The command line
270arguments are the old and new version numbers, and -s means scan:
f6af4394 271
272 $ Porting/bump-perl-version -s 5.10.0 5.10.1 > /tmp/scan
273
52a66c2c 274This produces a file containing a list of suggested edits, e.g.:
f6af4394 275
276 NetWare/Makefile
277
278 89: -MODULE_DESC = "Perl 5.10.0 for NetWare"
279 +MODULE_DESC = "Perl 5.10.1 for NetWare"
280
281i.e. in the file F<NetWare/Makefile>, line 89 would be changed as shown.
282Review the file carefully, and delete any -/+ line pairs that you don't
52a66c2c 283want changing. You can also edit just the C<+> line to change the
284suggested replacement text. Remember that this tool is largely just
285grepping for '5.10.0' or whatever, so it will generate false positives. Be
286careful not change text like "this was fixed in 5.10.0"! Then run:
f6af4394 287
288 $ Porting/bump-perl-version -u < /tmp/scan
289
54356a6f 290which will update all the files shown.
f6af4394 291
292Be particularly careful with F<INSTALL>, which contains a mixture of
293C<5.10.0>-type strings, some of which need bumping on every release, and
52a66c2c 294some of which need to be left unchanged. Also note that this tool
295currently only detects a single substitution per line: so in particular,
296this line in README.vms needs special handling:
f6af4394 297
298 rename perl-5^.10^.1.dir perl-5_10_1.dir
7277a900 299
54356a6f 300Have a look a couple lines up from that. You'll see roman numerals.
301Update those too. Find someone with VMS clue if you have to update
302the Roman numerals for a .0 release.
303
304Commit your changes:
305
306 $ git st
307 $ git diff
308 B<review the delta carefully>
309
310 $ git commit -a -m 'Bump the perl version in various places for 5.x.y'
dc0a62a1 311
312=item *
313
8c35d285 314I<You MUST SKIP this step for SNAPSHOT>
315
dc0a62a1 316Review and update INSTALL to account for the change in version number;
317in particular, the "Coexistence with earlier versions of perl 5" section.
318
f6af4394 319=item *
7277a900 320
8c35d285 321I<You MUST SKIP this step for SNAPSHOT>
322
f6af4394 323Update the F<Changes> file to contain the git log command which would show
324all the changes in this release. You will need assume the existence of a
325not-yet created tag for the forthcoming release; e.g.
7277a900 326
b4d6b7c5 327 git log ... perl-5.10.0..perl-5.12.0
7277a900 328
f6af4394 329Due to warts in the perforce-to-git migration, some branches require extra
330exclusions to avoid other branches being pulled in. Make sure you have the
331correct incantation: replace the not-yet-created tag with C<HEAD> and see
52a66c2c 332if C<git log> produces roughly the right number of commits across roughly the
333right time period (you may find C<git log --pretty=oneline | wc> useful).
dc0a62a1 334
f6af4394 335=item *
7277a900 336
52a66c2c 337Check some more build configurations. The check that setuid builds and
338installs is for < 5.11.0 only.
339
340 $ sh Configure -Dprefix=/tmp/perl-5.x.y -Uinstallusrbinperl \
341 -Duseshrplib -Dd_dosuid
342 $ make
343 $ LD_LIBRARY_PATH=`pwd` make test # or similar for useshrplib
7277a900 344
52a66c2c 345 $ make suidperl
346 $ su -c 'make install'
347 $ ls -l .../bin/sperl
348 -rws--x--x 1 root root 69974 2009-08-22 21:55 .../bin/sperl
7277a900 349
52a66c2c 350(Then delete the installation directory.)
7277a900 351
52a66c2c 352XXX think of other configurations that need testing.
7277a900 353
f6af4394 354=item *
7277a900 355
8c35d285 356I<You MAY SKIP this step for SNAPSHOT>
357
f6af4394 358Update F<AUTHORS>, using the C<Porting/checkAUTHORS.pl> script, and if
ce80ee91 359necessary, update the script to include new alias mappings for porters
360already in F<AUTHORS>
f6af4394 361
ce80ee91 362 $ git log | perl Porting/checkAUTHORS.pl --acknowledged AUTHORS -
f6af4394 363
2e831dfd 364=back
365
366=head2 Building a release - on the day
367
368This section describes the actions required to make a release (or snapshot
369etc) that are performed on the actual day.
370
371=over 4
372
373=item *
374
375Review all the items in the previous section,
376L<"Building a release - advance actions"> to ensure they are all done and
377up-to-date.
378
8c35d285 379=item *
380
a0db33fe 381I<You MAY SKIP this step for SNAPSHOT>
2e831dfd 382
a0db33fe 383Re-read the perldelta to try to find any embarrassing typos and thinkos;
384remove any C<TODO> or C<XXX> flags; update the "Known Problems" section
385with any serious issues for which fixes are not going to happen now; and
386run through pod and spell checkers, e.g.
2e831dfd 387
bf8ea215 388 $ podchecker -warnings -warnings pod/perl5101delta.pod
389 $ spell pod/perl5101delta.pod
2e831dfd 390
a0db33fe 391Also, you may want to generate and view an HTML version of it to check
392formatting, e.g.
2e831dfd 393
bf8ea215 394 $ perl pod/pod2html pod/perl5101delta.pod > /tmp/perl5101delta.html
2e831dfd 395
8c35d285 396=item *
397
a0db33fe 398Make sure you have a gitwise-clean perl directory (no modified files,
399unpushed commits etc):
8c35d285 400
a0db33fe 401 $ git status
8c35d285 402
403=item *
404
a0db33fe 405If not already built, Configure and build perl so that you have a Makefile
406and porting tools:
8c35d285 407
52a66c2c 408 $ ./Configure -Dusedevel -des && make
8c35d285 409
410=item *
411
a0db33fe 412Check that files managed by F<regen.pl> and friends are up to date. From
413within your working directory:
8c35d285 414
a0db33fe 415 $ git status
416 $ make regen
417 $ make regen_perly
418 $ git status
8c35d285 419
a0db33fe 420If any of the files managed by F<regen.pl> have changed, then you should
421re-make perl to check that it's okay, then commit the updated versions:
8c35d285 422
73ec421b 423 $ git commit -a -m 'make regen; make regen_perly'
8c35d285 424
425=item *
426
a0db33fe 427Rebuild META.yml:
bfadf2ba 428
a0db33fe 429 $ rm META.yml
430 $ make META.yml
431 $ git diff
bfadf2ba 432
a0db33fe 433XXX it would be nice to make Porting/makemeta use regen_lib.pl
434to get the same 'update the file if its changed' functionality
435we get with 'make regen' etc.
bfadf2ba 436
a0db33fe 437Commit META.yml if it has changed:
dd0e54ba 438
a0db33fe 439 $ git commit -m 'Update META.yml' META.yml
dd0e54ba 440
bfadf2ba 441=item *
442
443I<You MUST SKIP this step for SNAPSHOT>
444
52a66c2c 445Update C<Module::Corelist> with module version data for the new release.
bfadf2ba 446
447Note that if this is a maint release, you should run the following actions
dd0e54ba 448from the maint directory, but commit the C<Corelist.pm> changes in
449I<blead> and subsequently cherry-pick it.
bfadf2ba 450
a0db33fe 451F<corelist.pl> uses ftp.funet.fi to verify information about dual-lived
bfadf2ba 452modules on CPAN. It can use a full, local CPAN mirror or fall back
453to C<wget> or C<curl> to fetch only package metadata remotely.
454
455(If you'd prefer to have a full CPAN mirror, see
456http://www.cpan.org/misc/cpan-faq.html#How_mirror_CPAN)
457
a0db33fe 458Then change to your perl checkout, and if necessary,
bfadf2ba 459
a0db33fe 460 $ make perl
bfadf2ba 461
52a66c2c 462If this not the first update for this version, first edit
d5bddf6e 463F<dist/Module-CoreList/lib/Module/CoreList.pm> to delete the existing
2ce7d676 464entries for this version from the C<%released> and C<%version> hashes:
465they will have a key like C<5.010001> for 5.10.1.
52a66c2c 466
467XXX the edit-in-place functionality of Porting/corelist.pl should
468be fixed to handle this automatically.
469
bf8ea215 470Then, If you have a local CPAN mirror, run:
bfadf2ba 471
bfadf2ba 472 $ ./perl -Ilib Porting/corelist.pl ~/my-cpan-mirror
473
474Otherwise, run:
475
bfadf2ba 476 $ ./perl -Ilib Porting/corelist.pl cpan
477
52a66c2c 478This will chug for a while, possibly reporting various warnings about
479badly-indexed CPABN modules unreltaed to the modules actually in core.
2ce7d676 480Assuming all goes well, it will update
d5bddf6e 481F<dist/Module-CoreList/lib/Module/CoreList.pm>.
bfadf2ba 482
483Check that file over carefully:
484
d5bddf6e 485 $ git diff dist/Module-CoreList/lib/Module/CoreList.pm
bfadf2ba 486
bfadf2ba 487If necessary, bump C<$VERSION> (there's no need to do this for
488every RC; in RC1, bump the version to a new clean number that will
489appear in the final release, and leave as-is for the later RCs and final).
490
491Edit the version number in the new C<< 'Module::CoreList' => 'X.YZ' >>
492entry, as that is likely to reflect the previous version number.
493
a0db33fe 494In addition, if this is a final release (rather than a release candidate):
bfadf2ba 495
496=over 4
497
498=item *
499
500Update this version's entry in the C<%released> hash with today's date.
501
502=item *
503
504Make sure that the script has correctly updated the C<CAVEATS> section
505
506=back
507
508Finally, commit the new version of Module::CoreList:
a0db33fe 509(unless this is for maint; in which case commit it blead first, then
510cherry-pick it back).
bfadf2ba 511
770cf6ff 512 $ git commit -m 'Update Module::CoreList for 5.x.y' dist/Module-CoreList/lib/Module/CoreList.pm
bfadf2ba 513
bfadf2ba 514=item *
515
a0db33fe 516Check that the manifest is sorted and correct:
8c35d285 517
a0db33fe 518 $ make manisort
519 $ make distclean
300b5357 520 $ git clean -xdf # This shouldn't be necessary if distclean is correct
a0db33fe 521 $ perl Porting/manicheck
52a66c2c 522 $ git status
a0db33fe 523
d5bddf6e 524 XXX manifest _sorting_ is now checked with make test_porting
525
a0db33fe 526Commit MANIFEST if it has changed:
527
528 $ git commit -m 'Update MANIFEST' MANIFEST
529
530=item *
531
532I<You MUST SKIP this step for SNAPSHOT>
533
534Add an entry to F<pod/perlhist.pod> with the current date, e.g.:
535
536 David 5.10.1-RC1 2009-Aug-06
537
538Make sure that the correct pumpking is listed in the left-hand column, and
539if this is the first release under the stewardship of a new pumpking, make
540sure that his or her name is listed in the section entitled
541C<THE KEEPERS OF THE PUMPKIN>.
542
543Be sure to commit your changes:
544
545 $ git commit -m 'add new release to perlhist' pod/perlhist.pod
8c35d285 546
547=item *
548
d7eb1120 549I<You MUST SKIP this step for SNAPSHOT>
550
a42352ee 551Update F<patchlevel.h> to add a C<-RC1>-or-whatever string; or, if this is
552a final release, remove it. For example:
d7eb1120 553
554 static const char * const local_patches[] = {
555 NULL
556 + ,"RC1"
557 PERL_GIT_UNPUSHED_COMMITS /* do not remove this line */
558
559Be sure to commit your change:
560
561 $ git commit -m 'bump version to RCnnn' patchlevel.h
562
563=item *
564
a0db33fe 565Build perl, then make sure it passes its own test suite, and installs:
566
567 $ git clean -xdf
a42352ee 568 $ ./Configure -des -Dprefix=/tmp/perl-5.x.y-pretest
569
570 # or if it's an odd-numbered version:
a0db33fe 571 $ ./Configure -des -Dusedevel -Dprefix=/tmp/perl-5.x.y-pretest
a42352ee 572
a0db33fe 573 $ make test install
574
575=item *
576
52a66c2c 577Check that the output of C</tmp/perl-5.x.y-pretest/bin/perl -v> and
578C</tmp/perl-5.x.y-pretest/bin/perl -V> are as expected,
a0db33fe 579especially as regards version numbers, patch and/or RC levels, and @INC
52a66c2c 580paths. Note that as they have been been built from a git working
581directory, they will still identify themselves using git tags and
582commits.
583
584Then delete the temporary installation.
585
586=item *
587
588If this is maint release, make sure F<Porting/mergelog> is saved and
589committed.
a0db33fe 590
591=item *
592
593Push all your recent commits:
594
595 $ git push origin ....
596
96054f12 597
598=item *
599
600I<You MUST SKIP this step for SNAPSHOT>
601
602Tag the release:
603
604 $ git tag v5.11.0 -m'First release of the v5.11 series!'
605
f662f3b7 606It is VERY important that from this point forward, you not push
607your git changes to the Perl master repository. If anything goes
608wrong before you publish your newly-created tag, you can delete
609and recreate it. Once you push your tag, we're stuck with it
610and you'll need to use a new version number for your release.
611
a0db33fe 612=item *
613
8c35d285 614Create a tarball. Use the C<-s> option to specify a suitable suffix for
615the tarball and directory name:
616
617 $ cd root/of/perl/tree
618 $ make distclean
75a012fe 619 $ git clean -xdf # make sure perl and git agree on files
620 $ git status # and there's nothing lying around
8c35d285 621
622 $ perl Porting/makerel -b -s `git describe` # for a snapshot
623 $ perl Porting/makerel -b -s RC1 # for a release candidate
624 $ perl Porting/makerel -b # for a final release
625
626This creates the directory F<../perl-x.y.z-RC1> or similar, copies all
627the MANIFEST files into it, sets the correct permissions on them,
628adds DOS line endings to some, then tars it up as
629F<../perl-x.y.z-RC1.tar.gz>. With C<-b>, it also creates a C<tar.bz2> file.
630
96054f12 631
8c35d285 632XXX if we go for extra tags and branches stuff, then add the extra details
633here
634
635=item *
636
a42352ee 637Clean up the temporary directory, e.g.
638
639 $ rm -rf ../perl-x.y.z-RC1
640
641=item *
642
8c35d285 643Copy the tarballs (.gz and possibly .bz2) to a web server somewhere you
644have access to.
645
646=item *
647
648Download the tarball to some other machine. For a release candidate,
649you really want to test your tarball on two or more different platforms
650and architectures. The #p5p IRC channel on irc.perl.org is a good place
651to find willing victims.
652
653=item *
654
655Check that basic configuration and tests work on each test machine:
656
657 $ ./Configure -des && make all test
f6af4394 658
659=item *
660
8c35d285 661Check that the test harness and install work on each test machine:
662
a42352ee 663 $ make distclean
8c35d285 664 $ ./Configure -des -Dprefix=/install/path && make all test_harness install
a42352ee 665 $ cd /install/path
8c35d285 666
667=item *
668
669Check that the output of C<perl -v> and C<perl -V> are as expected,
670especially as regards version numbers, patch and/or RC levels, and @INC
671paths.
672
673Note that the results may be different without a F<.git/> directory,
674which is why you should test from the tarball.
675
676=item *
677
459fc3ca 678Run the Installation Verification Procedure utility:
679
680 $ bin/perlivp
681 ...
682 All tests successful.
683 $
684
685=item *
686
d60a1044 687Compare the pathnames of all installed files with those of the previous
688release (i.e. against the last installed tarball on this branch which you
689have previously verified using this same procedure). In particular, look
690for files in the wrong place, or files no longer included which should be.
691For example, suppose the about-to-be-released version is 5.10.1 and the
692previous is 5.10.0:
693
694 cd installdir-5.10.0/
695 find . -type f | perl -pe's/5\.10\.0/5.10.1/g' | sort > /tmp/f1
696 cd installdir-5.10.1/
697 find . -type f | sort > /tmp/f2
698 diff -u /tmp/f[12]
699
700=item *
701
8c35d285 702Bootstrap the CPAN client on the clean install:
703
75a012fe 704 $ bin/perl -MCPAN -e'shell'
8c35d285 705
706=item *
707
a42352ee 708Try installing a popular CPAN module that's reasonably complex and that
709has dependencies; for example:
8c35d285 710
a42352ee 711 CPAN> install Inline
712 CPAN> quit
8c35d285 713
714Check that your perl can run this:
715
75a012fe 716 $ bin/perl -lwe 'use Inline C => "int f() { return 42;} "; print f'
a42352ee 717 42
718 $
8c35d285 719
720=item *
721
722Bootstrap the CPANPLUS client on the clean install:
723
75a012fe 724 $ bin/cpanp
8c35d285 725
8c35d285 726=item *
727
a42352ee 728Install an XS module, for example:
8c35d285 729
a42352ee 730 CPAN Terminal> i DBI
731 CPAN Terminal> quit
732 $ bin/perl -MDBI -e 1
75a012fe 733 $
8c35d285 734
735=item *
736
bc4c40f2 737I<If you're building a SNAPSHOT, you should STOP HERE>
738
739=item *
8c35d285 740
47b1f096 741Check that the C<perlbug> utility works. Try the following:
742
a14438df 743 $ bin/perlbug
47b1f096 744 ...
745 Subject: test bug report
746 Local perl administrator [yourself]:
747 Editor [vi]:
748 Module:
749 Category [core]:
750 Severity [low]:
751 (edit report)
752 Action (Send/Display/Edit/Subject/Save to File): f
753 Name of file to save message in [perlbug.rep]:
754 Action (Send/Display/Edit/Subject/Save to File): q
755
756and carefully examine the output (in F<perlbug.rep]>), especially
757the "Locally applied patches" section. If everything appears okay, then
75a012fe 758delete the file, and try it again, this time actually submitting the bug
759report. Check that it shows up, then remember to close it!
47b1f096 760
761=item *
762
f6af4394 763Wait for the smoke tests to catch up with the commit which this release is
764based on (or at least the last commit of any consequence).
7277a900 765
f6af4394 766Then check that the smoke tests pass (particularly on Win32). If not, go
767back and fix things.
7277a900 768
7277a900 769
f6af4394 770=item *
7277a900 771
f6af4394 772Once smoking is okay, upload it to PAUSE. This is the point of no return.
db3f805e 773If anything goes wrong after this point, you will need to re-prepare
774a new release with a new minor version or RC number.
775
a14438df 776 https://pause.perl.org/
777
778(Login, then select 'Upload a file to CPAN')
779
a42352ee 780Upload both the .gz and .bz2 versions of the tarball.
f6af4394 781
210de33e 782=item *
783
f662f3b7 784Now that you've shipped the new perl release to PAUSE, it's
785time to publish the tag you created earlier to the public git repo:
786
787 $ git push origin tag v5.11.0
f6af4394 788
789=item *
790
a42352ee 791Disarm the F<patchlevel.h> change; for example,
d7eb1120 792
793 static const char * const local_patches[] = {
794 NULL
795 - ,"RC1"
796 PERL_GIT_UNPUSHED_COMMITS /* do not remove this line */
797
798Be sure to commit your change:
799
800 $ git commit -m 'disarm RCnnn bump' patchlevel.h
a14438df 801 $ git push origin ....
d7eb1120 802
2e831dfd 803
804=item *
805
db3f805e 806Mail p5p to announce your new release, with a quote you prepared earlier.
f6af4394 807
808=item *
809
810Wait 24 hours or so, then post the announcement to use.perl.org.
addebd58 811(if you don't have access rights to post news, ask someone like Rafael to
812do it for you.)
f6af4394 813
f6af4394 814=item *
7277a900 815
746c0b35 816Ask Jarkko to add the tarball to http://www.cpan.org/src/
817
818=item *
819
bc4c40f2 820I<You MUST SKIP this step for RC, BLEAD>
7277a900 821
746c0b35 822Ask Jarkko to update the descriptions of which tarballs are current in
823http://www.cpan.org/src/README.html, and Rafael to update
824http://dev.perl.org/perl5/
7277a900 825
f6af4394 826=item *
7277a900 827
bc4c40f2 828I<You MUST SKIP this step for RC>
8c35d285 829
75a012fe 830Remind the current maintainer of C<Module::CoreList> to push a new release
831to CPAN.
7277a900 832
75a012fe 833=item *
a2cba4bc 834
bc4c40f2 835I<You MUST SKIP this step for RC>
7277a900 836
75a012fe 837Bump the perlXYZ version number.
7277a900 838
75a012fe 839First, create a new empty perlNNNdelta.pod file for the current release + 1;
840see F<Porting/how_to_write_a_perldelta.pod>.
7277a900 841
75a012fe 842You should be able to do this by just copying in a skeleton template and
843then doing a quick fix up of the version numbers, e.g.
7277a900 844
75a012fe 845 $ cp -i Porting/perldelta_template pod/perl5102delta.pod
846 $ (edit it)
847 $ git add pod/perl5102delta.pod
7277a900 848
75a012fe 849Edit F<pod.lst>: add the new entry, flagged as 'D', and unflag the previous
850entry from being 'D'; for example:
851
852 -D perl5101delta Perl changes in version 5.10.1
853 +D perl5102delta Perl changes in version 5.10.2
854 + perl5101delta Perl changes in version 5.10.1
7277a900 855
75a012fe 856Run C<perl pod/buildtoc --build-all> to update the F<perldelta> version in
857the following files:
57433fbf 858
859 MANIFEST
75a012fe 860 Makefile.SH
861 pod.lst
57433fbf 862 pod/perl.pod
57433fbf 863 vms/descrip_mms.template
75a012fe 864 win32/Makefile
865 win32/makefile.mk
866 win32/pod.mak
867
868Then manually edit (F<vms/descrip_mms.template> to bump the version
869in the following entry:
57433fbf 870
75a012fe 871 [.pod]perldelta.pod : [.pod]perl5101delta.pod
872
873XXX this previous step needs to fixed to automate it in pod/buildtoc.
874
875Manually update references to the perlNNNdelta version in these files:
876
877 INSTALL
878 README
879
880Edit the previous delta file to change the C<NAME> from C<perldelta>
881to C<perlNNNdelta>.
882
883These two lists of files probably aren't exhaustive; do a recursive grep
884on the previous filename to look for suitable candidates that may have
885been missed.
886
887Finally, commit:
888
889 $ git commit -a -m 'create perlXXXdelta'
890
891At this point you may want to compare the commit with a previous bump to
892see if they look similar. See commit ca8de22071 for an example of a
893previous version bump.
57433fbf 894
895=item *
896
bc4c40f2 897I<You MUST SKIP this step for RC, BLEAD>
dc0a62a1 898
8c35d285 899If this was a maint release, then edit F<Porting/mergelog> to change
900all the C<d> (deferred) flags to C<.> (needs review).
addebd58 901
addebd58 902=item *
903
bc4c40f2 904I<You MUST SKIP this step for RC, BLEAD>
addebd58 905
8c35d285 906If this was a major release (5.x.0), then create a new maint branch
907based on the commit tagged as the current release and bump the version
908in the blead branch in git, e.g. 5.12.0 to 5.13.0.
addebd58 909
910[ XXX probably lots more stuff to do, including perldelta,
f6af4394 911C<lib/feature.pm> ]
7277a900 912
8c35d285 913XXX need a git recipe
addebd58 914
915=item *
916
bc4c40f2 917I<You MUST SKIP this step for RC, BLEAD>
8c35d285 918
75a012fe 919Copy the perlNNNdelta.pod for this release into the other branches; for
920example:
7277a900 921
75a012fe 922 $ cp -i ../5.10.x/pod/perl5101delta.pod pod/ # for example
923 $ git add pod/perl5101delta.pod
924
925Edit F<pod.lst> to add an entry for the file, e.g.:
926
927 perl5101delta Perl changes in version 5.10.1
bc4c40f2 928
75a012fe 929Then rebuild various files:
7277a900 930
75a012fe 931 $ perl pod/buildtoc --build-all
932
933Finally, commit:
934
935 $ git commit -a -m 'add perlXXXdelta'
7277a900 936
f6af4394 937=item *
7277a900 938
f6af4394 939Make sure any recent F<pod/perlhist.pod> entries are copied to
940F<perlhist.pod> on other branches; typically the RC* and final entries,
941e.g.
7277a900 942
f6af4394 943 5.8.9-RC1 2008-Nov-10
944 5.8.9-RC2 2008-Dec-06
945 5.8.9 2008-Dec-14
7277a900 946
6e40fbf9 947=item *
948
bc4c40f2 949I<You MUST RETIRE to your preferred PUB, CAFE or SEASIDE VILLA for some
950much-needed rest and relaxation>.
8c35d285 951
952Thanks for releasing perl!
953
7277a900 954=back
955
956=head1 SOURCE
957
f6af4394 958Based on
959http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2009-05/msg00608.html,
960plus a whole bunch of other sources, including private correspondence.
7277a900 961
962=cut
963