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