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