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