This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Expand a little on what to do with Module::CoreList and maint
[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
a9d1f3db
LB
450I<blead> and subsequently cherry-pick any releases since the last
451maint release and then your recent commit. XXX need a better example
bfadf2ba 452
a0db33fe 453F<corelist.pl> uses ftp.funet.fi to verify information about dual-lived
bfadf2ba 454modules on CPAN. It can use a full, local CPAN mirror or fall back
e8c01f92
SH
455to C<wget> or C<curl> to fetch only package metadata remotely. (If you're
456on Win32, then installing Cygwin is one way to have commands like C<wget>
457and C<curl> available.)
bfadf2ba
JV
458
459(If you'd prefer to have a full CPAN mirror, see
460http://www.cpan.org/misc/cpan-faq.html#How_mirror_CPAN)
461
a0db33fe 462Then change to your perl checkout, and if necessary,
bfadf2ba 463
595f83ae 464 $ make
bfadf2ba 465
81fc59ef
DG
466If this not the first update for this version (e.g. if it was updated
467when the version number was originally bumped), first edit
d5bddf6e 468F<dist/Module-CoreList/lib/Module/CoreList.pm> to delete the existing
2ce7d676
RGS
469entries for this version from the C<%released> and C<%version> hashes:
470they will have a key like C<5.010001> for 5.10.1.
52a66c2c
DM
471
472XXX the edit-in-place functionality of Porting/corelist.pl should
473be fixed to handle this automatically.
474
bf8ea215 475Then, If you have a local CPAN mirror, run:
bfadf2ba 476
bfadf2ba
JV
477 $ ./perl -Ilib Porting/corelist.pl ~/my-cpan-mirror
478
479Otherwise, run:
480
bfadf2ba
JV
481 $ ./perl -Ilib Porting/corelist.pl cpan
482
52a66c2c 483This will chug for a while, possibly reporting various warnings about
2a720090 484badly-indexed CPAN modules unrelated to the modules actually in core.
2ce7d676 485Assuming all goes well, it will update
d5bddf6e 486F<dist/Module-CoreList/lib/Module/CoreList.pm>.
bfadf2ba
JV
487
488Check that file over carefully:
489
d5bddf6e 490 $ git diff dist/Module-CoreList/lib/Module/CoreList.pm
bfadf2ba 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).
495
496Edit the version number in the new C<< 'Module::CoreList' => 'X.YZ' >>
497entry, as that is likely to reflect the previous version number.
498
cb9af4c0
AB
499Also edit Module::CoreList's new version number in its F<Changes>
500file.
e8c01f92 501
70855f8b
FC
502Add a perldelta entry for the new Module::CoreList version.
503
3dbfcde0
AB
504You should also add the version you're about to release to the
505L<Module::CoreList/CAVEATS> section which enumerates the perl releases
506that Module::CoreList covers.
507
a0db33fe 508In addition, if this is a final release (rather than a release candidate):
bfadf2ba
JV
509
510=over 4
511
512=item *
513
514Update this version's entry in the C<%released> hash with today's date.
515
516=item *
517
518Make sure that the script has correctly updated the C<CAVEATS> section
519
520=back
521
522Finally, commit the new version of Module::CoreList:
6a958a95 523(unless this is for MAINT; in which case commit it to blead first, then
a0db33fe 524cherry-pick it back).
bfadf2ba 525
770cf6ff 526 $ git commit -m 'Update Module::CoreList for 5.x.y' dist/Module-CoreList/lib/Module/CoreList.pm
bfadf2ba 527
dc0a4df9
DM
528
529=head3 check MANIFEST
bfadf2ba 530
a0db33fe 531Check that the manifest is sorted and correct:
8c35d285 532
a0db33fe 533 $ make distclean
300b5357 534 $ git clean -xdf # This shouldn't be necessary if distclean is correct
a0db33fe 535 $ perl Porting/manicheck
d5bddf6e 536
7081fd3a 537If manicheck turns up anything wrong, update MANIFEST and begin this step again.
a0db33fe 538
7081fd3a
JV
539 $ ./configure -des -Dusedevel
540 $ make test_porting
a0db33fe
DM
541 $ git commit -m 'Update MANIFEST' MANIFEST
542
dc0a4df9
DM
543
544=head3 update perlhist.pod
a0db33fe 545
a0db33fe
DM
546Add an entry to F<pod/perlhist.pod> with the current date, e.g.:
547
548 David 5.10.1-RC1 2009-Aug-06
549
550Make sure that the correct pumpking is listed in the left-hand column, and
551if this is the first release under the stewardship of a new pumpking, make
552sure that his or her name is listed in the section entitled
553C<THE KEEPERS OF THE PUMPKIN>.
554
555Be sure to commit your changes:
556
557 $ git commit -m 'add new release to perlhist' pod/perlhist.pod
8c35d285 558
dc0a4df9
DM
559
560=head3 update patchlevel.h
8c35d285 561
6a958a95 562I<You MUST SKIP this step for a BLEAD-POINT release>
d7eb1120 563
a42352ee
DM
564Update F<patchlevel.h> to add a C<-RC1>-or-whatever string; or, if this is
565a final release, remove it. For example:
d7eb1120
DM
566
567 static const char * const local_patches[] = {
568 NULL
569 + ,"RC1"
570 PERL_GIT_UNPUSHED_COMMITS /* do not remove this line */
571
572Be sure to commit your change:
573
574 $ git commit -m 'bump version to RCnnn' patchlevel.h
575
dc0a4df9
DM
576
577=head3 build, test and check a fresh perl
d7eb1120 578
a0db33fe
DM
579Build perl, then make sure it passes its own test suite, and installs:
580
581 $ git clean -xdf
a42352ee
DM
582 $ ./Configure -des -Dprefix=/tmp/perl-5.x.y-pretest
583
584 # or if it's an odd-numbered version:
a0db33fe 585 $ ./Configure -des -Dusedevel -Dprefix=/tmp/perl-5.x.y-pretest
a42352ee 586
a0db33fe
DM
587 $ make test install
588
52a66c2c
DM
589Check that the output of C</tmp/perl-5.x.y-pretest/bin/perl -v> and
590C</tmp/perl-5.x.y-pretest/bin/perl -V> are as expected,
a0db33fe 591especially as regards version numbers, patch and/or RC levels, and @INC
52a66c2c
DM
592paths. Note that as they have been been built from a git working
593directory, they will still identify themselves using git tags and
594commits.
595
596Then delete the temporary installation.
597
dc0a4df9
DM
598
599=head3 push the work so far
52a66c2c 600
a0db33fe
DM
601Push all your recent commits:
602
603 $ git push origin ....
604
96054f12 605
dc0a4df9 606=head3 tag the release
96054f12 607
e8c01f92 608Tag the release (e.g.):
96054f12 609
b6d23947 610 $ git tag v5.11.0 -m "First release of the v5.11 series!"
e8c01f92 611
6a958a95 612It is B<VERY> important that from this point forward, you not push
f662f3b7
JV
613your git changes to the Perl master repository. If anything goes
614wrong before you publish your newly-created tag, you can delete
615and recreate it. Once you push your tag, we're stuck with it
616and you'll need to use a new version number for your release.
617
dc0a4df9
DM
618
619=head3 build the tarball
a0db33fe 620
8c35d285
JV
621Create a tarball. Use the C<-s> option to specify a suitable suffix for
622the tarball and directory name:
623
624 $ cd root/of/perl/tree
625 $ make distclean
75a012fe
DM
626 $ git clean -xdf # make sure perl and git agree on files
627 $ git status # and there's nothing lying around
8c35d285 628
8c35d285
JV
629 $ perl Porting/makerel -b -s RC1 # for a release candidate
630 $ perl Porting/makerel -b # for a final release
631
632This creates the directory F<../perl-x.y.z-RC1> or similar, copies all
633the MANIFEST files into it, sets the correct permissions on them,
634adds DOS line endings to some, then tars it up as
635F<../perl-x.y.z-RC1.tar.gz>. With C<-b>, it also creates a C<tar.bz2> file.
636
6480287f
MT
637If you're getting your tarball suffixed with -uncommitted and you're sure
638your changes were all committed, you can override the suffix with:
639
640 $ perl Porting/makerel -b -s ''
96054f12 641
8c35d285
JV
642XXX if we go for extra tags and branches stuff, then add the extra details
643here
644
c8c95eea
NC
645Optionally, you might want to compress your tarball more. Unix F<gzip>
646doesn't actually produce the smallest possible DEFLATE output. If you have the
647AdvanceCOMP suite (e.g. the C<advancecomp> port on macports), you can run
648
649 $ advdef -z -4 ../perl-x.y.z-RC1.tar.gz
650
651which will probably shrink your tarball by about 5%. Over the lifetime of
652your distribution this will save a lot of people a small amount of download
653time and disk space, which adds up.
654
655(7-Zip on Windows is the same code as AdvanceCOMP, so Windows users get the
656smallest files first time)
657
8c35d285 658
dc0a4df9 659Finally, clean up the temporary directory, e.g.
a42352ee
DM
660
661 $ rm -rf ../perl-x.y.z-RC1
662
dc0a4df9
DM
663
664=head3 test the tarball
665
666=over 4
667
a42352ee
DM
668=item *
669
8c35d285
JV
670Copy the tarballs (.gz and possibly .bz2) to a web server somewhere you
671have access to.
672
673=item *
674
675Download the tarball to some other machine. For a release candidate,
676you really want to test your tarball on two or more different platforms
677and architectures. The #p5p IRC channel on irc.perl.org is a good place
678to find willing victims.
679
680=item *
681
682Check that basic configuration and tests work on each test machine:
683
684 $ ./Configure -des && make all test
f6af4394
DM
685
686=item *
687
8c35d285
JV
688Check that the test harness and install work on each test machine:
689
a42352ee 690 $ make distclean
8c35d285 691 $ ./Configure -des -Dprefix=/install/path && make all test_harness install
a42352ee 692 $ cd /install/path
8c35d285
JV
693
694=item *
695
696Check that the output of C<perl -v> and C<perl -V> are as expected,
697especially as regards version numbers, patch and/or RC levels, and @INC
698paths.
699
700Note that the results may be different without a F<.git/> directory,
701which is why you should test from the tarball.
702
703=item *
704
459fc3ca
DM
705Run the Installation Verification Procedure utility:
706
9651cacc 707 $ ./perl utils/perlivp
459fc3ca
DM
708 ...
709 All tests successful.
710 $
711
712=item *
713
d60a1044
DM
714Compare the pathnames of all installed files with those of the previous
715release (i.e. against the last installed tarball on this branch which you
716have previously verified using this same procedure). In particular, look
717for files in the wrong place, or files no longer included which should be.
718For example, suppose the about-to-be-released version is 5.10.1 and the
719previous is 5.10.0:
720
721 cd installdir-5.10.0/
722 find . -type f | perl -pe's/5\.10\.0/5.10.1/g' | sort > /tmp/f1
723 cd installdir-5.10.1/
724 find . -type f | sort > /tmp/f2
725 diff -u /tmp/f[12]
726
727=item *
728
8c35d285
JV
729Bootstrap the CPAN client on the clean install:
730
16c60e4e 731 $ bin/perl -MCPAN -e "shell"
8c35d285 732
16c60e4e
AB
733If you're running this on Win32 you probably also need a set of Unix
734command-line tools available for CPAN to function correctly without
e8c01f92
SH
735Perl alternatives like LWP installed. Cygwin is an obvious choice.)
736
8c35d285
JV
737=item *
738
a42352ee
DM
739Try installing a popular CPAN module that's reasonably complex and that
740has dependencies; for example:
8c35d285 741
a42352ee
DM
742 CPAN> install Inline
743 CPAN> quit
8c35d285
JV
744
745Check that your perl can run this:
746
16c60e4e 747 $ bin/perl -lwe "use Inline C => q[int f() { return 42;}]; print f"
a42352ee
DM
748 42
749 $
8c35d285
JV
750
751=item *
752
753Bootstrap the CPANPLUS client on the clean install:
754
75a012fe 755 $ bin/cpanp
8c35d285 756
e8c01f92
SH
757(Again, on Win32 you'll need something like Cygwin installed, but make sure
758that you don't end up with its various F<bin/cpan*> programs being found on
759the PATH before those of the Perl that you're trying to test.)
760
8c35d285
JV
761=item *
762
a42352ee 763Install an XS module, for example:
8c35d285 764
a42352ee
DM
765 CPAN Terminal> i DBI
766 CPAN Terminal> quit
767 $ bin/perl -MDBI -e 1
75a012fe 768 $
8c35d285
JV
769
770=item *
771
7f89f796 772Check that the L<perlbug> utility works. Try the following:
47b1f096 773
a14438df 774 $ bin/perlbug
47b1f096
DM
775 ...
776 Subject: test bug report
777 Local perl administrator [yourself]:
778 Editor [vi]:
779 Module:
780 Category [core]:
781 Severity [low]:
782 (edit report)
783 Action (Send/Display/Edit/Subject/Save to File): f
784 Name of file to save message in [perlbug.rep]:
785 Action (Send/Display/Edit/Subject/Save to File): q
786
787and carefully examine the output (in F<perlbug.rep]>), especially
788the "Locally applied patches" section. If everything appears okay, then
75a012fe
DM
789delete the file, and try it again, this time actually submitting the bug
790report. Check that it shows up, then remember to close it!
47b1f096 791
dc0a4df9
DM
792=back
793
794
795=head3 monitor smokes
47b1f096 796
f6af4394
DM
797Wait for the smoke tests to catch up with the commit which this release is
798based on (or at least the last commit of any consequence).
7277a900 799
f6af4394
DM
800Then check that the smoke tests pass (particularly on Win32). If not, go
801back and fix things.
7277a900 802
6a958a95 803Note that for I<BLEAD-POINT> releases this may not be practical. It takes a
1eefd7d5 804long time for the smokers to catch up, especially the Win32
6a958a95
DM
805smokers. This is why we have a RC cycle for I<MAINT> and I<BLEAD-FINAL>
806releases, but for I<BLEAD-POINT> releases sometimes the best you can do is
807to plead with people on IRC to test stuff on their platforms, fire away,
808and then hope for the best.
7277a900 809
dc0a4df9
DM
810
811=head3 upload to PAUSE
7277a900 812
f6af4394 813Once smoking is okay, upload it to PAUSE. This is the point of no return.
db3f805e
JV
814If anything goes wrong after this point, you will need to re-prepare
815a new release with a new minor version or RC number.
816
a14438df
DM
817 https://pause.perl.org/
818
819(Login, then select 'Upload a file to CPAN')
820
45924287
RS
821If your workstation is not connected to a high-bandwidth,
822high-reliability connection to the Internet, you should probably use the
823"GET URL" feature (rather than "HTTP UPLOAD") to have PAUSE retrieve the
824new release from wherever you put it for testers to find it. This will
825eliminate anxious gnashing of teeth while you wait to see if your
82615 megabyte HTTP upload successfully completes across your slow, twitchy
c27b4e97
SH
827cable modem. You can make use of your home directory on dromedary for
828this purpose: F<http://users.perl5.git.perl.org/~USERNAME> maps to
829F</home/USERNAME/public_html>, where F<USERNAME> is your login account
830on dromedary. I<Remember>: if your upload is partially successful, you
831may need to contact a PAUSE administrator or even bump the version of perl.
45924287 832
a42352ee 833Upload both the .gz and .bz2 versions of the tarball.
f6af4394 834
c27b4e97 835Wait until you receive notification emails from the PAUSE indexer
38195a8c 836confirming that your uploads have been received. IMPORTANT -- you will
b28f69c2
Z
837probably get an email that indexing has failed, due to module permissions.
838This is considered normal.
38195a8c
DG
839
840Do not proceed any further until you are sure that your tarballs are on
841CPAN. Check your authors directory on one of the "fast" CPAN mirrors
b28f69c2 842(e.g., cpan.hexten.net
38195a8c 843or cpan.cpantesters.org) to confirm that your uploads have been successful.
c27b4e97 844
dc0a4df9
DM
845
846=head3 publish tag
210de33e 847
f662f3b7 848Now that you've shipped the new perl release to PAUSE, it's
e8c01f92 849time to publish the tag you created earlier to the public git repo (e.g.):
f662f3b7
JV
850
851 $ git push origin tag v5.11.0
f6af4394 852
dc0a4df9
DM
853
854=head3 disarm patchlevel.h
f6af4394 855
6a958a95 856I<You MUST SKIP this step for BLEAD-POINT release>
113f3f4c 857
a42352ee 858Disarm the F<patchlevel.h> change; for example,
d7eb1120
DM
859
860 static const char * const local_patches[] = {
861 NULL
862 - ,"RC1"
863 PERL_GIT_UNPUSHED_COMMITS /* do not remove this line */
864
865Be sure to commit your change:
866
867 $ git commit -m 'disarm RCnnn bump' patchlevel.h
a14438df 868 $ git push origin ....
d7eb1120 869
2e831dfd 870
dc0a4df9
DM
871
872=head3 announce to p5p
2e831dfd 873
db3f805e 874Mail p5p to announce your new release, with a quote you prepared earlier.
f6af4394 875
dc0a4df9
DM
876
877=head3 update epigraphs.pod
f6af4394 878
85531b0a
DG
879Add your quote to F<Porting/epigraphs.pod> and commit it.
880
dc0a4df9
DM
881
882=head3 Module::CoreList nagging
85531b0a 883
bc4c40f2 884I<You MUST SKIP this step for RC>
8c35d285 885
75a012fe
DM
886Remind the current maintainer of C<Module::CoreList> to push a new release
887to CPAN.
7277a900 888
dc0a4df9
DM
889
890=head3 new perldelta
a2cba4bc 891
bc4c40f2 892I<You MUST SKIP this step for RC>
7277a900 893
c5b87fed 894Create a new perldelta.
7277a900 895
17163f85
DM
896B<Note>: currently, the buildtoc below must be run in a I<built> perl source
897directory, as at least one of the pod files it expects to find is
898autogenerated: perluniprops.pod. But you can't build perl if you've added
899the new perldelta file and not updated toc. So, make sure you have a built
dc0a4df9 900perl (with a pod/perluniprops.pod file) now, I<before> continuing.
17163f85
DM
901
902First, update the F<pod/.gitignore> file to ignore the next
903release's generated F<pod/perlNNNdelta.pod> file rather than this release's
5ef3945b
SH
904one which we are about to set in stone (where NNN is the perl version number
905without the dots. i.e. 5135 for 5.13.5).
906
17163f85
DM
907 $ (edit pod/.gitignore )
908 $ git add pod/.gitignore
8e967a1c 909
17163f85
DM
910Then, move the existing F<pod/perldelta.pod> to F<pod/perlNNNdelta.pod>,
911and edit the moved delta file to change the C<NAME> from C<perldelta> to
912C<perlNNNdelta>. For example, assuming you just released 5.10.1, and are
913about to create the 5.10.2 perldelta:
8e967a1c 914
17163f85 915 $ rm pod/perl5101delta.pod # remove the auto-generated file, if any
c5b87fed
FR
916 $ git mv pod/perldelta.pod pod/perl5101delta.pod
917 $ (edit pod/perl5101delta.pod to retitle)
8e967a1c 918 $ git add pod/perl5101delta.pod
c5b87fed 919
17163f85
DM
920Then create a new empty perldelta.pod file for the new release; see
921F<Porting/how_to_write_a_perldelta.pod>. You should be able to do this by
922just copying in a skeleton template and then doing a quick fix up of the
923version numbers. Then commit the move and the new file.
924
c5b87fed
FR
925 $ cp -i Porting/perldelta_template.pod pod/perldelta.pod
926 $ (edit pod/perldelta.pod)
927 $ git add pod/perldelta.pod
928 $ git commit -m 'create perldelta for 5.10.2'
8e967a1c 929
dc0a4df9 930=head3 update perldelta TOC and references
17163f85
DM
931
932Now you need to update various tables of contents related to perldelta,
933most of which can be generated automatically.
7277a900 934
c5b87fed
FR
935Edit F<pod.lst>: add the new entry, flagged as 'd', and unflag the previous
936entry from being 'd'; for example:
75a012fe 937
c5b87fed
FR
938 -d perl5101delta Perl changes in version 5.10.1
939 +d perl5102delta Perl changes in version 5.10.2
75a012fe 940 + perl5101delta Perl changes in version 5.10.1
7277a900 941
17163f85
DM
942Manually create a temporary link to the new delta file; normally this is
943done from the Makefile, but the Makefile is updated by buildtoc, and
944buildtoc won't run without the file there:
945
946 $ ln -s perldelta.pod pod/perl5102delta.pod
947
75a012fe
DM
948Run C<perl pod/buildtoc --build-all> to update the F<perldelta> version in
949the following files:
57433fbf
JV
950
951 MANIFEST
75a012fe 952 Makefile.SH
57433fbf 953 pod/perl.pod
57433fbf 954 vms/descrip_mms.template
75a012fe
DM
955 win32/Makefile
956 win32/makefile.mk
957 win32/pod.mak
958
75a012fe
DM
959Finally, commit:
960
c5b87fed 961 $ git commit -a -m 'update TOC for perlNNNdelta'
75a012fe
DM
962
963At this point you may want to compare the commit with a previous bump to
17163f85 964see if they look similar. See commit 8891dd8d for an example of a
75a012fe 965previous version bump.
57433fbf 966
dc0a4df9
DM
967
968=head3 bump version
57433fbf 969
6a958a95 970I<You MUST SKIP this step for RC, BLEAD-POINT, MAINT>
dc0a62a1 971
6a958a95
DM
972If this was a BLEAD-FINAL release (i.e. the first release of a new maint
973series, 5.x.0 where x is even), then bump the version in the blead branch
974in git, e.g. 5.12.0 to 5.13.0.
17163f85
DM
975
976First, add a new feature bundle to F<lib/feature.pm>, initially by just
977copying the exiting entry, and bump the file's $VERSION; e.g.
978
979 "5.14" => [qw(switch say state unicode_strings)],
980 + "5.15" => [qw(switch say state unicode_strings)],
addebd58 981
dc0a4df9
DM
982Then follow the section L<"Bump the version number"> to bump the version
983in the remaining files and test and commit.
17163f85 984
17163f85 985
dc0a4df9
DM
986=head3 push commits
987
988Finally, push any commits done above.
989
990 $ git push origin ....
991
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
d5722260
DK
1007=head3 make the maint branch available in the APC
1008
1009Clone the new branch into /srv/gitcommon/branches on camel so the APC will
1010receive its changes.
1011
1012 $ git clone --shared --branch maint-5.14 /gitroot/perl.git \
1013 ? /srv/gitcommon/branches/perl-5.14.x
1014 $ chmod g=u /srv/gitcommon/branches/perl-5.14.x
1015
1016And nag the sysadmins to make this directory available via rsync.
1017
1018
dc0a4df9 1019=head3 copy perldelta.pod to other branches
addebd58 1020
6a958a95 1021I<You MUST SKIP this step for RC, BLEAD-POINT>
8c35d285 1022
c5b87fed 1023Copy the perldelta.pod for this release into the other branches; for
75a012fe 1024example:
7277a900 1025
c5b87fed 1026 $ cp -i ../5.10.x/pod/perldelta.pod pod/perl5101delta.pod # for example
75a012fe
DM
1027 $ git add pod/perl5101delta.pod
1028
1029Edit F<pod.lst> to add an entry for the file, e.g.:
1030
1031 perl5101delta Perl changes in version 5.10.1
bc4c40f2 1032
75a012fe 1033Then rebuild various files:
7277a900 1034
75a012fe
DM
1035 $ perl pod/buildtoc --build-all
1036
1037Finally, commit:
1038
1039 $ git commit -a -m 'add perlXXXdelta'
7277a900 1040
dc0a4df9
DM
1041
1042=head3 update perlhist.pod in other branches
7277a900 1043
f6af4394
DM
1044Make sure any recent F<pod/perlhist.pod> entries are copied to
1045F<perlhist.pod> on other branches; typically the RC* and final entries,
1046e.g.
7277a900 1047
f6af4394
DM
1048 5.8.9-RC1 2008-Nov-10
1049 5.8.9-RC2 2008-Dec-06
1050 5.8.9 2008-Dec-14
7277a900 1051
dc0a4df9
DM
1052
1053=head3 bump RT version number
6e40fbf9 1054
a3738a12
DM
1055If necessary, send an email to C<perlbug-admin at perl.org> requesting
1056that new version numbers be added to the RT fields C<Perl Version> and
1057C<Fixed In>.
1058
dc0a4df9
DM
1059
1060=head3 Relax!
a3738a12 1061
bc4c40f2
JV
1062I<You MUST RETIRE to your preferred PUB, CAFE or SEASIDE VILLA for some
1063much-needed rest and relaxation>.
8c35d285
JV
1064
1065Thanks for releasing perl!
1066
7277a900 1067
b28f69c2
Z
1068=head2 Building a release - the day after
1069
dc0a4df9
DM
1070=head3 check tarball availability
1071
1072Check various website entries to make sure the that tarball has appeared
1073and is properly indexed:
1074
b28f69c2
Z
1075=over 4
1076
1077=item *
1078
98df743a
Z
1079Check your author directory under L<http://www.cpan.org/authors/id/>
1080to ensure that the tarballs are available on the website.
b28f69c2
Z
1081
1082=item *
1083
98df743a
Z
1084Check C</src> on CPAN (on a fast mirror) to ensure that links to
1085the new tarballs have appeared. There should be links in C</src/5.0>
1086(which is accumulating all new versions), links in C</src> (which shows
1087only the latest version on each branch), and an appropriate mention in
1088C</src/README.html> (which describes the latest versions).
1089
1090These links should appear automatically, some hours after upload.
1091If they don't, or the C<README.html> description is inadequate,
1092ask Ask <ask@perl.org>.
b28f69c2
Z
1093
1094=item *
1095
98df743a
Z
1096Check L<http://www.cpan.org/src/> to ensure that the C</src> updates
1097have been correctly mirrored to the website.
1098If they haven't, ask Ask <ask@perl.org>.
1099
1100=item *
b28f69c2 1101
98df743a
Z
1102Check L<http://search.cpan.org> to see if it has indexed the distribution.
1103It should be visible at a URL like C<http://search.cpan.org/dist/perl-5.10.1/>.
b28f69c2 1104
dc0a4df9 1105=back
b28f69c2 1106
dc0a4df9
DM
1107
1108=head3 update dev.perl.org
1109
1110I<This step ONLY for BLEAD-POINT and MAINT>
98df743a
Z
1111
1112Ask Rafael to update L<http://dev.perl.org/perl5/>.
b28f69c2 1113
b28f69c2 1114
7277a900
GS
1115=head1 SOURCE
1116
f6af4394
DM
1117Based on
1118http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2009-05/msg00608.html,
1119plus a whole bunch of other sources, including private correspondence.
7277a900
GS
1120
1121=cut
1122