This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
release managers guide: perldelta broken link handling
[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 244
8b2227e6 245There is a tool to semi-automate this process:
f6af4394 246
8b2227e6 247 $ ./perl -Ilib Porting/bump-perl-version -i 5.10.0 5.10.1
f6af4394 248
8b2227e6
LB
249Remember that this tool is largely just grepping for '5.10.0' or whatever,
250so it will generate false positives. Be careful not change text like
251"this was fixed in 5.10.0"!
ceb7f800 252
8b2227e6 253Use git status and git diff to select changes you want to keep.
ceb7f800 254
f6af4394
DM
255Be particularly careful with F<INSTALL>, which contains a mixture of
256C<5.10.0>-type strings, some of which need bumping on every release, and
e03f126c
Z
257some of which need to be left unchanged.
258The line in F<INSTALL> about "is binary incompatible with" requires a
259correct choice of earlier version to declare incompatibility with.
260
6a958a95
DM
261When doing a BLEAD-POINT or BLEAD-FINAL release, also make sure the
262C<PERL_API_*> constants in F<patchlevel.h> are in sync with the version
263you're releasing, unless you're
e43cb88f 264absolutely sure the release you're about to make is 100% binary compatible
6a958a95 265to an earlier release. When releasing a MAINT perl version, the C<PERL_API_*>
e43cb88f
TM
266constants C<MUST NOT> be changed as we aim to guarantee binary compatibility
267in maint branches.
45ce9531 268
17163f85
DM
269After editing, regenerate uconfig.h (this must be run on a system with a
270/bin/sh available):
22be9667 271
17163f85 272 $ perl regen/uconfig_h.pl
22be9667
JV
273
274Test your changes:
275
17163f85 276 $ git clean -xdf # careful if you don't have local files to keep!
22be9667
JV
277 $ ./Configure -des -Dusedevel
278 $ make
279 $ make test
280
54356a6f
JV
281Commit your changes:
282
04abd20e 283 $ git status
e91bd5c0
LB
284 $ git diff
285 B<review the delta carefully>
54356a6f
JV
286
287 $ git commit -a -m 'Bump the perl version in various places for 5.x.y'
dc0a62a1 288
21768cb3
FC
289At this point you may want to compare the commit with a previous bump to
290see if they look similar. See commit 8891dd8d for an example of a
291previous version bump.
292
dc0a4df9
DM
293When the version number is bumped, you should also update Module::CoreList
294(as described below in L<"update Module::CoreList">) to reflect the new
81fc59ef
DG
295version number.
296
dc0a4df9
DM
297
298=head3 update INSTALL
dc0a62a1
DM
299
300Review and update INSTALL to account for the change in version number;
301in particular, the "Coexistence with earlier versions of perl 5" section.
302
6a958a95
DM
303Be particularly careful with the section "Upgrading from 5.X.Y or earlier".
304The "X.Y" needs to be changed to the most recent version that we are
305I<not> binary compatible with.
306
307For MAINT and BLEAD-FINAL releases, this needs to refer to the last
308release in the previous development cycle (so for example, for a 5.14.x
309release, this would be 5.13.11).
310
311For BLEAD-POINT releases, it needs to refer to the previous BLEAD-POINT
312release (so for 5.15.3 this would be 5.15.2).
313
dc0a4df9 314=head3 Check more build configurations
b82efa27 315
52a66c2c
DM
316Check some more build configurations. The check that setuid builds and
317installs is for < 5.11.0 only.
318
319 $ sh Configure -Dprefix=/tmp/perl-5.x.y -Uinstallusrbinperl \
320 -Duseshrplib -Dd_dosuid
321 $ make
322 $ LD_LIBRARY_PATH=`pwd` make test # or similar for useshrplib
7277a900 323
52a66c2c
DM
324 $ make suidperl
325 $ su -c 'make install'
326 $ ls -l .../bin/sperl
327 -rws--x--x 1 root root 69974 2009-08-22 21:55 .../bin/sperl
7277a900 328
52a66c2c 329(Then delete the installation directory.)
7277a900 330
52a66c2c 331XXX think of other configurations that need testing.
7277a900 332
dc0a4df9
DM
333
334=head3 update perlport
7277a900 335
347f5124
RGS
336L<perlport> has a section currently named I<Supported Platforms> that
337indicates which platforms are known to build in the current release.
338If necessary update the list and the indicated version number.
339
6a958a95
DM
340
341
2e831dfd
DM
342=head2 Building a release - on the day
343
b1288acc
DM
344This section describes the actions required to make a release
345that are performed on the actual day.
2e831dfd 346
2e831dfd 347
dc0a4df9 348=head3 re-check earlier actions
2e831dfd 349
dc0a4df9 350Review all the actions in the previous section,
2e831dfd
DM
351L<"Building a release - advance actions"> to ensure they are all done and
352up-to-date.
353
dc0a4df9
DM
354
355=head3 bump version number
8c35d285 356
6a958a95
DM
357For a BLEAD-POINT release, if you did not bump the perl version number as
358part of I<advance actions>, do that now.
04dbb930 359
dc0a4df9
DM
360
361=head3 finalize perldelta
04dbb930 362
04dbb930 363Finalize the perldelta. In particular, fill in the Acknowledgements
548e9a3a 364section, which can be generated with something like:
38195a8c 365
548e9a3a 366 $ perl Porting/acknowledgements.pl v5.15.0..HEAD
ef86391b 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
c5b87fed
FR
373 $ podchecker -warnings -warnings pod/perldelta.pod
374 $ spell pod/perldelta.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
84c2dc44 379 $ ./perl -Ilib ext/Pod-Html/pod2html pod/perldelta.pod > /tmp/perldelta.html
2e831dfd 380
38195a8c
DG
381Another good HTML preview option is http://search.cpan.org/pod2html
382
383If you make changes, be sure to commit them.
384
dc0a4df9
DM
385
386=head3 build a clean perl
8c35d285 387
a0db33fe
DM
388Make sure you have a gitwise-clean perl directory (no modified files,
389unpushed commits etc):
8c35d285 390
a0db33fe 391 $ git status
24c5e187 392 $ git clean -dxf
8c35d285 393
dc0a4df9 394then configure and build perl so that you have a Makefile and porting tools:
8c35d285 395
52a66c2c 396 $ ./Configure -Dusedevel -des && make
8c35d285 397
dc0a4df9
DM
398
399=head3 update Module::CoreList
8c35d285 400
1bac61bb 401Update C<Module::CoreList> with module version data for the new release.
bfadf2ba 402
6a958a95 403Note that if this is a MAINT release, you should run the following actions
1bac61bb 404from the maint branch, but commit the C<CoreList.pm> changes in
a9d1f3db
LB
405I<blead> and subsequently cherry-pick any releases since the last
406maint release and then your recent commit. XXX need a better example
bfadf2ba 407
a0db33fe 408F<corelist.pl> uses ftp.funet.fi to verify information about dual-lived
bfadf2ba 409modules on CPAN. It can use a full, local CPAN mirror or fall back
e8c01f92
SH
410to C<wget> or C<curl> to fetch only package metadata remotely. (If you're
411on Win32, then installing Cygwin is one way to have commands like C<wget>
412and C<curl> available.)
bfadf2ba
JV
413
414(If you'd prefer to have a full CPAN mirror, see
415http://www.cpan.org/misc/cpan-faq.html#How_mirror_CPAN)
416
a0db33fe 417Then change to your perl checkout, and if necessary,
bfadf2ba 418
595f83ae 419 $ make
bfadf2ba 420
81fc59ef
DG
421If this not the first update for this version (e.g. if it was updated
422when the version number was originally bumped), first edit
d5bddf6e 423F<dist/Module-CoreList/lib/Module/CoreList.pm> to delete the existing
2ce7d676
RGS
424entries for this version from the C<%released> and C<%version> hashes:
425they will have a key like C<5.010001> for 5.10.1.
52a66c2c
DM
426
427XXX the edit-in-place functionality of Porting/corelist.pl should
428be fixed to handle this automatically.
429
bf8ea215 430Then, If you have a local CPAN mirror, run:
bfadf2ba 431
bfadf2ba
JV
432 $ ./perl -Ilib Porting/corelist.pl ~/my-cpan-mirror
433
434Otherwise, run:
435
bfadf2ba
JV
436 $ ./perl -Ilib Porting/corelist.pl cpan
437
52a66c2c 438This will chug for a while, possibly reporting various warnings about
2a720090 439badly-indexed CPAN modules unrelated to the modules actually in core.
2ce7d676 440Assuming all goes well, it will update
d5bddf6e 441F<dist/Module-CoreList/lib/Module/CoreList.pm>.
bfadf2ba
JV
442
443Check that file over carefully:
444
d5bddf6e 445 $ git diff dist/Module-CoreList/lib/Module/CoreList.pm
bfadf2ba 446
bfadf2ba
JV
447If necessary, bump C<$VERSION> (there's no need to do this for
448every RC; in RC1, bump the version to a new clean number that will
449appear in the final release, and leave as-is for the later RCs and final).
9709cbd8
FC
450It may also happen that C<Module::CoreList> has been modified in blead, and
451hence has a new version number already. (But make sure it is not the same
452number as a CPAN release.)
bfadf2ba
JV
453
454Edit the version number in the new C<< 'Module::CoreList' => 'X.YZ' >>
455entry, as that is likely to reflect the previous version number.
456
cb9af4c0
AB
457Also edit Module::CoreList's new version number in its F<Changes>
458file.
e8c01f92 459
70855f8b
FC
460Add a perldelta entry for the new Module::CoreList version.
461
a0db33fe 462In addition, if this is a final release (rather than a release candidate):
bfadf2ba
JV
463
464=over 4
465
466=item *
467
468Update this version's entry in the C<%released> hash with today's date.
469
470=item *
471
472Make sure that the script has correctly updated the C<CAVEATS> section
473
474=back
475
476Finally, commit the new version of Module::CoreList:
6a958a95 477(unless this is for MAINT; in which case commit it to blead first, then
a0db33fe 478cherry-pick it back).
bfadf2ba 479
770cf6ff 480 $ git commit -m 'Update Module::CoreList for 5.x.y' dist/Module-CoreList/lib/Module/CoreList.pm
bfadf2ba 481
dc0a4df9
DM
482
483=head3 check MANIFEST
bfadf2ba 484
a0db33fe 485Check that the manifest is sorted and correct:
8c35d285 486
a0db33fe 487 $ make distclean
300b5357 488 $ git clean -xdf # This shouldn't be necessary if distclean is correct
a0db33fe 489 $ perl Porting/manicheck
d5bddf6e 490
7081fd3a 491If manicheck turns up anything wrong, update MANIFEST and begin this step again.
a0db33fe 492
7081fd3a
JV
493 $ ./configure -des -Dusedevel
494 $ make test_porting
a0db33fe
DM
495 $ git commit -m 'Update MANIFEST' MANIFEST
496
dc0a4df9
DM
497
498=head3 update perlhist.pod
a0db33fe 499
e8a7a70e 500I<You MUST SKIP this step for a RC release>
a0db33fe 501
e8a7a70e
JV
502Add an entry to F<pod/perlhist.pod> with the release date, e.g.:
503
504 David 5.10.1 2009-Aug-06
a0db33fe
DM
505
506Make sure that the correct pumpking is listed in the left-hand column, and
507if this is the first release under the stewardship of a new pumpking, make
508sure that his or her name is listed in the section entitled
509C<THE KEEPERS OF THE PUMPKIN>.
510
511Be sure to commit your changes:
512
513 $ git commit -m 'add new release to perlhist' pod/perlhist.pod
8c35d285 514
dc0a4df9
DM
515
516=head3 update patchlevel.h
8c35d285 517
6a958a95 518I<You MUST SKIP this step for a BLEAD-POINT release>
d7eb1120 519
a42352ee
DM
520Update F<patchlevel.h> to add a C<-RC1>-or-whatever string; or, if this is
521a final release, remove it. For example:
d7eb1120
DM
522
523 static const char * const local_patches[] = {
524 NULL
525 + ,"RC1"
526 PERL_GIT_UNPUSHED_COMMITS /* do not remove this line */
527
528Be sure to commit your change:
529
530 $ git commit -m 'bump version to RCnnn' patchlevel.h
531
dc0a4df9
DM
532
533=head3 build, test and check a fresh perl
d7eb1120 534
a0db33fe
DM
535Build perl, then make sure it passes its own test suite, and installs:
536
537 $ git clean -xdf
a42352ee
DM
538 $ ./Configure -des -Dprefix=/tmp/perl-5.x.y-pretest
539
540 # or if it's an odd-numbered version:
a0db33fe 541 $ ./Configure -des -Dusedevel -Dprefix=/tmp/perl-5.x.y-pretest
a42352ee 542
a0db33fe
DM
543 $ make test install
544
52a66c2c
DM
545Check that the output of C</tmp/perl-5.x.y-pretest/bin/perl -v> and
546C</tmp/perl-5.x.y-pretest/bin/perl -V> are as expected,
a0db33fe 547especially as regards version numbers, patch and/or RC levels, and @INC
52a66c2c
DM
548paths. Note that as they have been been built from a git working
549directory, they will still identify themselves using git tags and
550commits.
551
552Then delete the temporary installation.
553
dc0a4df9
DM
554
555=head3 push the work so far
52a66c2c 556
a0db33fe
DM
557Push all your recent commits:
558
559 $ git push origin ....
560
96054f12 561
dc0a4df9 562=head3 tag the release
96054f12 563
e8c01f92 564Tag the release (e.g.):
96054f12 565
b6d23947 566 $ git tag v5.11.0 -m "First release of the v5.11 series!"
e8c01f92 567
6a958a95 568It is B<VERY> important that from this point forward, you not push
f662f3b7
JV
569your git changes to the Perl master repository. If anything goes
570wrong before you publish your newly-created tag, you can delete
571and recreate it. Once you push your tag, we're stuck with it
572and you'll need to use a new version number for your release.
573
dc0a4df9
DM
574
575=head3 build the tarball
a0db33fe 576
0dcf3caa 577Before you run the following, you might want to install 7-Zip (the
0dcb816b 578C<p7zip-full> package under Debian or the C<p7zip> port on MacPorts) or
0dcf3caa
LB
579the AdvanceCOMP suite (e.g. the C<advancecomp> package under Debian,
580or the C<advancecomp> port on macports - 7-Zip on Windows is the
581same code as AdvanceCOMP, so Windows users get the smallest files
582first time). These compress about 5% smaller than gzip and bzip2.
583Over the lifetime of your distribution this will save a lot of
584people a small amount of download time and disk space, which adds
585up.
586
8c35d285
JV
587Create a tarball. Use the C<-s> option to specify a suitable suffix for
588the tarball and directory name:
589
590 $ cd root/of/perl/tree
591 $ make distclean
75a012fe
DM
592 $ git clean -xdf # make sure perl and git agree on files
593 $ git status # and there's nothing lying around
8c35d285 594
8c35d285
JV
595 $ perl Porting/makerel -b -s RC1 # for a release candidate
596 $ perl Porting/makerel -b # for a final release
597
598This creates the directory F<../perl-x.y.z-RC1> or similar, copies all
599the MANIFEST files into it, sets the correct permissions on them,
600adds DOS line endings to some, then tars it up as
601F<../perl-x.y.z-RC1.tar.gz>. With C<-b>, it also creates a C<tar.bz2> file.
602
6480287f
MT
603If you're getting your tarball suffixed with -uncommitted and you're sure
604your changes were all committed, you can override the suffix with:
605
606 $ perl Porting/makerel -b -s ''
96054f12 607
8c35d285
JV
608XXX if we go for extra tags and branches stuff, then add the extra details
609here
610
dc0a4df9 611Finally, clean up the temporary directory, e.g.
a42352ee
DM
612
613 $ rm -rf ../perl-x.y.z-RC1
614
dc0a4df9
DM
615
616=head3 test the tarball
617
618=over 4
619
a42352ee
DM
620=item *
621
8c35d285
JV
622Copy the tarballs (.gz and possibly .bz2) to a web server somewhere you
623have access to.
624
625=item *
626
627Download the tarball to some other machine. For a release candidate,
628you really want to test your tarball on two or more different platforms
629and architectures. The #p5p IRC channel on irc.perl.org is a good place
630to find willing victims.
631
632=item *
633
634Check that basic configuration and tests work on each test machine:
635
636 $ ./Configure -des && make all test
f6af4394
DM
637
638=item *
639
8c35d285
JV
640Check that the test harness and install work on each test machine:
641
a42352ee 642 $ make distclean
8c35d285 643 $ ./Configure -des -Dprefix=/install/path && make all test_harness install
a42352ee 644 $ cd /install/path
8c35d285
JV
645
646=item *
647
648Check that the output of C<perl -v> and C<perl -V> are as expected,
649especially as regards version numbers, patch and/or RC levels, and @INC
650paths.
651
652Note that the results may be different without a F<.git/> directory,
653which is why you should test from the tarball.
654
655=item *
656
459fc3ca
DM
657Run the Installation Verification Procedure utility:
658
9651cacc 659 $ ./perl utils/perlivp
459fc3ca
DM
660 ...
661 All tests successful.
662 $
663
664=item *
665
d60a1044
DM
666Compare the pathnames of all installed files with those of the previous
667release (i.e. against the last installed tarball on this branch which you
668have previously verified using this same procedure). In particular, look
669for files in the wrong place, or files no longer included which should be.
670For example, suppose the about-to-be-released version is 5.10.1 and the
671previous is 5.10.0:
672
673 cd installdir-5.10.0/
674 find . -type f | perl -pe's/5\.10\.0/5.10.1/g' | sort > /tmp/f1
675 cd installdir-5.10.1/
676 find . -type f | sort > /tmp/f2
677 diff -u /tmp/f[12]
678
679=item *
680
8c35d285
JV
681Bootstrap the CPAN client on the clean install:
682
16c60e4e 683 $ bin/perl -MCPAN -e "shell"
8c35d285 684
16c60e4e
AB
685If you're running this on Win32 you probably also need a set of Unix
686command-line tools available for CPAN to function correctly without
e8c01f92
SH
687Perl alternatives like LWP installed. Cygwin is an obvious choice.)
688
8c35d285
JV
689=item *
690
a42352ee
DM
691Try installing a popular CPAN module that's reasonably complex and that
692has dependencies; for example:
8c35d285 693
a42352ee
DM
694 CPAN> install Inline
695 CPAN> quit
8c35d285
JV
696
697Check that your perl can run this:
698
16c60e4e 699 $ bin/perl -lwe "use Inline C => q[int f() { return 42;}]; print f"
a42352ee
DM
700 42
701 $
8c35d285
JV
702
703=item *
704
705Bootstrap the CPANPLUS client on the clean install:
706
75a012fe 707 $ bin/cpanp
8c35d285 708
e8c01f92
SH
709(Again, on Win32 you'll need something like Cygwin installed, but make sure
710that you don't end up with its various F<bin/cpan*> programs being found on
711the PATH before those of the Perl that you're trying to test.)
712
8c35d285
JV
713=item *
714
a42352ee 715Install an XS module, for example:
8c35d285 716
a42352ee
DM
717 CPAN Terminal> i DBI
718 CPAN Terminal> quit
719 $ bin/perl -MDBI -e 1
75a012fe 720 $
8c35d285
JV
721
722=item *
723
7f89f796 724Check that the L<perlbug> utility works. Try the following:
47b1f096 725
a14438df 726 $ bin/perlbug
47b1f096
DM
727 ...
728 Subject: test bug report
729 Local perl administrator [yourself]:
730 Editor [vi]:
731 Module:
732 Category [core]:
733 Severity [low]:
734 (edit report)
735 Action (Send/Display/Edit/Subject/Save to File): f
736 Name of file to save message in [perlbug.rep]:
737 Action (Send/Display/Edit/Subject/Save to File): q
738
739and carefully examine the output (in F<perlbug.rep]>), especially
740the "Locally applied patches" section. If everything appears okay, then
75a012fe
DM
741delete the file, and try it again, this time actually submitting the bug
742report. Check that it shows up, then remember to close it!
47b1f096 743
dc0a4df9
DM
744=back
745
746
747=head3 monitor smokes
47b1f096 748
f6af4394
DM
749Wait for the smoke tests to catch up with the commit which this release is
750based on (or at least the last commit of any consequence).
7277a900 751
f6af4394
DM
752Then check that the smoke tests pass (particularly on Win32). If not, go
753back and fix things.
7277a900 754
6a958a95 755Note that for I<BLEAD-POINT> releases this may not be practical. It takes a
1eefd7d5 756long time for the smokers to catch up, especially the Win32
6a958a95
DM
757smokers. This is why we have a RC cycle for I<MAINT> and I<BLEAD-FINAL>
758releases, but for I<BLEAD-POINT> releases sometimes the best you can do is
759to plead with people on IRC to test stuff on their platforms, fire away,
760and then hope for the best.
7277a900 761
dc0a4df9
DM
762
763=head3 upload to PAUSE
7277a900 764
f6af4394 765Once smoking is okay, upload it to PAUSE. This is the point of no return.
db3f805e
JV
766If anything goes wrong after this point, you will need to re-prepare
767a new release with a new minor version or RC number.
768
a14438df
DM
769 https://pause.perl.org/
770
771(Login, then select 'Upload a file to CPAN')
772
45924287
RS
773If your workstation is not connected to a high-bandwidth,
774high-reliability connection to the Internet, you should probably use the
775"GET URL" feature (rather than "HTTP UPLOAD") to have PAUSE retrieve the
776new release from wherever you put it for testers to find it. This will
777eliminate anxious gnashing of teeth while you wait to see if your
77815 megabyte HTTP upload successfully completes across your slow, twitchy
c27b4e97
SH
779cable modem. You can make use of your home directory on dromedary for
780this purpose: F<http://users.perl5.git.perl.org/~USERNAME> maps to
781F</home/USERNAME/public_html>, where F<USERNAME> is your login account
782on dromedary. I<Remember>: if your upload is partially successful, you
783may need to contact a PAUSE administrator or even bump the version of perl.
45924287 784
a42352ee 785Upload both the .gz and .bz2 versions of the tarball.
f6af4394 786
c27b4e97 787Wait until you receive notification emails from the PAUSE indexer
38195a8c 788confirming that your uploads have been received. IMPORTANT -- you will
b28f69c2
Z
789probably get an email that indexing has failed, due to module permissions.
790This is considered normal.
38195a8c
DG
791
792Do not proceed any further until you are sure that your tarballs are on
793CPAN. Check your authors directory on one of the "fast" CPAN mirrors
b28f69c2 794(e.g., cpan.hexten.net
38195a8c 795or cpan.cpantesters.org) to confirm that your uploads have been successful.
c27b4e97 796
dc0a4df9
DM
797
798=head3 publish tag
210de33e 799
f662f3b7 800Now that you've shipped the new perl release to PAUSE, it's
e8c01f92 801time to publish the tag you created earlier to the public git repo (e.g.):
f662f3b7
JV
802
803 $ git push origin tag v5.11.0
f6af4394 804
dc0a4df9
DM
805
806=head3 disarm patchlevel.h
f6af4394 807
6a958a95 808I<You MUST SKIP this step for BLEAD-POINT release>
113f3f4c 809
a42352ee 810Disarm the F<patchlevel.h> change; for example,
d7eb1120
DM
811
812 static const char * const local_patches[] = {
813 NULL
814 - ,"RC1"
815 PERL_GIT_UNPUSHED_COMMITS /* do not remove this line */
816
817Be sure to commit your change:
818
819 $ git commit -m 'disarm RCnnn bump' patchlevel.h
a14438df 820 $ git push origin ....
d7eb1120 821
2e831dfd 822
dc0a4df9
DM
823
824=head3 announce to p5p
2e831dfd 825
db3f805e 826Mail p5p to announce your new release, with a quote you prepared earlier.
f6af4394 827
dc0a4df9
DM
828
829=head3 update epigraphs.pod
f6af4394 830
85531b0a 831Add your quote to F<Porting/epigraphs.pod> and commit it.
606d51b7
Z
832Your release announcement will probably not have reached the web-visible
833archives yet, so you won't be able to include the customary link to the
834release announcement yet.
dc0a4df9
DM
835
836=head3 Module::CoreList nagging
85531b0a 837
bc4c40f2 838I<You MUST SKIP this step for RC>
8c35d285 839
75a012fe
DM
840Remind the current maintainer of C<Module::CoreList> to push a new release
841to CPAN.
7277a900 842
dc0a4df9
DM
843
844=head3 new perldelta
a2cba4bc 845
bc4c40f2 846I<You MUST SKIP this step for RC>
7277a900 847
c5b87fed 848Create a new perldelta.
7277a900 849
17163f85
DM
850B<Note>: currently, the buildtoc below must be run in a I<built> perl source
851directory, as at least one of the pod files it expects to find is
852autogenerated: perluniprops.pod. But you can't build perl if you've added
853the new perldelta file and not updated toc. So, make sure you have a built
dc0a4df9 854perl (with a pod/perluniprops.pod file) now, I<before> continuing.
17163f85
DM
855
856First, update the F<pod/.gitignore> file to ignore the next
857release's generated F<pod/perlNNNdelta.pod> file rather than this release's
5ef3945b
SH
858one which we are about to set in stone (where NNN is the perl version number
859without the dots. i.e. 5135 for 5.13.5).
860
17163f85
DM
861 $ (edit pod/.gitignore )
862 $ git add pod/.gitignore
8e967a1c 863
17163f85
DM
864Then, move the existing F<pod/perldelta.pod> to F<pod/perlNNNdelta.pod>,
865and edit the moved delta file to change the C<NAME> from C<perldelta> to
866C<perlNNNdelta>. For example, assuming you just released 5.10.1, and are
867about to create the 5.10.2 perldelta:
8e967a1c 868
17163f85 869 $ rm pod/perl5101delta.pod # remove the auto-generated file, if any
c5b87fed
FR
870 $ git mv pod/perldelta.pod pod/perl5101delta.pod
871 $ (edit pod/perl5101delta.pod to retitle)
8e967a1c 872 $ git add pod/perl5101delta.pod
c5b87fed 873
17163f85
DM
874Then create a new empty perldelta.pod file for the new release; see
875F<Porting/how_to_write_a_perldelta.pod>. You should be able to do this by
876just copying in a skeleton template and then doing a quick fix up of the
877version numbers. Then commit the move and the new file.
878
c5b87fed
FR
879 $ cp -i Porting/perldelta_template.pod pod/perldelta.pod
880 $ (edit pod/perldelta.pod)
881 $ git add pod/perldelta.pod
882 $ git commit -m 'create perldelta for 5.10.2'
8e967a1c 883
dc0a4df9 884=head3 update perldelta TOC and references
17163f85
DM
885
886Now you need to update various tables of contents related to perldelta,
887most of which can be generated automatically.
7277a900 888
8a51675c
FC
889Edit F<pod.lst>: add the new entry for the perlNNNdelta file for the
890current version (the file that will be symlinked to perldelta).
7277a900 891
17163f85
DM
892Manually create a temporary link to the new delta file; normally this is
893done from the Makefile, but the Makefile is updated by buildtoc, and
894buildtoc won't run without the file there:
895
896 $ ln -s perldelta.pod pod/perl5102delta.pod
897
75a012fe
DM
898Run C<perl pod/buildtoc --build-all> to update the F<perldelta> version in
899the following files:
57433fbf
JV
900
901 MANIFEST
75a012fe 902 Makefile.SH
57433fbf 903 pod/perl.pod
57433fbf 904 vms/descrip_mms.template
75a012fe
DM
905 win32/Makefile
906 win32/makefile.mk
907 win32/pod.mak
908
75a012fe
DM
909Finally, commit:
910
c5b87fed 911 $ git commit -a -m 'update TOC for perlNNNdelta'
75a012fe 912
21768cb3
FC
913At this point you may want to compare the commit with a previous bump to
914see if they look similar. See commit dd885b5 for an example of a
75a012fe 915previous version bump.
57433fbf 916
dc0a4df9
DM
917
918=head3 bump version
57433fbf 919
6a958a95 920I<You MUST SKIP this step for RC, BLEAD-POINT, MAINT>
dc0a62a1 921
6a958a95
DM
922If this was a BLEAD-FINAL release (i.e. the first release of a new maint
923series, 5.x.0 where x is even), then bump the version in the blead branch
924in git, e.g. 5.12.0 to 5.13.0.
17163f85
DM
925
926First, add a new feature bundle to F<lib/feature.pm>, initially by just
927copying the exiting entry, and bump the file's $VERSION; e.g.
928
929 "5.14" => [qw(switch say state unicode_strings)],
930 + "5.15" => [qw(switch say state unicode_strings)],
addebd58 931
dc0a4df9
DM
932Then follow the section L<"Bump the version number"> to bump the version
933in the remaining files and test and commit.
17163f85 934
17163f85 935
d5c37431
NC
936=head3 clean build and test
937
938Run a clean build and test to make sure nothing obvious is broken.
939
940In particular, F<Porting/perldelta_template.pod> is intentionally exempted
941from podchecker tests, to avoid false positives about placeholder text.
942However, once it's copied to F<pod/perldelta.pod> the contents can now
ef4474b5
KW
943cause test failures. Problems should resolved by doing one of the
944following:
945
946=over
947
948=item 1
949
950Replace placeholder text with correct text.
951
952=item 2
953
954If the problem is from a broken placeholder link, you can add it to the
955array C<@perldelta_ignore_links> in F<t/porting/podcheck.t>. Lines
956containing such links should be marked with C<XXX> so that they get
957cleaned up before the next release.
958
959=item 3
960
961Following the instructions output by F<t/porting/podcheck.t> on how to
962update its exceptions database.
963
964=back
d5c37431 965
dc0a4df9
DM
966=head3 push commits
967
968Finally, push any commits done above.
969
970 $ git push origin ....
971
972
973=head3 create maint branch
17163f85 974
6a958a95 975I<You MUST SKIP this step for RC, BLEAD-POINT, MAINT>
17163f85 976
6a958a95
DM
977If this was a BLEAD-FINAL release (i.e. the first release of a new maint
978series, 5.x.0 where x is even), then create a new maint branch based on
979the commit tagged as the current release.
7277a900 980
233ca920
JV
981Assuming you're using git 1.7.x or newer:
982
17163f85 983 $ git checkout -b maint-5.12 v5.12.0
233ca920 984 $ git push origin -u maint-5.12
addebd58 985
dc0a4df9 986
d5722260
DK
987=head3 make the maint branch available in the APC
988
989Clone the new branch into /srv/gitcommon/branches on camel so the APC will
990receive its changes.
991
07697565 992 $ git clone --branch maint-5.14 /gitroot/perl.git \
d5722260 993 ? /srv/gitcommon/branches/perl-5.14.x
07697565 994 $ chmod -R g=u /srv/gitcommon/branches/perl-5.14.x
d5722260
DK
995
996And nag the sysadmins to make this directory available via rsync.
997
998
dc0a4df9 999=head3 copy perldelta.pod to other branches
addebd58 1000
6a958a95 1001I<You MUST SKIP this step for RC, BLEAD-POINT>
8c35d285 1002
c5b87fed 1003Copy the perldelta.pod for this release into the other branches; for
75a012fe 1004example:
7277a900 1005
c5b87fed 1006 $ cp -i ../5.10.x/pod/perldelta.pod pod/perl5101delta.pod # for example
75a012fe
DM
1007 $ git add pod/perl5101delta.pod
1008
1009Edit F<pod.lst> to add an entry for the file, e.g.:
1010
1011 perl5101delta Perl changes in version 5.10.1
bc4c40f2 1012
75a012fe 1013Then rebuild various files:
7277a900 1014
75a012fe
DM
1015 $ perl pod/buildtoc --build-all
1016
1017Finally, commit:
1018
1019 $ git commit -a -m 'add perlXXXdelta'
7277a900 1020
dc0a4df9
DM
1021
1022=head3 update perlhist.pod in other branches
7277a900 1023
f6af4394 1024Make sure any recent F<pod/perlhist.pod> entries are copied to
e8a7a70e 1025F<perlhist.pod> on other branches
f6af4394 1026e.g.
7277a900 1027
f6af4394 1028 5.8.9 2008-Dec-14
7277a900 1029
dc0a4df9
DM
1030
1031=head3 bump RT version number
6e40fbf9 1032
1530afd8
LB
1033Log into http://rt.perl.org/ and check whether the new version is
1034in the RT fields C<Perl Version> and C<Fixed In>. If not, send an
1035email to C<perlbug-admin at perl.org> requesting this.
dc0a4df9
DM
1036
1037=head3 Relax!
a3738a12 1038
bc4c40f2
JV
1039I<You MUST RETIRE to your preferred PUB, CAFE or SEASIDE VILLA for some
1040much-needed rest and relaxation>.
8c35d285
JV
1041
1042Thanks for releasing perl!
1043
7277a900 1044
b28f69c2
Z
1045=head2 Building a release - the day after
1046
606d51b7
Z
1047=head3 link announcement in epigraphs.pod
1048
1049Add, to your quote to F<Porting/epigraphs.pod>, a link to the release
1050announcement in the web-visible mailing list archive. Commit it.
1051
dc0a4df9
DM
1052=head3 check tarball availability
1053
1054Check various website entries to make sure the that tarball has appeared
1055and is properly indexed:
1056
b28f69c2
Z
1057=over 4
1058
1059=item *
1060
98df743a
Z
1061Check your author directory under L<http://www.cpan.org/authors/id/>
1062to ensure that the tarballs are available on the website.
b28f69c2
Z
1063
1064=item *
1065
98df743a
Z
1066Check C</src> on CPAN (on a fast mirror) to ensure that links to
1067the new tarballs have appeared. There should be links in C</src/5.0>
1068(which is accumulating all new versions), links in C</src> (which shows
1069only the latest version on each branch), and an appropriate mention in
1070C</src/README.html> (which describes the latest versions).
1071
1072These links should appear automatically, some hours after upload.
1073If they don't, or the C<README.html> description is inadequate,
1074ask Ask <ask@perl.org>.
b28f69c2
Z
1075
1076=item *
1077
98df743a
Z
1078Check L<http://www.cpan.org/src/> to ensure that the C</src> updates
1079have been correctly mirrored to the website.
1080If they haven't, ask Ask <ask@perl.org>.
1081
1082=item *
b28f69c2 1083
98df743a
Z
1084Check L<http://search.cpan.org> to see if it has indexed the distribution.
1085It should be visible at a URL like C<http://search.cpan.org/dist/perl-5.10.1/>.
b28f69c2 1086
dc0a4df9 1087=back
b28f69c2 1088
dc0a4df9
DM
1089
1090=head3 update dev.perl.org
1091
512b502a 1092I<This step ONLY for BLEAD-FINAL and MAINT>
98df743a 1093
e294df83 1094Ask Leo Lapworth to update L<http://dev.perl.org/perl5/>.
b28f69c2 1095
b28f69c2 1096
7277a900
GS
1097=head1 SOURCE
1098
f6af4394
DM
1099Based on
1100http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2009-05/msg00608.html,
1101plus a whole bunch of other sources, including private correspondence.
7277a900
GS
1102
1103=cut
1104