This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
buildtoc, known_pod_issues
[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 244
8b2227e6 245There is a tool to semi-automate this process:
f6af4394 246
8b2227e6 247 $ ./perl -Ilib Porting/bump-perl-version -i 5.10.0 5.10.1
f6af4394 248
8b2227e6
LB
249Remember that this tool is largely just grepping for '5.10.0' or whatever,
250so it will generate false positives. Be careful not change text like
251"this was fixed in 5.10.0"!
ceb7f800 252
8b2227e6 253Use git status and git diff to select changes you want to keep.
ceb7f800 254
f6af4394
DM
255Be particularly careful with F<INSTALL>, which contains a mixture of
256C<5.10.0>-type strings, some of which need bumping on every release, and
e03f126c
Z
257some of which need to be left unchanged.
258The line in F<INSTALL> about "is binary incompatible with" requires a
259correct choice of earlier version to declare incompatibility with.
260
6a958a95
DM
261When doing a BLEAD-POINT or BLEAD-FINAL release, also make sure the
262C<PERL_API_*> constants in F<patchlevel.h> are in sync with the version
263you're releasing, unless you're
e43cb88f 264absolutely sure the release you're about to make is 100% binary compatible
6a958a95 265to an earlier release. When releasing a MAINT perl version, the C<PERL_API_*>
e43cb88f
TM
266constants C<MUST NOT> be changed as we aim to guarantee binary compatibility
267in maint branches.
45ce9531 268
17163f85
DM
269After editing, regenerate uconfig.h (this must be run on a system with a
270/bin/sh available):
22be9667 271
17163f85 272 $ perl regen/uconfig_h.pl
22be9667
JV
273
274Test your changes:
275
17163f85 276 $ git clean -xdf # careful if you don't have local files to keep!
22be9667
JV
277 $ ./Configure -des -Dusedevel
278 $ make
279 $ make test
280
54356a6f
JV
281Commit your changes:
282
04abd20e 283 $ git status
e91bd5c0
LB
284 $ git diff
285 B<review the delta carefully>
54356a6f
JV
286
287 $ git commit -a -m 'Bump the perl version in various places for 5.x.y'
dc0a62a1 288
21768cb3
FC
289At this point you may want to compare the commit with a previous bump to
290see if they look similar. See commit 8891dd8d for an example of a
291previous version bump.
292
dc0a4df9
DM
293When the version number is bumped, you should also update Module::CoreList
294(as described below in L<"update Module::CoreList">) to reflect the new
81fc59ef
DG
295version number.
296
dc0a4df9
DM
297
298=head3 update INSTALL
dc0a62a1
DM
299
300Review and update INSTALL to account for the change in version number;
301in particular, the "Coexistence with earlier versions of perl 5" section.
302
6a958a95
DM
303Be particularly careful with the section "Upgrading from 5.X.Y or earlier".
304The "X.Y" needs to be changed to the most recent version that we are
305I<not> binary compatible with.
306
307For MAINT and BLEAD-FINAL releases, this needs to refer to the last
308release in the previous development cycle (so for example, for a 5.14.x
309release, this would be 5.13.11).
310
311For BLEAD-POINT releases, it needs to refer to the previous BLEAD-POINT
312release (so for 5.15.3 this would be 5.15.2).
313
dc0a4df9 314=head3 Check more build configurations
b82efa27 315
52a66c2c
DM
316Check some more build configurations. The check that setuid builds and
317installs is for < 5.11.0 only.
318
319 $ sh Configure -Dprefix=/tmp/perl-5.x.y -Uinstallusrbinperl \
320 -Duseshrplib -Dd_dosuid
321 $ make
322 $ LD_LIBRARY_PATH=`pwd` make test # or similar for useshrplib
7277a900 323
52a66c2c
DM
324 $ make suidperl
325 $ su -c 'make install'
326 $ ls -l .../bin/sperl
327 -rws--x--x 1 root root 69974 2009-08-22 21:55 .../bin/sperl
7277a900 328
52a66c2c 329(Then delete the installation directory.)
7277a900 330
52a66c2c 331XXX think of other configurations that need testing.
7277a900 332
dc0a4df9
DM
333
334=head3 update perlport
7277a900 335
347f5124
RGS
336L<perlport> has a section currently named I<Supported Platforms> that
337indicates which platforms are known to build in the current release.
338If necessary update the list and the indicated version number.
339
6a958a95
DM
340
341
2e831dfd
DM
342=head2 Building a release - on the day
343
b1288acc
DM
344This section describes the actions required to make a release
345that are performed on the actual day.
2e831dfd 346
2e831dfd 347
dc0a4df9 348=head3 re-check earlier actions
2e831dfd 349
dc0a4df9 350Review all the actions in the previous section,
2e831dfd
DM
351L<"Building a release - advance actions"> to ensure they are all done and
352up-to-date.
353
dc0a4df9
DM
354
355=head3 bump version number
8c35d285 356
6a958a95
DM
357For a BLEAD-POINT release, if you did not bump the perl version number as
358part of I<advance actions>, do that now.
04dbb930 359
dc0a4df9
DM
360
361=head3 finalize perldelta
04dbb930 362
04dbb930 363Finalize the perldelta. In particular, fill in the Acknowledgements
38195a8c
DG
364section. You can generate a list of contributors with checkAUTHORS.pl.
365For example:
366
c34fab5f 367 $ git log --pretty=fuller v5.13.${last}..HEAD | \
38195a8c 368 perl Porting/checkAUTHORS.pl --who -
04dbb930 369
ef86391b
AB
370Look at the previous L<perldelta> for how to write the opening
371paragraph of the Acknowledgements section. To get the amount of
372changed files and number of lines use this command:
373
a599c209
LB
374 $ git diff --shortstat v5.15.0..HEAD | \
375 ./perl -Ilib -nE 'my ($files, $insert, $delete) = /(\d+)/ga; say $insert + $delete, " lines of changes across $files files"'
ef86391b
AB
376
377Making sure to round off the number of lines changed.
378
a0db33fe
DM
379Re-read the perldelta to try to find any embarrassing typos and thinkos;
380remove any C<TODO> or C<XXX> flags; update the "Known Problems" section
381with any serious issues for which fixes are not going to happen now; and
382run through pod and spell checkers, e.g.
2e831dfd 383
c5b87fed
FR
384 $ podchecker -warnings -warnings pod/perldelta.pod
385 $ spell pod/perldelta.pod
2e831dfd 386
a0db33fe
DM
387Also, you may want to generate and view an HTML version of it to check
388formatting, e.g.
2e831dfd 389
84c2dc44 390 $ ./perl -Ilib ext/Pod-Html/pod2html pod/perldelta.pod > /tmp/perldelta.html
2e831dfd 391
38195a8c
DG
392Another good HTML preview option is http://search.cpan.org/pod2html
393
394If you make changes, be sure to commit them.
395
dc0a4df9
DM
396
397=head3 build a clean perl
8c35d285 398
a0db33fe
DM
399Make sure you have a gitwise-clean perl directory (no modified files,
400unpushed commits etc):
8c35d285 401
a0db33fe 402 $ git status
24c5e187 403 $ git clean -dxf
8c35d285 404
dc0a4df9 405then configure and build perl so that you have a Makefile and porting tools:
8c35d285 406
52a66c2c 407 $ ./Configure -Dusedevel -des && make
8c35d285 408
dc0a4df9
DM
409
410=head3 update Module::CoreList
8c35d285 411
1bac61bb 412Update C<Module::CoreList> with module version data for the new release.
bfadf2ba 413
6a958a95 414Note that if this is a MAINT release, you should run the following actions
1bac61bb 415from the maint branch, but commit the C<CoreList.pm> changes in
a9d1f3db
LB
416I<blead> and subsequently cherry-pick any releases since the last
417maint release and then your recent commit. XXX need a better example
bfadf2ba 418
a0db33fe 419F<corelist.pl> uses ftp.funet.fi to verify information about dual-lived
bfadf2ba 420modules on CPAN. It can use a full, local CPAN mirror or fall back
e8c01f92
SH
421to C<wget> or C<curl> to fetch only package metadata remotely. (If you're
422on Win32, then installing Cygwin is one way to have commands like C<wget>
423and C<curl> available.)
bfadf2ba
JV
424
425(If you'd prefer to have a full CPAN mirror, see
426http://www.cpan.org/misc/cpan-faq.html#How_mirror_CPAN)
427
a0db33fe 428Then change to your perl checkout, and if necessary,
bfadf2ba 429
595f83ae 430 $ make
bfadf2ba 431
81fc59ef
DG
432If this not the first update for this version (e.g. if it was updated
433when the version number was originally bumped), first edit
d5bddf6e 434F<dist/Module-CoreList/lib/Module/CoreList.pm> to delete the existing
2ce7d676
RGS
435entries for this version from the C<%released> and C<%version> hashes:
436they will have a key like C<5.010001> for 5.10.1.
52a66c2c
DM
437
438XXX the edit-in-place functionality of Porting/corelist.pl should
439be fixed to handle this automatically.
440
bf8ea215 441Then, If you have a local CPAN mirror, run:
bfadf2ba 442
bfadf2ba
JV
443 $ ./perl -Ilib Porting/corelist.pl ~/my-cpan-mirror
444
445Otherwise, run:
446
bfadf2ba
JV
447 $ ./perl -Ilib Porting/corelist.pl cpan
448
52a66c2c 449This will chug for a while, possibly reporting various warnings about
2a720090 450badly-indexed CPAN modules unrelated to the modules actually in core.
2ce7d676 451Assuming all goes well, it will update
d5bddf6e 452F<dist/Module-CoreList/lib/Module/CoreList.pm>.
bfadf2ba
JV
453
454Check that file over carefully:
455
d5bddf6e 456 $ git diff dist/Module-CoreList/lib/Module/CoreList.pm
bfadf2ba 457
bfadf2ba
JV
458If necessary, bump C<$VERSION> (there's no need to do this for
459every RC; in RC1, bump the version to a new clean number that will
460appear in the final release, and leave as-is for the later RCs and final).
461
462Edit the version number in the new C<< 'Module::CoreList' => 'X.YZ' >>
463entry, as that is likely to reflect the previous version number.
464
cb9af4c0
AB
465Also edit Module::CoreList's new version number in its F<Changes>
466file.
e8c01f92 467
70855f8b
FC
468Add a perldelta entry for the new Module::CoreList version.
469
3dbfcde0
AB
470You should also add the version you're about to release to the
471L<Module::CoreList/CAVEATS> section which enumerates the perl releases
472that Module::CoreList covers.
473
a0db33fe 474In addition, if this is a final release (rather than a release candidate):
bfadf2ba
JV
475
476=over 4
477
478=item *
479
480Update this version's entry in the C<%released> hash with today's date.
481
482=item *
483
484Make sure that the script has correctly updated the C<CAVEATS> section
485
486=back
487
488Finally, commit the new version of Module::CoreList:
6a958a95 489(unless this is for MAINT; in which case commit it to blead first, then
a0db33fe 490cherry-pick it back).
bfadf2ba 491
770cf6ff 492 $ git commit -m 'Update Module::CoreList for 5.x.y' dist/Module-CoreList/lib/Module/CoreList.pm
bfadf2ba 493
dc0a4df9
DM
494
495=head3 check MANIFEST
bfadf2ba 496
a0db33fe 497Check that the manifest is sorted and correct:
8c35d285 498
a0db33fe 499 $ make distclean
300b5357 500 $ git clean -xdf # This shouldn't be necessary if distclean is correct
a0db33fe 501 $ perl Porting/manicheck
d5bddf6e 502
7081fd3a 503If manicheck turns up anything wrong, update MANIFEST and begin this step again.
a0db33fe 504
7081fd3a
JV
505 $ ./configure -des -Dusedevel
506 $ make test_porting
a0db33fe
DM
507 $ git commit -m 'Update MANIFEST' MANIFEST
508
dc0a4df9
DM
509
510=head3 update perlhist.pod
a0db33fe 511
e8a7a70e 512I<You MUST SKIP this step for a RC release>
a0db33fe 513
e8a7a70e
JV
514Add an entry to F<pod/perlhist.pod> with the release date, e.g.:
515
516 David 5.10.1 2009-Aug-06
a0db33fe
DM
517
518Make sure that the correct pumpking is listed in the left-hand column, and
519if this is the first release under the stewardship of a new pumpking, make
520sure that his or her name is listed in the section entitled
521C<THE KEEPERS OF THE PUMPKIN>.
522
523Be sure to commit your changes:
524
525 $ git commit -m 'add new release to perlhist' pod/perlhist.pod
8c35d285 526
dc0a4df9
DM
527
528=head3 update patchlevel.h
8c35d285 529
6a958a95 530I<You MUST SKIP this step for a BLEAD-POINT release>
d7eb1120 531
a42352ee
DM
532Update F<patchlevel.h> to add a C<-RC1>-or-whatever string; or, if this is
533a final release, remove it. For example:
d7eb1120
DM
534
535 static const char * const local_patches[] = {
536 NULL
537 + ,"RC1"
538 PERL_GIT_UNPUSHED_COMMITS /* do not remove this line */
539
540Be sure to commit your change:
541
542 $ git commit -m 'bump version to RCnnn' patchlevel.h
543
dc0a4df9
DM
544
545=head3 build, test and check a fresh perl
d7eb1120 546
a0db33fe
DM
547Build perl, then make sure it passes its own test suite, and installs:
548
549 $ git clean -xdf
a42352ee
DM
550 $ ./Configure -des -Dprefix=/tmp/perl-5.x.y-pretest
551
552 # or if it's an odd-numbered version:
a0db33fe 553 $ ./Configure -des -Dusedevel -Dprefix=/tmp/perl-5.x.y-pretest
a42352ee 554
a0db33fe
DM
555 $ make test install
556
52a66c2c
DM
557Check that the output of C</tmp/perl-5.x.y-pretest/bin/perl -v> and
558C</tmp/perl-5.x.y-pretest/bin/perl -V> are as expected,
a0db33fe 559especially as regards version numbers, patch and/or RC levels, and @INC
52a66c2c
DM
560paths. Note that as they have been been built from a git working
561directory, they will still identify themselves using git tags and
562commits.
563
564Then delete the temporary installation.
565
dc0a4df9
DM
566
567=head3 push the work so far
52a66c2c 568
a0db33fe
DM
569Push all your recent commits:
570
571 $ git push origin ....
572
96054f12 573
dc0a4df9 574=head3 tag the release
96054f12 575
e8c01f92 576Tag the release (e.g.):
96054f12 577
b6d23947 578 $ git tag v5.11.0 -m "First release of the v5.11 series!"
e8c01f92 579
6a958a95 580It is B<VERY> important that from this point forward, you not push
f662f3b7
JV
581your git changes to the Perl master repository. If anything goes
582wrong before you publish your newly-created tag, you can delete
583and recreate it. Once you push your tag, we're stuck with it
584and you'll need to use a new version number for your release.
585
dc0a4df9
DM
586
587=head3 build the tarball
a0db33fe 588
8c35d285
JV
589Create a tarball. Use the C<-s> option to specify a suitable suffix for
590the tarball and directory name:
591
592 $ cd root/of/perl/tree
593 $ make distclean
75a012fe
DM
594 $ git clean -xdf # make sure perl and git agree on files
595 $ git status # and there's nothing lying around
8c35d285 596
8c35d285
JV
597 $ perl Porting/makerel -b -s RC1 # for a release candidate
598 $ perl Porting/makerel -b # for a final release
599
600This creates the directory F<../perl-x.y.z-RC1> or similar, copies all
601the MANIFEST files into it, sets the correct permissions on them,
602adds DOS line endings to some, then tars it up as
603F<../perl-x.y.z-RC1.tar.gz>. With C<-b>, it also creates a C<tar.bz2> file.
604
6480287f
MT
605If you're getting your tarball suffixed with -uncommitted and you're sure
606your changes were all committed, you can override the suffix with:
607
608 $ perl Porting/makerel -b -s ''
96054f12 609
8c35d285
JV
610XXX if we go for extra tags and branches stuff, then add the extra details
611here
612
c8c95eea
NC
613Optionally, you might want to compress your tarball more. Unix F<gzip>
614doesn't actually produce the smallest possible DEFLATE output. If you have the
615AdvanceCOMP suite (e.g. the C<advancecomp> port on macports), you can run
616
617 $ advdef -z -4 ../perl-x.y.z-RC1.tar.gz
618
619which will probably shrink your tarball by about 5%. Over the lifetime of
620your distribution this will save a lot of people a small amount of download
621time and disk space, which adds up.
622
623(7-Zip on Windows is the same code as AdvanceCOMP, so Windows users get the
624smallest files first time)
625
8c35d285 626
dc0a4df9 627Finally, clean up the temporary directory, e.g.
a42352ee
DM
628
629 $ rm -rf ../perl-x.y.z-RC1
630
dc0a4df9
DM
631
632=head3 test the tarball
633
634=over 4
635
a42352ee
DM
636=item *
637
8c35d285
JV
638Copy the tarballs (.gz and possibly .bz2) to a web server somewhere you
639have access to.
640
641=item *
642
643Download the tarball to some other machine. For a release candidate,
644you really want to test your tarball on two or more different platforms
645and architectures. The #p5p IRC channel on irc.perl.org is a good place
646to find willing victims.
647
648=item *
649
650Check that basic configuration and tests work on each test machine:
651
652 $ ./Configure -des && make all test
f6af4394
DM
653
654=item *
655
8c35d285
JV
656Check that the test harness and install work on each test machine:
657
a42352ee 658 $ make distclean
8c35d285 659 $ ./Configure -des -Dprefix=/install/path && make all test_harness install
a42352ee 660 $ cd /install/path
8c35d285
JV
661
662=item *
663
664Check that the output of C<perl -v> and C<perl -V> are as expected,
665especially as regards version numbers, patch and/or RC levels, and @INC
666paths.
667
668Note that the results may be different without a F<.git/> directory,
669which is why you should test from the tarball.
670
671=item *
672
459fc3ca
DM
673Run the Installation Verification Procedure utility:
674
9651cacc 675 $ ./perl utils/perlivp
459fc3ca
DM
676 ...
677 All tests successful.
678 $
679
680=item *
681
d60a1044
DM
682Compare the pathnames of all installed files with those of the previous
683release (i.e. against the last installed tarball on this branch which you
684have previously verified using this same procedure). In particular, look
685for files in the wrong place, or files no longer included which should be.
686For example, suppose the about-to-be-released version is 5.10.1 and the
687previous is 5.10.0:
688
689 cd installdir-5.10.0/
690 find . -type f | perl -pe's/5\.10\.0/5.10.1/g' | sort > /tmp/f1
691 cd installdir-5.10.1/
692 find . -type f | sort > /tmp/f2
693 diff -u /tmp/f[12]
694
695=item *
696
8c35d285
JV
697Bootstrap the CPAN client on the clean install:
698
16c60e4e 699 $ bin/perl -MCPAN -e "shell"
8c35d285 700
16c60e4e
AB
701If you're running this on Win32 you probably also need a set of Unix
702command-line tools available for CPAN to function correctly without
e8c01f92
SH
703Perl alternatives like LWP installed. Cygwin is an obvious choice.)
704
8c35d285
JV
705=item *
706
a42352ee
DM
707Try installing a popular CPAN module that's reasonably complex and that
708has dependencies; for example:
8c35d285 709
a42352ee
DM
710 CPAN> install Inline
711 CPAN> quit
8c35d285
JV
712
713Check that your perl can run this:
714
16c60e4e 715 $ bin/perl -lwe "use Inline C => q[int f() { return 42;}]; print f"
a42352ee
DM
716 42
717 $
8c35d285
JV
718
719=item *
720
721Bootstrap the CPANPLUS client on the clean install:
722
75a012fe 723 $ bin/cpanp
8c35d285 724
e8c01f92
SH
725(Again, on Win32 you'll need something like Cygwin installed, but make sure
726that you don't end up with its various F<bin/cpan*> programs being found on
727the PATH before those of the Perl that you're trying to test.)
728
8c35d285
JV
729=item *
730
a42352ee 731Install an XS module, for example:
8c35d285 732
a42352ee
DM
733 CPAN Terminal> i DBI
734 CPAN Terminal> quit
735 $ bin/perl -MDBI -e 1
75a012fe 736 $
8c35d285
JV
737
738=item *
739
7f89f796 740Check that the L<perlbug> utility works. Try the following:
47b1f096 741
a14438df 742 $ bin/perlbug
47b1f096
DM
743 ...
744 Subject: test bug report
745 Local perl administrator [yourself]:
746 Editor [vi]:
747 Module:
748 Category [core]:
749 Severity [low]:
750 (edit report)
751 Action (Send/Display/Edit/Subject/Save to File): f
752 Name of file to save message in [perlbug.rep]:
753 Action (Send/Display/Edit/Subject/Save to File): q
754
755and carefully examine the output (in F<perlbug.rep]>), especially
756the "Locally applied patches" section. If everything appears okay, then
75a012fe
DM
757delete the file, and try it again, this time actually submitting the bug
758report. Check that it shows up, then remember to close it!
47b1f096 759
dc0a4df9
DM
760=back
761
762
763=head3 monitor smokes
47b1f096 764
f6af4394
DM
765Wait for the smoke tests to catch up with the commit which this release is
766based on (or at least the last commit of any consequence).
7277a900 767
f6af4394
DM
768Then check that the smoke tests pass (particularly on Win32). If not, go
769back and fix things.
7277a900 770
6a958a95 771Note that for I<BLEAD-POINT> releases this may not be practical. It takes a
1eefd7d5 772long time for the smokers to catch up, especially the Win32
6a958a95
DM
773smokers. This is why we have a RC cycle for I<MAINT> and I<BLEAD-FINAL>
774releases, but for I<BLEAD-POINT> releases sometimes the best you can do is
775to plead with people on IRC to test stuff on their platforms, fire away,
776and then hope for the best.
7277a900 777
dc0a4df9
DM
778
779=head3 upload to PAUSE
7277a900 780
f6af4394 781Once smoking is okay, upload it to PAUSE. This is the point of no return.
db3f805e
JV
782If anything goes wrong after this point, you will need to re-prepare
783a new release with a new minor version or RC number.
784
a14438df
DM
785 https://pause.perl.org/
786
787(Login, then select 'Upload a file to CPAN')
788
45924287
RS
789If your workstation is not connected to a high-bandwidth,
790high-reliability connection to the Internet, you should probably use the
791"GET URL" feature (rather than "HTTP UPLOAD") to have PAUSE retrieve the
792new release from wherever you put it for testers to find it. This will
793eliminate anxious gnashing of teeth while you wait to see if your
79415 megabyte HTTP upload successfully completes across your slow, twitchy
c27b4e97
SH
795cable modem. You can make use of your home directory on dromedary for
796this purpose: F<http://users.perl5.git.perl.org/~USERNAME> maps to
797F</home/USERNAME/public_html>, where F<USERNAME> is your login account
798on dromedary. I<Remember>: if your upload is partially successful, you
799may need to contact a PAUSE administrator or even bump the version of perl.
45924287 800
a42352ee 801Upload both the .gz and .bz2 versions of the tarball.
f6af4394 802
c27b4e97 803Wait until you receive notification emails from the PAUSE indexer
38195a8c 804confirming that your uploads have been received. IMPORTANT -- you will
b28f69c2
Z
805probably get an email that indexing has failed, due to module permissions.
806This is considered normal.
38195a8c
DG
807
808Do not proceed any further until you are sure that your tarballs are on
809CPAN. Check your authors directory on one of the "fast" CPAN mirrors
b28f69c2 810(e.g., cpan.hexten.net
38195a8c 811or cpan.cpantesters.org) to confirm that your uploads have been successful.
c27b4e97 812
dc0a4df9
DM
813
814=head3 publish tag
210de33e 815
f662f3b7 816Now that you've shipped the new perl release to PAUSE, it's
e8c01f92 817time to publish the tag you created earlier to the public git repo (e.g.):
f662f3b7
JV
818
819 $ git push origin tag v5.11.0
f6af4394 820
dc0a4df9
DM
821
822=head3 disarm patchlevel.h
f6af4394 823
6a958a95 824I<You MUST SKIP this step for BLEAD-POINT release>
113f3f4c 825
a42352ee 826Disarm the F<patchlevel.h> change; for example,
d7eb1120
DM
827
828 static const char * const local_patches[] = {
829 NULL
830 - ,"RC1"
831 PERL_GIT_UNPUSHED_COMMITS /* do not remove this line */
832
833Be sure to commit your change:
834
835 $ git commit -m 'disarm RCnnn bump' patchlevel.h
a14438df 836 $ git push origin ....
d7eb1120 837
2e831dfd 838
dc0a4df9
DM
839
840=head3 announce to p5p
2e831dfd 841
db3f805e 842Mail p5p to announce your new release, with a quote you prepared earlier.
f6af4394 843
dc0a4df9
DM
844
845=head3 update epigraphs.pod
f6af4394 846
85531b0a
DG
847Add your quote to F<Porting/epigraphs.pod> and commit it.
848
dc0a4df9
DM
849
850=head3 Module::CoreList nagging
85531b0a 851
bc4c40f2 852I<You MUST SKIP this step for RC>
8c35d285 853
75a012fe
DM
854Remind the current maintainer of C<Module::CoreList> to push a new release
855to CPAN.
7277a900 856
dc0a4df9
DM
857
858=head3 new perldelta
a2cba4bc 859
bc4c40f2 860I<You MUST SKIP this step for RC>
7277a900 861
c5b87fed 862Create a new perldelta.
7277a900 863
17163f85
DM
864B<Note>: currently, the buildtoc below must be run in a I<built> perl source
865directory, as at least one of the pod files it expects to find is
866autogenerated: perluniprops.pod. But you can't build perl if you've added
867the new perldelta file and not updated toc. So, make sure you have a built
dc0a4df9 868perl (with a pod/perluniprops.pod file) now, I<before> continuing.
17163f85
DM
869
870First, update the F<pod/.gitignore> file to ignore the next
871release's generated F<pod/perlNNNdelta.pod> file rather than this release's
5ef3945b
SH
872one which we are about to set in stone (where NNN is the perl version number
873without the dots. i.e. 5135 for 5.13.5).
874
17163f85
DM
875 $ (edit pod/.gitignore )
876 $ git add pod/.gitignore
8e967a1c 877
17163f85
DM
878Then, move the existing F<pod/perldelta.pod> to F<pod/perlNNNdelta.pod>,
879and edit the moved delta file to change the C<NAME> from C<perldelta> to
880C<perlNNNdelta>. For example, assuming you just released 5.10.1, and are
881about to create the 5.10.2 perldelta:
8e967a1c 882
17163f85 883 $ rm pod/perl5101delta.pod # remove the auto-generated file, if any
c5b87fed
FR
884 $ git mv pod/perldelta.pod pod/perl5101delta.pod
885 $ (edit pod/perl5101delta.pod to retitle)
8e967a1c 886 $ git add pod/perl5101delta.pod
c5b87fed 887
17163f85
DM
888Then create a new empty perldelta.pod file for the new release; see
889F<Porting/how_to_write_a_perldelta.pod>. You should be able to do this by
890just copying in a skeleton template and then doing a quick fix up of the
891version numbers. Then commit the move and the new file.
892
c5b87fed
FR
893 $ cp -i Porting/perldelta_template.pod pod/perldelta.pod
894 $ (edit pod/perldelta.pod)
895 $ git add pod/perldelta.pod
896 $ git commit -m 'create perldelta for 5.10.2'
8e967a1c 897
dc0a4df9 898=head3 update perldelta TOC and references
17163f85
DM
899
900Now you need to update various tables of contents related to perldelta,
901most of which can be generated automatically.
7277a900 902
8a51675c
FC
903Edit F<pod.lst>: add the new entry for the perlNNNdelta file for the
904current version (the file that will be symlinked to perldelta).
7277a900 905
17163f85
DM
906Manually create a temporary link to the new delta file; normally this is
907done from the Makefile, but the Makefile is updated by buildtoc, and
908buildtoc won't run without the file there:
909
910 $ ln -s perldelta.pod pod/perl5102delta.pod
911
75a012fe
DM
912Run C<perl pod/buildtoc --build-all> to update the F<perldelta> version in
913the following files:
57433fbf
JV
914
915 MANIFEST
75a012fe 916 Makefile.SH
57433fbf 917 pod/perl.pod
57433fbf 918 vms/descrip_mms.template
75a012fe
DM
919 win32/Makefile
920 win32/makefile.mk
921 win32/pod.mak
922
75a012fe
DM
923Finally, commit:
924
c5b87fed 925 $ git commit -a -m 'update TOC for perlNNNdelta'
75a012fe 926
21768cb3
FC
927At this point you may want to compare the commit with a previous bump to
928see if they look similar. See commit dd885b5 for an example of a
75a012fe 929previous version bump.
57433fbf 930
dc0a4df9
DM
931
932=head3 bump version
57433fbf 933
6a958a95 934I<You MUST SKIP this step for RC, BLEAD-POINT, MAINT>
dc0a62a1 935
6a958a95
DM
936If this was a BLEAD-FINAL release (i.e. the first release of a new maint
937series, 5.x.0 where x is even), then bump the version in the blead branch
938in git, e.g. 5.12.0 to 5.13.0.
17163f85
DM
939
940First, add a new feature bundle to F<lib/feature.pm>, initially by just
941copying the exiting entry, and bump the file's $VERSION; e.g.
942
943 "5.14" => [qw(switch say state unicode_strings)],
944 + "5.15" => [qw(switch say state unicode_strings)],
addebd58 945
dc0a4df9
DM
946Then follow the section L<"Bump the version number"> to bump the version
947in the remaining files and test and commit.
17163f85 948
17163f85 949
dc0a4df9
DM
950=head3 push commits
951
952Finally, push any commits done above.
953
954 $ git push origin ....
955
956
957=head3 create maint branch
17163f85 958
6a958a95 959I<You MUST SKIP this step for RC, BLEAD-POINT, MAINT>
17163f85 960
6a958a95
DM
961If this was a BLEAD-FINAL release (i.e. the first release of a new maint
962series, 5.x.0 where x is even), then create a new maint branch based on
963the commit tagged as the current release.
7277a900 964
233ca920
JV
965Assuming you're using git 1.7.x or newer:
966
17163f85 967 $ git checkout -b maint-5.12 v5.12.0
233ca920 968 $ git push origin -u maint-5.12
addebd58 969
dc0a4df9 970
d5722260
DK
971=head3 make the maint branch available in the APC
972
973Clone the new branch into /srv/gitcommon/branches on camel so the APC will
974receive its changes.
975
07697565 976 $ git clone --branch maint-5.14 /gitroot/perl.git \
d5722260 977 ? /srv/gitcommon/branches/perl-5.14.x
07697565 978 $ chmod -R g=u /srv/gitcommon/branches/perl-5.14.x
d5722260
DK
979
980And nag the sysadmins to make this directory available via rsync.
981
982
dc0a4df9 983=head3 copy perldelta.pod to other branches
addebd58 984
6a958a95 985I<You MUST SKIP this step for RC, BLEAD-POINT>
8c35d285 986
c5b87fed 987Copy the perldelta.pod for this release into the other branches; for
75a012fe 988example:
7277a900 989
c5b87fed 990 $ cp -i ../5.10.x/pod/perldelta.pod pod/perl5101delta.pod # for example
75a012fe
DM
991 $ git add pod/perl5101delta.pod
992
993Edit F<pod.lst> to add an entry for the file, e.g.:
994
995 perl5101delta Perl changes in version 5.10.1
bc4c40f2 996
75a012fe 997Then rebuild various files:
7277a900 998
75a012fe
DM
999 $ perl pod/buildtoc --build-all
1000
1001Finally, commit:
1002
1003 $ git commit -a -m 'add perlXXXdelta'
7277a900 1004
dc0a4df9
DM
1005
1006=head3 update perlhist.pod in other branches
7277a900 1007
f6af4394 1008Make sure any recent F<pod/perlhist.pod> entries are copied to
e8a7a70e 1009F<perlhist.pod> on other branches
f6af4394 1010e.g.
7277a900 1011
f6af4394 1012 5.8.9 2008-Dec-14
7277a900 1013
dc0a4df9
DM
1014
1015=head3 bump RT version number
6e40fbf9 1016
1530afd8
LB
1017Log into http://rt.perl.org/ and check whether the new version is
1018in the RT fields C<Perl Version> and C<Fixed In>. If not, send an
1019email to C<perlbug-admin at perl.org> requesting this.
dc0a4df9
DM
1020
1021=head3 Relax!
a3738a12 1022
bc4c40f2
JV
1023I<You MUST RETIRE to your preferred PUB, CAFE or SEASIDE VILLA for some
1024much-needed rest and relaxation>.
8c35d285
JV
1025
1026Thanks for releasing perl!
1027
7277a900 1028
b28f69c2
Z
1029=head2 Building a release - the day after
1030
dc0a4df9
DM
1031=head3 check tarball availability
1032
1033Check various website entries to make sure the that tarball has appeared
1034and is properly indexed:
1035
b28f69c2
Z
1036=over 4
1037
1038=item *
1039
98df743a
Z
1040Check your author directory under L<http://www.cpan.org/authors/id/>
1041to ensure that the tarballs are available on the website.
b28f69c2
Z
1042
1043=item *
1044
98df743a
Z
1045Check C</src> on CPAN (on a fast mirror) to ensure that links to
1046the new tarballs have appeared. There should be links in C</src/5.0>
1047(which is accumulating all new versions), links in C</src> (which shows
1048only the latest version on each branch), and an appropriate mention in
1049C</src/README.html> (which describes the latest versions).
1050
1051These links should appear automatically, some hours after upload.
1052If they don't, or the C<README.html> description is inadequate,
1053ask Ask <ask@perl.org>.
b28f69c2
Z
1054
1055=item *
1056
98df743a
Z
1057Check L<http://www.cpan.org/src/> to ensure that the C</src> updates
1058have been correctly mirrored to the website.
1059If they haven't, ask Ask <ask@perl.org>.
1060
1061=item *
b28f69c2 1062
98df743a
Z
1063Check L<http://search.cpan.org> to see if it has indexed the distribution.
1064It should be visible at a URL like C<http://search.cpan.org/dist/perl-5.10.1/>.
b28f69c2 1065
dc0a4df9 1066=back
b28f69c2 1067
dc0a4df9
DM
1068
1069=head3 update dev.perl.org
1070
1071I<This step ONLY for BLEAD-POINT and MAINT>
98df743a 1072
e294df83 1073Ask Leo Lapworth to update L<http://dev.perl.org/perl5/>.
b28f69c2 1074
b28f69c2 1075
7277a900
GS
1076=head1 SOURCE
1077
f6af4394
DM
1078Based on
1079http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2009-05/msg00608.html,
1080plus a whole bunch of other sources, including private correspondence.
7277a900
GS
1081
1082=cut
1083