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