This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Clarify the pod.lst instruction in rm guide
[perl5.git] / Porting / release_managers_guide.pod
CommitLineData
49781f4a
AB
1=encoding utf8
2
7277a900
GS
3=head1 NAME
4
5release_managers_guide - Releasing a new version of perl 5.x
6
dc0a4df9
DM
7Note that things change at each release, so there may be new things not
8covered here, or tools may need updating.
9
f6af4394 10
7277a900
GS
11=head1 SYNOPSIS
12
f6af4394 13This document describes the series of tasks required - some automatic, some
dc0a4df9
DM
14manual - to produce a perl release of some description, be that a release
15candidate, or final, numbered release of maint or blead.
f6af4394 16
8c35d285 17The release process has traditionally been executed by the current
ee76d676
JV
18pumpking. Blead releases from 5.11.0 forward are made each month on the
1920th by a non-pumpking release engineer. The release engineer roster
20and schedule can be found in Porting/release_schedule.pod.
7277a900 21
8c35d285
JV
22This document both helps as a check-list for the release engineer
23and is a base for ideas on how the various tasks could be automated
24or distributed.
7277a900 25
636a1918 26The outline of a typical release cycle is as follows:
f6af4394 27
636a1918 28 (5.10.1 is released, and post-release actions have been done)
f6af4394
DM
29
30 ...time passes...
31
f6af4394
DM
32 a few weeks before the release, a number of steps are performed,
33 including bumping the version to 5.10.2
636a1918
DM
34
35 ...a few weeks passes...
46743ef7 36
f6af4394
DM
37 perl-5.10.2-RC1 is released
38
39 perl-5.10.2 is released
40
41 post-release actions are performed, including creating new
c5b87fed 42 perldelta.pod
f6af4394
DM
43
44 ... the cycle continues ...
7277a900 45
dc0a4df9 46
7277a900
GS
47=head1 DETAILS
48
6a958a95
DM
49Some of the tasks described below apply to all four types of
50release of Perl. (blead, RC, final release of maint, final
8c35d285
JV
51release of blead). Some of these tasks apply only to a subset
52of these release types. If a step does not apply to a given
53type of release, you will see a notation to that effect at
54the beginning of the step.
55
dc0a4df9 56
8c35d285
JV
57=head2 Release types
58
59=over 4
60
8c35d285
JV
61=item Release Candidate (RC)
62
d60a1044
DM
63A release candidate is an attempt to produce a tarball that is a close as
64possible to the final release. Indeed, unless critical faults are found
65during the RC testing, the final release will be identical to the RC
66barring a few minor fixups (updating the release date in F<perlhist.pod>,
67removing the RC status from F<patchlevel.h>, etc). If faults are found,
68then the fixes should be put into a new release candidate, never directly
69into a final release.
8c35d285 70
6a958a95
DM
71
72=item Stable/Maint release (MAINT).
73
74A release with an even version number, and subversion number > 0, such as
755.14.1 or 5.14.2.
8c35d285
JV
76
77At this point you should have a working release candidate with few or no
78changes since.
79
80It's essentially the same procedure as for making a release candidate, but
81with a whole bunch of extra post-release steps.
82
6a958a95
DM
83=item A blead point release (BLEAD-POINT)
84
85A release with an odd version number, such as 5.15.0 or 5.15.1.
86
87This isn't for production, so it has less stability requirements than for
88other release types, and isn't preceded by RC releases. Other than that,
89it is similar to a MAINT release.
90
91=item Blead final release (BLEAD-FINAL)
92
93A release with an even version number, and subversion number == 0, such as
dc0a4df9 945.14.0. That is to say, it's the big new release once per year.
8c35d285
JV
95
96It's essentially the same procedure as for making a release candidate, but
6a958a95 97with a whole bunch of extra post-release steps, even more than for MAINT.
8c35d285
JV
98
99=back
7277a900 100
dc0a4df9 101
fd838dcf
JV
102=head2 Prerequisites
103
104Before you can make an official release of perl, there are a few
105hoops you need to jump through:
106
107=over 4
108
8c35d285
JV
109=item PAUSE account
110
fd838dcf
JV
111Make sure you have a PAUSE account suitable for uploading a perl release.
112If you don't have a PAUSE account, then request one:
113
114 https://pause.perl.org/pause/query?ACTION=request_id
115
9a3b7d40
FR
116Check that your account is allowed to upload perl distros: go to
117L<https://pause.perl.org/pause/authenquery?ACTION=who_pumpkin> and check that
118your PAUSE ID is listed there. If not, ask Andreas KE<0xf6>nig to add your ID
119to the list of people allowed to upload something called perl. You can find
120Andreas' email address at:
4d2c8158 121
fd838dcf
JV
122 https://pause.perl.org/pause/query?ACTION=pause_04imprint
123
fdabea7a
JV
124=item search.cpan.org
125
126Make sure that search.cpan.org knows that you're allowed to upload
127perl distros. Contact Graham Barr to make sure that you're on the right
128list.
129
8c35d285
JV
130=item CPAN mirror
131
132Some release engineering steps require a full mirror of the CPAN.
133Work to fall back to using a remote mirror via HTTP is incomplete
134but ongoing. (No, a minicpan mirror is not sufficient)
135
136=item git checkout and commit bit
fd838dcf
JV
137
138You will need a working C<git> installation, checkout of the perl
139git repository and perl commit bit. For information about working
c222ef46 140with perl and git, see F<pod/perlgit.pod>.
fd838dcf
JV
141
142If you are not yet a perl committer, you won't be able to make a
143release. Have a chat with whichever evil perl porter tried to talk
144you into the idea in the first place to figure out the best way to
145resolve the issue.
146
f6af4394 147
8c35d285 148=item Quotation for release announcement epigraph
f6af4394 149
b1288acc 150I<SKIP this step for RC>
f6af4394 151
6a958a95 152For all except an RC release of perl, you will need a quotation
b1288acc 153to use as an epigraph to your release announcement.
46743ef7 154
f6af4394
DM
155
156=back
157
b82efa27 158
2e831dfd 159=head2 Building a release - advance actions
8c35d285
JV
160
161The work of building a release candidate for a numbered release of
162perl generally starts several weeks before the first release candidate.
52a66c2c
DM
163Some of the following steps should be done regularly, but all I<must> be
164done in the run up to a release.
7277a900 165
7277a900 166
dc0a4df9 167=head3 dual-life CPAN module synchronisation
f6af4394 168
f6af4394
DM
169Ensure that dual-life CPAN modules are synchronised with CPAN. Basically,
170run the following:
171
db3f805e 172 $ ./perl -Ilib Porting/core-cpan-diff -a -o /tmp/corediffs
7277a900 173
f6af4394
DM
174to see any inconsistencies between the core and CPAN versions of distros,
175then fix the core, or cajole CPAN authors as appropriate. See also the
176C<-d> and C<-v> options for more detail. You'll probably want to use the
04dbb930
DG
177C<-c cachedir> option to avoid repeated CPAN downloads and may want to
178use C<-m file:///mirror/path> if you made a local CPAN mirror.
7277a900 179
f6af4394 180To see which core distro versions differ from the current CPAN versions:
7277a900 181
db3f805e 182 $ ./perl -Ilib Porting/core-cpan-diff -x -a
7277a900 183
6a958a95 184If you are making a MAINT release, run C<core-cpan-diff> on both blead and
636a1918
DM
185maint, then diff the two outputs. Compare this with what you expect, and if
186necessary, fix things up. For example, you might think that both blead
187and maint are synchronised with a particular CPAN module, but one might
188have some extra changes.
189
dc0a4df9
DM
190
191=head3 dual-life CPAN module stability
7277a900 192
f6af4394 193Ensure dual-life CPAN modules are stable, which comes down to:
7277a900
GS
194
195 for each module that fails its regression tests on $current
f6af4394
DM
196 did it fail identically on $previous?
197 if yes, "SEP" (Somebody Else's Problem)
198 else work out why it failed (a bisect is useful for this)
7277a900
GS
199
200 attempt to group failure causes
201
202 for each failure cause
f6af4394
DM
203 is that a regression?
204 if yes, figure out how to fix it
205 (more code? revert the code that broke it)
206 else
207 (presumably) it's relying on something un-or-under-documented
208 should the existing behaviour stay?
209 yes - goto "regression"
210 no - note it in perldelta as a significant bugfix
211 (also, try to inform the module's author)
1aff5354 212
dc0a4df9
DM
213
214=head3 smoking
7277a900 215
5157df7a
AB
216Similarly, monitor the smoking of core tests, and try to fix. See
217L<http://doc.procura.nl/smoke/index.html> for a summary. See also
218L<http://www.nntp.perl.org/group/perl.daily-build.reports/> which has
219the raw reports.
7277a900 220
636a1918
DM
221Similarly, monitor the smoking of perl for compiler warnings, and try to
222fix.
223
dc0a4df9
DM
224
225=head3 perldelta
636a1918 226
f6af4394 227Get perldelta in a mostly finished state.
db3f805e 228
04c2c53e 229Read F<Porting/how_to_write_a_perldelta.pod>, and try to make sure that
636a1918
DM
230every section it lists is, if necessary, populated and complete. Copy
231edit the whole document.
f6af4394 232
f6af4394 233
dc0a4df9
DM
234=head3 Bump the version number
235
236Increase the version number (e.g. from 5.12.0 to 5.12.1).
04dbb930 237
6a958a95 238For a BLEAD-POINT release, this can happen on the day of the release. For a
04dbb930
DG
239release candidate for a stable perl, this should happen a week or two
240before the first release candidate to allow sufficient time for testing and
241smoking with the target version built into the perl executable. For
242subsequent release candidates and the final release, it it not necessary to
243bump the version further.
f6af4394
DM
244
245There is a tool to semi-automate this process. It works in two stages.
246First, it generates a list of suggested changes, which you review and
247edit; then you feed this list back and it applies the edits. So, first
52a66c2c
DM
248scan the source directory looking for likely candidates. The command line
249arguments are the old and new version numbers, and -s means scan:
f6af4394 250
30cdbfa1 251 $ ./perl -Ilib Porting/bump-perl-version -s 5.10.0 5.10.1 > /tmp/scan
f6af4394 252
52a66c2c 253This produces a file containing a list of suggested edits, e.g.:
f6af4394
DM
254
255 NetWare/Makefile
256
257 89: -MODULE_DESC = "Perl 5.10.0 for NetWare"
258 +MODULE_DESC = "Perl 5.10.1 for NetWare"
259
260i.e. in the file F<NetWare/Makefile>, line 89 would be changed as shown.
261Review the file carefully, and delete any -/+ line pairs that you don't
52a66c2c
DM
262want changing. You can also edit just the C<+> line to change the
263suggested replacement text. Remember that this tool is largely just
264grepping for '5.10.0' or whatever, so it will generate false positives. Be
265careful not change text like "this was fixed in 5.10.0"! Then run:
f6af4394 266
30cdbfa1 267 $ ./perl -Ilib Porting/bump-perl-version -u < /tmp/scan
f6af4394 268
54356a6f 269which will update all the files shown.
f6af4394
DM
270
271Be particularly careful with F<INSTALL>, which contains a mixture of
272C<5.10.0>-type strings, some of which need bumping on every release, and
e03f126c
Z
273some of which need to be left unchanged.
274The line in F<INSTALL> about "is binary incompatible with" requires a
275correct choice of earlier version to declare incompatibility with.
276
277Also note that this tool
52a66c2c
DM
278currently only detects a single substitution per line: so in particular,
279this line in README.vms needs special handling:
f6af4394
DM
280
281 rename perl-5^.10^.1.dir perl-5_10_1.dir
7277a900 282
6a958a95
DM
283When doing a BLEAD-POINT or BLEAD-FINAL release, also make sure the
284C<PERL_API_*> constants in F<patchlevel.h> are in sync with the version
285you're releasing, unless you're
e43cb88f 286absolutely sure the release you're about to make is 100% binary compatible
6a958a95 287to an earlier release. When releasing a MAINT perl version, the C<PERL_API_*>
e43cb88f
TM
288constants C<MUST NOT> be changed as we aim to guarantee binary compatibility
289in maint branches.
45ce9531 290
17163f85
DM
291After editing, regenerate uconfig.h (this must be run on a system with a
292/bin/sh available):
22be9667 293
17163f85 294 $ perl regen/uconfig_h.pl
22be9667
JV
295
296Test your changes:
297
17163f85 298 $ git clean -xdf # careful if you don't have local files to keep!
22be9667
JV
299 $ ./Configure -des -Dusedevel
300 $ make
301 $ make test
302
54356a6f
JV
303Commit your changes:
304
305 $ git st
e91bd5c0
LB
306 $ git diff
307 B<review the delta carefully>
54356a6f
JV
308
309 $ git commit -a -m 'Bump the perl version in various places for 5.x.y'
dc0a62a1 310
21768cb3
FC
311At this point you may want to compare the commit with a previous bump to
312see if they look similar. See commit 8891dd8d for an example of a
313previous version bump.
314
dc0a4df9
DM
315When the version number is bumped, you should also update Module::CoreList
316(as described below in L<"update Module::CoreList">) to reflect the new
81fc59ef
DG
317version number.
318
dc0a4df9
DM
319
320=head3 update INSTALL
dc0a62a1
DM
321
322Review and update INSTALL to account for the change in version number;
323in particular, the "Coexistence with earlier versions of perl 5" section.
324
6a958a95
DM
325Be particularly careful with the section "Upgrading from 5.X.Y or earlier".
326The "X.Y" needs to be changed to the most recent version that we are
327I<not> binary compatible with.
328
329For MAINT and BLEAD-FINAL releases, this needs to refer to the last
330release in the previous development cycle (so for example, for a 5.14.x
331release, this would be 5.13.11).
332
333For BLEAD-POINT releases, it needs to refer to the previous BLEAD-POINT
334release (so for 5.15.3 this would be 5.15.2).
335
c1b1cb88 336
dc0a4df9 337=head3 update Changes
7277a900 338
b82efa27
RS
339Update the F<Changes> file to contain the git log command which would show
340all the changes in this release. You will need assume the existence of a
341not-yet created tag for the forthcoming release; e.g.
342
343 git log ... perl-5.10.0..perl-5.12.0
344
345Due to warts in the perforce-to-git migration, some branches require extra
346exclusions to avoid other branches being pulled in. Make sure you have the
347correct incantation: replace the not-yet-created tag with C<HEAD> and see
348if C<git log> produces roughly the right number of commits across roughly the
349right time period (you may find C<git log --pretty=oneline | wc> useful).
350
dc0a4df9
DM
351
352=head3 Check more build configurations
b82efa27 353
52a66c2c
DM
354Check some more build configurations. The check that setuid builds and
355installs is for < 5.11.0 only.
356
357 $ sh Configure -Dprefix=/tmp/perl-5.x.y -Uinstallusrbinperl \
358 -Duseshrplib -Dd_dosuid
359 $ make
360 $ LD_LIBRARY_PATH=`pwd` make test # or similar for useshrplib
7277a900 361
52a66c2c
DM
362 $ make suidperl
363 $ su -c 'make install'
364 $ ls -l .../bin/sperl
365 -rws--x--x 1 root root 69974 2009-08-22 21:55 .../bin/sperl
7277a900 366
52a66c2c 367(Then delete the installation directory.)
7277a900 368
52a66c2c 369XXX think of other configurations that need testing.
7277a900 370
dc0a4df9
DM
371
372=head3 update perlport
7277a900 373
347f5124
RGS
374L<perlport> has a section currently named I<Supported Platforms> that
375indicates which platforms are known to build in the current release.
376If necessary update the list and the indicated version number.
377
6a958a95
DM
378
379
2e831dfd
DM
380=head2 Building a release - on the day
381
b1288acc
DM
382This section describes the actions required to make a release
383that are performed on the actual day.
2e831dfd 384
2e831dfd 385
dc0a4df9 386=head3 re-check earlier actions
2e831dfd 387
dc0a4df9 388Review all the actions in the previous section,
2e831dfd
DM
389L<"Building a release - advance actions"> to ensure they are all done and
390up-to-date.
391
dc0a4df9
DM
392
393=head3 bump version number
8c35d285 394
6a958a95
DM
395For a BLEAD-POINT release, if you did not bump the perl version number as
396part of I<advance actions>, do that now.
04dbb930 397
dc0a4df9
DM
398
399=head3 finalize perldelta
04dbb930 400
04dbb930 401Finalize the perldelta. In particular, fill in the Acknowledgements
38195a8c
DG
402section. You can generate a list of contributors with checkAUTHORS.pl.
403For example:
404
c34fab5f 405 $ git log --pretty=fuller v5.13.${last}..HEAD | \
38195a8c 406 perl Porting/checkAUTHORS.pl --who -
04dbb930 407
ef86391b
AB
408Look at the previous L<perldelta> for how to write the opening
409paragraph of the Acknowledgements section. To get the amount of
410changed files and number of lines use this command:
411
c34fab5f 412 $ git diff --shortstat v5.13.${last}..HEAD | \
ef86391b
AB
413 ./perl -Ilib -nE 'my ($files, $insert, $delete) = /(\d+)/ga; say "$files files and ", $insert + $delete, " lines changed"'
414
415Making sure to round off the number of lines changed.
416
a0db33fe
DM
417Re-read the perldelta to try to find any embarrassing typos and thinkos;
418remove any C<TODO> or C<XXX> flags; update the "Known Problems" section
419with any serious issues for which fixes are not going to happen now; and
420run through pod and spell checkers, e.g.
2e831dfd 421
c5b87fed
FR
422 $ podchecker -warnings -warnings pod/perldelta.pod
423 $ spell pod/perldelta.pod
2e831dfd 424
a0db33fe
DM
425Also, you may want to generate and view an HTML version of it to check
426formatting, e.g.
2e831dfd 427
84c2dc44 428 $ ./perl -Ilib ext/Pod-Html/pod2html pod/perldelta.pod > /tmp/perldelta.html
2e831dfd 429
38195a8c
DG
430Another good HTML preview option is http://search.cpan.org/pod2html
431
432If you make changes, be sure to commit them.
433
dc0a4df9
DM
434
435=head3 build a clean perl
8c35d285 436
a0db33fe
DM
437Make sure you have a gitwise-clean perl directory (no modified files,
438unpushed commits etc):
8c35d285 439
a0db33fe 440 $ git status
24c5e187 441 $ git clean -dxf
8c35d285 442
dc0a4df9 443then configure and build perl so that you have a Makefile and porting tools:
8c35d285 444
52a66c2c 445 $ ./Configure -Dusedevel -des && make
8c35d285 446
dc0a4df9
DM
447
448=head3 update Module::CoreList
8c35d285 449
1bac61bb 450Update C<Module::CoreList> with module version data for the new release.
bfadf2ba 451
6a958a95 452Note that if this is a MAINT release, you should run the following actions
1bac61bb 453from the maint branch, but commit the C<CoreList.pm> changes in
a9d1f3db
LB
454I<blead> and subsequently cherry-pick any releases since the last
455maint release and then your recent commit. XXX need a better example
bfadf2ba 456
a0db33fe 457F<corelist.pl> uses ftp.funet.fi to verify information about dual-lived
bfadf2ba 458modules on CPAN. It can use a full, local CPAN mirror or fall back
e8c01f92
SH
459to C<wget> or C<curl> to fetch only package metadata remotely. (If you're
460on Win32, then installing Cygwin is one way to have commands like C<wget>
461and C<curl> available.)
bfadf2ba
JV
462
463(If you'd prefer to have a full CPAN mirror, see
464http://www.cpan.org/misc/cpan-faq.html#How_mirror_CPAN)
465
a0db33fe 466Then change to your perl checkout, and if necessary,
bfadf2ba 467
595f83ae 468 $ make
bfadf2ba 469
81fc59ef
DG
470If this not the first update for this version (e.g. if it was updated
471when the version number was originally bumped), first edit
d5bddf6e 472F<dist/Module-CoreList/lib/Module/CoreList.pm> to delete the existing
2ce7d676
RGS
473entries for this version from the C<%released> and C<%version> hashes:
474they will have a key like C<5.010001> for 5.10.1.
52a66c2c
DM
475
476XXX the edit-in-place functionality of Porting/corelist.pl should
477be fixed to handle this automatically.
478
bf8ea215 479Then, If you have a local CPAN mirror, run:
bfadf2ba 480
bfadf2ba
JV
481 $ ./perl -Ilib Porting/corelist.pl ~/my-cpan-mirror
482
483Otherwise, run:
484
bfadf2ba
JV
485 $ ./perl -Ilib Porting/corelist.pl cpan
486
52a66c2c 487This will chug for a while, possibly reporting various warnings about
2a720090 488badly-indexed CPAN modules unrelated to the modules actually in core.
2ce7d676 489Assuming all goes well, it will update
d5bddf6e 490F<dist/Module-CoreList/lib/Module/CoreList.pm>.
bfadf2ba
JV
491
492Check that file over carefully:
493
d5bddf6e 494 $ git diff dist/Module-CoreList/lib/Module/CoreList.pm
bfadf2ba 495
bfadf2ba
JV
496If necessary, bump C<$VERSION> (there's no need to do this for
497every RC; in RC1, bump the version to a new clean number that will
498appear in the final release, and leave as-is for the later RCs and final).
499
500Edit the version number in the new C<< 'Module::CoreList' => 'X.YZ' >>
501entry, as that is likely to reflect the previous version number.
502
cb9af4c0
AB
503Also edit Module::CoreList's new version number in its F<Changes>
504file.
e8c01f92 505
70855f8b
FC
506Add a perldelta entry for the new Module::CoreList version.
507
3dbfcde0
AB
508You should also add the version you're about to release to the
509L<Module::CoreList/CAVEATS> section which enumerates the perl releases
510that Module::CoreList covers.
511
a0db33fe 512In addition, if this is a final release (rather than a release candidate):
bfadf2ba
JV
513
514=over 4
515
516=item *
517
518Update this version's entry in the C<%released> hash with today's date.
519
520=item *
521
522Make sure that the script has correctly updated the C<CAVEATS> section
523
524=back
525
526Finally, commit the new version of Module::CoreList:
6a958a95 527(unless this is for MAINT; in which case commit it to blead first, then
a0db33fe 528cherry-pick it back).
bfadf2ba 529
770cf6ff 530 $ git commit -m 'Update Module::CoreList for 5.x.y' dist/Module-CoreList/lib/Module/CoreList.pm
bfadf2ba 531
dc0a4df9
DM
532
533=head3 check MANIFEST
bfadf2ba 534
a0db33fe 535Check that the manifest is sorted and correct:
8c35d285 536
a0db33fe 537 $ make distclean
300b5357 538 $ git clean -xdf # This shouldn't be necessary if distclean is correct
a0db33fe 539 $ perl Porting/manicheck
d5bddf6e 540
7081fd3a 541If manicheck turns up anything wrong, update MANIFEST and begin this step again.
a0db33fe 542
7081fd3a
JV
543 $ ./configure -des -Dusedevel
544 $ make test_porting
a0db33fe
DM
545 $ git commit -m 'Update MANIFEST' MANIFEST
546
dc0a4df9
DM
547
548=head3 update perlhist.pod
a0db33fe 549
e8a7a70e 550I<You MUST SKIP this step for a RC release>
a0db33fe 551
e8a7a70e
JV
552Add an entry to F<pod/perlhist.pod> with the release date, e.g.:
553
554 David 5.10.1 2009-Aug-06
a0db33fe
DM
555
556Make sure that the correct pumpking is listed in the left-hand column, and
557if this is the first release under the stewardship of a new pumpking, make
558sure that his or her name is listed in the section entitled
559C<THE KEEPERS OF THE PUMPKIN>.
560
561Be sure to commit your changes:
562
563 $ git commit -m 'add new release to perlhist' pod/perlhist.pod
8c35d285 564
dc0a4df9
DM
565
566=head3 update patchlevel.h
8c35d285 567
6a958a95 568I<You MUST SKIP this step for a BLEAD-POINT release>
d7eb1120 569
a42352ee
DM
570Update F<patchlevel.h> to add a C<-RC1>-or-whatever string; or, if this is
571a final release, remove it. For example:
d7eb1120
DM
572
573 static const char * const local_patches[] = {
574 NULL
575 + ,"RC1"
576 PERL_GIT_UNPUSHED_COMMITS /* do not remove this line */
577
578Be sure to commit your change:
579
580 $ git commit -m 'bump version to RCnnn' patchlevel.h
581
dc0a4df9
DM
582
583=head3 build, test and check a fresh perl
d7eb1120 584
a0db33fe
DM
585Build perl, then make sure it passes its own test suite, and installs:
586
587 $ git clean -xdf
a42352ee
DM
588 $ ./Configure -des -Dprefix=/tmp/perl-5.x.y-pretest
589
590 # or if it's an odd-numbered version:
a0db33fe 591 $ ./Configure -des -Dusedevel -Dprefix=/tmp/perl-5.x.y-pretest
a42352ee 592
a0db33fe
DM
593 $ make test install
594
52a66c2c
DM
595Check that the output of C</tmp/perl-5.x.y-pretest/bin/perl -v> and
596C</tmp/perl-5.x.y-pretest/bin/perl -V> are as expected,
a0db33fe 597especially as regards version numbers, patch and/or RC levels, and @INC
52a66c2c
DM
598paths. Note that as they have been been built from a git working
599directory, they will still identify themselves using git tags and
600commits.
601
602Then delete the temporary installation.
603
dc0a4df9
DM
604
605=head3 push the work so far
52a66c2c 606
a0db33fe
DM
607Push all your recent commits:
608
609 $ git push origin ....
610
96054f12 611
dc0a4df9 612=head3 tag the release
96054f12 613
e8c01f92 614Tag the release (e.g.):
96054f12 615
b6d23947 616 $ git tag v5.11.0 -m "First release of the v5.11 series!"
e8c01f92 617
6a958a95 618It is B<VERY> important that from this point forward, you not push
f662f3b7
JV
619your git changes to the Perl master repository. If anything goes
620wrong before you publish your newly-created tag, you can delete
621and recreate it. Once you push your tag, we're stuck with it
622and you'll need to use a new version number for your release.
623
dc0a4df9
DM
624
625=head3 build the tarball
a0db33fe 626
8c35d285
JV
627Create a tarball. Use the C<-s> option to specify a suitable suffix for
628the tarball and directory name:
629
630 $ cd root/of/perl/tree
631 $ make distclean
75a012fe
DM
632 $ git clean -xdf # make sure perl and git agree on files
633 $ git status # and there's nothing lying around
8c35d285 634
8c35d285
JV
635 $ perl Porting/makerel -b -s RC1 # for a release candidate
636 $ perl Porting/makerel -b # for a final release
637
638This creates the directory F<../perl-x.y.z-RC1> or similar, copies all
639the MANIFEST files into it, sets the correct permissions on them,
640adds DOS line endings to some, then tars it up as
641F<../perl-x.y.z-RC1.tar.gz>. With C<-b>, it also creates a C<tar.bz2> file.
642
6480287f
MT
643If you're getting your tarball suffixed with -uncommitted and you're sure
644your changes were all committed, you can override the suffix with:
645
646 $ perl Porting/makerel -b -s ''
96054f12 647
8c35d285
JV
648XXX if we go for extra tags and branches stuff, then add the extra details
649here
650
c8c95eea
NC
651Optionally, you might want to compress your tarball more. Unix F<gzip>
652doesn't actually produce the smallest possible DEFLATE output. If you have the
653AdvanceCOMP suite (e.g. the C<advancecomp> port on macports), you can run
654
655 $ advdef -z -4 ../perl-x.y.z-RC1.tar.gz
656
657which will probably shrink your tarball by about 5%. Over the lifetime of
658your distribution this will save a lot of people a small amount of download
659time and disk space, which adds up.
660
661(7-Zip on Windows is the same code as AdvanceCOMP, so Windows users get the
662smallest files first time)
663
8c35d285 664
dc0a4df9 665Finally, clean up the temporary directory, e.g.
a42352ee
DM
666
667 $ rm -rf ../perl-x.y.z-RC1
668
dc0a4df9
DM
669
670=head3 test the tarball
671
672=over 4
673
a42352ee
DM
674=item *
675
8c35d285
JV
676Copy the tarballs (.gz and possibly .bz2) to a web server somewhere you
677have access to.
678
679=item *
680
681Download the tarball to some other machine. For a release candidate,
682you really want to test your tarball on two or more different platforms
683and architectures. The #p5p IRC channel on irc.perl.org is a good place
684to find willing victims.
685
686=item *
687
688Check that basic configuration and tests work on each test machine:
689
690 $ ./Configure -des && make all test
f6af4394
DM
691
692=item *
693
8c35d285
JV
694Check that the test harness and install work on each test machine:
695
a42352ee 696 $ make distclean
8c35d285 697 $ ./Configure -des -Dprefix=/install/path && make all test_harness install
a42352ee 698 $ cd /install/path
8c35d285
JV
699
700=item *
701
702Check that the output of C<perl -v> and C<perl -V> are as expected,
703especially as regards version numbers, patch and/or RC levels, and @INC
704paths.
705
706Note that the results may be different without a F<.git/> directory,
707which is why you should test from the tarball.
708
709=item *
710
459fc3ca
DM
711Run the Installation Verification Procedure utility:
712
9651cacc 713 $ ./perl utils/perlivp
459fc3ca
DM
714 ...
715 All tests successful.
716 $
717
718=item *
719
d60a1044
DM
720Compare the pathnames of all installed files with those of the previous
721release (i.e. against the last installed tarball on this branch which you
722have previously verified using this same procedure). In particular, look
723for files in the wrong place, or files no longer included which should be.
724For example, suppose the about-to-be-released version is 5.10.1 and the
725previous is 5.10.0:
726
727 cd installdir-5.10.0/
728 find . -type f | perl -pe's/5\.10\.0/5.10.1/g' | sort > /tmp/f1
729 cd installdir-5.10.1/
730 find . -type f | sort > /tmp/f2
731 diff -u /tmp/f[12]
732
733=item *
734
8c35d285
JV
735Bootstrap the CPAN client on the clean install:
736
16c60e4e 737 $ bin/perl -MCPAN -e "shell"
8c35d285 738
16c60e4e
AB
739If you're running this on Win32 you probably also need a set of Unix
740command-line tools available for CPAN to function correctly without
e8c01f92
SH
741Perl alternatives like LWP installed. Cygwin is an obvious choice.)
742
8c35d285
JV
743=item *
744
a42352ee
DM
745Try installing a popular CPAN module that's reasonably complex and that
746has dependencies; for example:
8c35d285 747
a42352ee
DM
748 CPAN> install Inline
749 CPAN> quit
8c35d285
JV
750
751Check that your perl can run this:
752
16c60e4e 753 $ bin/perl -lwe "use Inline C => q[int f() { return 42;}]; print f"
a42352ee
DM
754 42
755 $
8c35d285
JV
756
757=item *
758
759Bootstrap the CPANPLUS client on the clean install:
760
75a012fe 761 $ bin/cpanp
8c35d285 762
e8c01f92
SH
763(Again, on Win32 you'll need something like Cygwin installed, but make sure
764that you don't end up with its various F<bin/cpan*> programs being found on
765the PATH before those of the Perl that you're trying to test.)
766
8c35d285
JV
767=item *
768
a42352ee 769Install an XS module, for example:
8c35d285 770
a42352ee
DM
771 CPAN Terminal> i DBI
772 CPAN Terminal> quit
773 $ bin/perl -MDBI -e 1
75a012fe 774 $
8c35d285
JV
775
776=item *
777
7f89f796 778Check that the L<perlbug> utility works. Try the following:
47b1f096 779
a14438df 780 $ bin/perlbug
47b1f096
DM
781 ...
782 Subject: test bug report
783 Local perl administrator [yourself]:
784 Editor [vi]:
785 Module:
786 Category [core]:
787 Severity [low]:
788 (edit report)
789 Action (Send/Display/Edit/Subject/Save to File): f
790 Name of file to save message in [perlbug.rep]:
791 Action (Send/Display/Edit/Subject/Save to File): q
792
793and carefully examine the output (in F<perlbug.rep]>), especially
794the "Locally applied patches" section. If everything appears okay, then
75a012fe
DM
795delete the file, and try it again, this time actually submitting the bug
796report. Check that it shows up, then remember to close it!
47b1f096 797
dc0a4df9
DM
798=back
799
800
801=head3 monitor smokes
47b1f096 802
f6af4394
DM
803Wait for the smoke tests to catch up with the commit which this release is
804based on (or at least the last commit of any consequence).
7277a900 805
f6af4394
DM
806Then check that the smoke tests pass (particularly on Win32). If not, go
807back and fix things.
7277a900 808
6a958a95 809Note that for I<BLEAD-POINT> releases this may not be practical. It takes a
1eefd7d5 810long time for the smokers to catch up, especially the Win32
6a958a95
DM
811smokers. This is why we have a RC cycle for I<MAINT> and I<BLEAD-FINAL>
812releases, but for I<BLEAD-POINT> releases sometimes the best you can do is
813to plead with people on IRC to test stuff on their platforms, fire away,
814and then hope for the best.
7277a900 815
dc0a4df9
DM
816
817=head3 upload to PAUSE
7277a900 818
f6af4394 819Once smoking is okay, upload it to PAUSE. This is the point of no return.
db3f805e
JV
820If anything goes wrong after this point, you will need to re-prepare
821a new release with a new minor version or RC number.
822
a14438df
DM
823 https://pause.perl.org/
824
825(Login, then select 'Upload a file to CPAN')
826
45924287
RS
827If your workstation is not connected to a high-bandwidth,
828high-reliability connection to the Internet, you should probably use the
829"GET URL" feature (rather than "HTTP UPLOAD") to have PAUSE retrieve the
830new release from wherever you put it for testers to find it. This will
831eliminate anxious gnashing of teeth while you wait to see if your
83215 megabyte HTTP upload successfully completes across your slow, twitchy
c27b4e97
SH
833cable modem. You can make use of your home directory on dromedary for
834this purpose: F<http://users.perl5.git.perl.org/~USERNAME> maps to
835F</home/USERNAME/public_html>, where F<USERNAME> is your login account
836on dromedary. I<Remember>: if your upload is partially successful, you
837may need to contact a PAUSE administrator or even bump the version of perl.
45924287 838
a42352ee 839Upload both the .gz and .bz2 versions of the tarball.
f6af4394 840
c27b4e97 841Wait until you receive notification emails from the PAUSE indexer
38195a8c 842confirming that your uploads have been received. IMPORTANT -- you will
b28f69c2
Z
843probably get an email that indexing has failed, due to module permissions.
844This is considered normal.
38195a8c
DG
845
846Do not proceed any further until you are sure that your tarballs are on
847CPAN. Check your authors directory on one of the "fast" CPAN mirrors
b28f69c2 848(e.g., cpan.hexten.net
38195a8c 849or cpan.cpantesters.org) to confirm that your uploads have been successful.
c27b4e97 850
dc0a4df9
DM
851
852=head3 publish tag
210de33e 853
f662f3b7 854Now that you've shipped the new perl release to PAUSE, it's
e8c01f92 855time to publish the tag you created earlier to the public git repo (e.g.):
f662f3b7
JV
856
857 $ git push origin tag v5.11.0
f6af4394 858
dc0a4df9
DM
859
860=head3 disarm patchlevel.h
f6af4394 861
6a958a95 862I<You MUST SKIP this step for BLEAD-POINT release>
113f3f4c 863
a42352ee 864Disarm the F<patchlevel.h> change; for example,
d7eb1120
DM
865
866 static const char * const local_patches[] = {
867 NULL
868 - ,"RC1"
869 PERL_GIT_UNPUSHED_COMMITS /* do not remove this line */
870
871Be sure to commit your change:
872
873 $ git commit -m 'disarm RCnnn bump' patchlevel.h
a14438df 874 $ git push origin ....
d7eb1120 875
2e831dfd 876
dc0a4df9
DM
877
878=head3 announce to p5p
2e831dfd 879
db3f805e 880Mail p5p to announce your new release, with a quote you prepared earlier.
f6af4394 881
dc0a4df9
DM
882
883=head3 update epigraphs.pod
f6af4394 884
85531b0a
DG
885Add your quote to F<Porting/epigraphs.pod> and commit it.
886
dc0a4df9
DM
887
888=head3 Module::CoreList nagging
85531b0a 889
bc4c40f2 890I<You MUST SKIP this step for RC>
8c35d285 891
75a012fe
DM
892Remind the current maintainer of C<Module::CoreList> to push a new release
893to CPAN.
7277a900 894
dc0a4df9
DM
895
896=head3 new perldelta
a2cba4bc 897
bc4c40f2 898I<You MUST SKIP this step for RC>
7277a900 899
c5b87fed 900Create a new perldelta.
7277a900 901
17163f85
DM
902B<Note>: currently, the buildtoc below must be run in a I<built> perl source
903directory, as at least one of the pod files it expects to find is
904autogenerated: perluniprops.pod. But you can't build perl if you've added
905the new perldelta file and not updated toc. So, make sure you have a built
dc0a4df9 906perl (with a pod/perluniprops.pod file) now, I<before> continuing.
17163f85
DM
907
908First, update the F<pod/.gitignore> file to ignore the next
909release's generated F<pod/perlNNNdelta.pod> file rather than this release's
5ef3945b
SH
910one which we are about to set in stone (where NNN is the perl version number
911without the dots. i.e. 5135 for 5.13.5).
912
17163f85
DM
913 $ (edit pod/.gitignore )
914 $ git add pod/.gitignore
8e967a1c 915
17163f85
DM
916Then, move the existing F<pod/perldelta.pod> to F<pod/perlNNNdelta.pod>,
917and edit the moved delta file to change the C<NAME> from C<perldelta> to
918C<perlNNNdelta>. For example, assuming you just released 5.10.1, and are
919about to create the 5.10.2 perldelta:
8e967a1c 920
17163f85 921 $ rm pod/perl5101delta.pod # remove the auto-generated file, if any
c5b87fed
FR
922 $ git mv pod/perldelta.pod pod/perl5101delta.pod
923 $ (edit pod/perl5101delta.pod to retitle)
8e967a1c 924 $ git add pod/perl5101delta.pod
c5b87fed 925
17163f85
DM
926Then create a new empty perldelta.pod file for the new release; see
927F<Porting/how_to_write_a_perldelta.pod>. You should be able to do this by
928just copying in a skeleton template and then doing a quick fix up of the
929version numbers. Then commit the move and the new file.
930
c5b87fed
FR
931 $ cp -i Porting/perldelta_template.pod pod/perldelta.pod
932 $ (edit pod/perldelta.pod)
933 $ git add pod/perldelta.pod
934 $ git commit -m 'create perldelta for 5.10.2'
8e967a1c 935
dc0a4df9 936=head3 update perldelta TOC and references
17163f85
DM
937
938Now you need to update various tables of contents related to perldelta,
939most of which can be generated automatically.
7277a900 940
aa80f64f
FC
941Edit F<pod.lst>: add the entry for the new perlNNNdelta file (for the
942previous version).
7277a900 943
17163f85
DM
944Manually create a temporary link to the new delta file; normally this is
945done from the Makefile, but the Makefile is updated by buildtoc, and
946buildtoc won't run without the file there:
947
948 $ ln -s perldelta.pod pod/perl5102delta.pod
949
75a012fe
DM
950Run C<perl pod/buildtoc --build-all> to update the F<perldelta> version in
951the following files:
57433fbf
JV
952
953 MANIFEST
75a012fe 954 Makefile.SH
57433fbf 955 pod/perl.pod
57433fbf 956 vms/descrip_mms.template
75a012fe
DM
957 win32/Makefile
958 win32/makefile.mk
959 win32/pod.mak
960
75a012fe
DM
961Finally, commit:
962
c5b87fed 963 $ git commit -a -m 'update TOC for perlNNNdelta'
75a012fe 964
21768cb3
FC
965At this point you may want to compare the commit with a previous bump to
966see if they look similar. See commit dd885b5 for an example of a
75a012fe 967previous version bump.
57433fbf 968
dc0a4df9
DM
969
970=head3 bump version
57433fbf 971
6a958a95 972I<You MUST SKIP this step for RC, BLEAD-POINT, MAINT>
dc0a62a1 973
6a958a95
DM
974If this was a BLEAD-FINAL release (i.e. the first release of a new maint
975series, 5.x.0 where x is even), then bump the version in the blead branch
976in git, e.g. 5.12.0 to 5.13.0.
17163f85
DM
977
978First, add a new feature bundle to F<lib/feature.pm>, initially by just
979copying the exiting entry, and bump the file's $VERSION; e.g.
980
981 "5.14" => [qw(switch say state unicode_strings)],
982 + "5.15" => [qw(switch say state unicode_strings)],
addebd58 983
dc0a4df9
DM
984Then follow the section L<"Bump the version number"> to bump the version
985in the remaining files and test and commit.
17163f85 986
17163f85 987
dc0a4df9
DM
988=head3 push commits
989
990Finally, push any commits done above.
991
992 $ git push origin ....
993
994
995=head3 create maint branch
17163f85 996
6a958a95 997I<You MUST SKIP this step for RC, BLEAD-POINT, MAINT>
17163f85 998
6a958a95
DM
999If this was a BLEAD-FINAL release (i.e. the first release of a new maint
1000series, 5.x.0 where x is even), then create a new maint branch based on
1001the commit tagged as the current release.
7277a900 1002
233ca920
JV
1003Assuming you're using git 1.7.x or newer:
1004
17163f85 1005 $ git checkout -b maint-5.12 v5.12.0
233ca920 1006 $ git push origin -u maint-5.12
addebd58 1007
dc0a4df9 1008
d5722260
DK
1009=head3 make the maint branch available in the APC
1010
1011Clone the new branch into /srv/gitcommon/branches on camel so the APC will
1012receive its changes.
1013
07697565 1014 $ git clone --branch maint-5.14 /gitroot/perl.git \
d5722260 1015 ? /srv/gitcommon/branches/perl-5.14.x
07697565 1016 $ chmod -R g=u /srv/gitcommon/branches/perl-5.14.x
d5722260
DK
1017
1018And nag the sysadmins to make this directory available via rsync.
1019
1020
dc0a4df9 1021=head3 copy perldelta.pod to other branches
addebd58 1022
6a958a95 1023I<You MUST SKIP this step for RC, BLEAD-POINT>
8c35d285 1024
c5b87fed 1025Copy the perldelta.pod for this release into the other branches; for
75a012fe 1026example:
7277a900 1027
c5b87fed 1028 $ cp -i ../5.10.x/pod/perldelta.pod pod/perl5101delta.pod # for example
75a012fe
DM
1029 $ git add pod/perl5101delta.pod
1030
1031Edit F<pod.lst> to add an entry for the file, e.g.:
1032
1033 perl5101delta Perl changes in version 5.10.1
bc4c40f2 1034
75a012fe 1035Then rebuild various files:
7277a900 1036
75a012fe
DM
1037 $ perl pod/buildtoc --build-all
1038
1039Finally, commit:
1040
1041 $ git commit -a -m 'add perlXXXdelta'
7277a900 1042
dc0a4df9
DM
1043
1044=head3 update perlhist.pod in other branches
7277a900 1045
f6af4394 1046Make sure any recent F<pod/perlhist.pod> entries are copied to
e8a7a70e 1047F<perlhist.pod> on other branches
f6af4394 1048e.g.
7277a900 1049
f6af4394 1050 5.8.9 2008-Dec-14
7277a900 1051
dc0a4df9
DM
1052
1053=head3 bump RT version number
6e40fbf9 1054
a3738a12
DM
1055If necessary, send an email to C<perlbug-admin at perl.org> requesting
1056that new version numbers be added to the RT fields C<Perl Version> and
1057C<Fixed In>.
1058
dc0a4df9
DM
1059
1060=head3 Relax!
a3738a12 1061
bc4c40f2
JV
1062I<You MUST RETIRE to your preferred PUB, CAFE or SEASIDE VILLA for some
1063much-needed rest and relaxation>.
8c35d285
JV
1064
1065Thanks for releasing perl!
1066
7277a900 1067
b28f69c2
Z
1068=head2 Building a release - the day after
1069
dc0a4df9
DM
1070=head3 check tarball availability
1071
1072Check various website entries to make sure the that tarball has appeared
1073and is properly indexed:
1074
b28f69c2
Z
1075=over 4
1076
1077=item *
1078
98df743a
Z
1079Check your author directory under L<http://www.cpan.org/authors/id/>
1080to ensure that the tarballs are available on the website.
b28f69c2
Z
1081
1082=item *
1083
98df743a
Z
1084Check C</src> on CPAN (on a fast mirror) to ensure that links to
1085the new tarballs have appeared. There should be links in C</src/5.0>
1086(which is accumulating all new versions), links in C</src> (which shows
1087only the latest version on each branch), and an appropriate mention in
1088C</src/README.html> (which describes the latest versions).
1089
1090These links should appear automatically, some hours after upload.
1091If they don't, or the C<README.html> description is inadequate,
1092ask Ask <ask@perl.org>.
b28f69c2
Z
1093
1094=item *
1095
98df743a
Z
1096Check L<http://www.cpan.org/src/> to ensure that the C</src> updates
1097have been correctly mirrored to the website.
1098If they haven't, ask Ask <ask@perl.org>.
1099
1100=item *
b28f69c2 1101
98df743a
Z
1102Check L<http://search.cpan.org> to see if it has indexed the distribution.
1103It should be visible at a URL like C<http://search.cpan.org/dist/perl-5.10.1/>.
b28f69c2 1104
dc0a4df9 1105=back
b28f69c2 1106
dc0a4df9
DM
1107
1108=head3 update dev.perl.org
1109
1110I<This step ONLY for BLEAD-POINT and MAINT>
98df743a 1111
e294df83 1112Ask Leo Lapworth to update L<http://dev.perl.org/perl5/>.
b28f69c2 1113
b28f69c2 1114
7277a900
GS
1115=head1 SOURCE
1116
f6af4394
DM
1117Based on
1118http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2009-05/msg00608.html,
1119plus a whole bunch of other sources, including private correspondence.
7277a900
GS
1120
1121=cut
1122