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