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