This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Improve Porting/checkAUTHORS.pl
[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
c67d51c3
DM
7As of August 2009, this file is mostly complete, although it is missing
8some detail on doing a major release (e.g. 5.10.0 -> 5.12.0). Note that
d60a1044
DM
9things change at each release, so there may be new things not covered
10here, or tools may need updating.
f6af4394 11
7277a900
GS
12=head1 SYNOPSIS
13
f6af4394
DM
14This document describes the series of tasks required - some automatic, some
15manual - to produce a perl release of some description, be that a snaphot,
8c35d285 16release candidate, or final, numbered release of maint or blead.
f6af4394 17
8c35d285 18The release process has traditionally been executed by the current
ee76d676
JV
19pumpking. Blead releases from 5.11.0 forward are made each month on the
2020th by a non-pumpking release engineer. The release engineer roster
21and schedule can be found in Porting/release_schedule.pod.
7277a900 22
8c35d285
JV
23This document both helps as a check-list for the release engineer
24and is a base for ideas on how the various tasks could be automated
25or distributed.
7277a900 26
636a1918 27The outline of a typical release cycle is as follows:
f6af4394 28
636a1918 29 (5.10.1 is released, and post-release actions have been done)
f6af4394
DM
30
31 ...time passes...
32
33 an occasional snapshot is released, that still identifies itself as
34 5.10.1
35
36 ...time passes...
37
38 a few weeks before the release, a number of steps are performed,
39 including bumping the version to 5.10.2
636a1918
DM
40
41 ...a few weeks passes...
46743ef7 42
f6af4394
DM
43 perl-5.10.2-RC1 is released
44
45 perl-5.10.2 is released
46
47 post-release actions are performed, including creating new
48 perl5103delta.pod
49
50 ... the cycle continues ...
7277a900
GS
51
52=head1 DETAILS
53
8c35d285
JV
54Some of the tasks described below apply to all four types of
55release of Perl. (snapshot, RC, final release of maint, final
56release of blead). Some of these tasks apply only to a subset
57of these release types. If a step does not apply to a given
58type of release, you will see a notation to that effect at
59the beginning of the step.
60
61=head2 Release types
62
63=over 4
64
65=item Snapshot
66
67A snapshot is intended to encourage in-depth testing from time-to-time,
68for example after a key point in the stabilisation of a branch. It
69requires fewer steps than a full release, and the version number of perl in
70the tarball will usually be the same as that of the previous release.
71
72=item Release Candidate (RC)
73
d60a1044
DM
74A release candidate is an attempt to produce a tarball that is a close as
75possible to the final release. Indeed, unless critical faults are found
76during the RC testing, the final release will be identical to the RC
77barring a few minor fixups (updating the release date in F<perlhist.pod>,
78removing the RC status from F<patchlevel.h>, etc). If faults are found,
79then the fixes should be put into a new release candidate, never directly
80into a final release.
8c35d285
JV
81
82=item Stable/Maint release
83
84At this point you should have a working release candidate with few or no
85changes since.
86
87It's essentially the same procedure as for making a release candidate, but
88with a whole bunch of extra post-release steps.
89
90=item Blead release
91
92It's essentially the same procedure as for making a release candidate, but
93with a whole bunch of extra post-release steps.
94
95=back
7277a900 96
fd838dcf
JV
97=head2 Prerequisites
98
99Before you can make an official release of perl, there are a few
100hoops you need to jump through:
101
102=over 4
103
8c35d285
JV
104=item PAUSE account
105
106I<SKIP this step for SNAPSHOT>
fd838dcf
JV
107
108Make sure you have a PAUSE account suitable for uploading a perl release.
109If you don't have a PAUSE account, then request one:
110
111 https://pause.perl.org/pause/query?ACTION=request_id
112
113Check that your account is allowed to upload perl distros: goto
b386fa44 114L<https://pause.perl.org/>, login, then select 'upload file to CPAN'; there
fd838dcf
JV
115should be a "For pumpkings only: Send a CC" tickbox. If not, ask Andreas
116König to add your ID to the list of people allowed to upload something
117called perl. You can find Andreas' email address at:
4d2c8158 118
fd838dcf
JV
119 https://pause.perl.org/pause/query?ACTION=pause_04imprint
120
fdabea7a
JV
121=item search.cpan.org
122
123Make sure that search.cpan.org knows that you're allowed to upload
124perl distros. Contact Graham Barr to make sure that you're on the right
125list.
126
8c35d285
JV
127=item CPAN mirror
128
129Some release engineering steps require a full mirror of the CPAN.
130Work to fall back to using a remote mirror via HTTP is incomplete
131but ongoing. (No, a minicpan mirror is not sufficient)
132
133=item git checkout and commit bit
fd838dcf
JV
134
135You will need a working C<git> installation, checkout of the perl
136git repository and perl commit bit. For information about working
137with perl and git, see F<pod/perlrepository.pod>.
138
139If you are not yet a perl committer, you won't be able to make a
140release. Have a chat with whichever evil perl porter tried to talk
141you into the idea in the first place to figure out the best way to
142resolve the issue.
143
f6af4394 144
8c35d285 145=item Quotation for release announcement epigraph
f6af4394 146
8c35d285 147I<SKIP this step for SNAPSHOT and RC>
f6af4394 148
8c35d285
JV
149For a numbered blead or maint release of perl, you will need a quotation
150to use as an epigraph to your release announcement. (There's no harm
151in having one for a snapshot, but it's not required).
46743ef7 152
f6af4394
DM
153
154=back
155
b82efa27 156
2e831dfd 157=head2 Building a release - advance actions
8c35d285
JV
158
159The work of building a release candidate for a numbered release of
160perl generally starts several weeks before the first release candidate.
52a66c2c
DM
161Some of the following steps should be done regularly, but all I<must> be
162done in the run up to a release.
7277a900
GS
163
164=over 4
165
f6af4394
DM
166=item *
167
8c35d285
JV
168I<You MAY SKIP this step for SNAPSHOT>
169
f6af4394
DM
170Ensure that dual-life CPAN modules are synchronised with CPAN. Basically,
171run the following:
172
db3f805e 173 $ ./perl -Ilib Porting/core-cpan-diff -a -o /tmp/corediffs
7277a900 174
f6af4394
DM
175to see any inconsistencies between the core and CPAN versions of distros,
176then fix the core, or cajole CPAN authors as appropriate. See also the
177C<-d> and C<-v> options for more detail. You'll probably want to use the
178C<-c cachedir> option to avoid repeated CPAN downloads.
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
52a66c2c 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
f6af4394 190=item *
7277a900 191
8c35d285
JV
192I<You MAY SKIP this step for SNAPSHOT>
193
f6af4394 194Ensure dual-life CPAN modules are stable, which comes down to:
7277a900
GS
195
196 for each module that fails its regression tests on $current
f6af4394
DM
197 did it fail identically on $previous?
198 if yes, "SEP" (Somebody Else's Problem)
199 else work out why it failed (a bisect is useful for this)
7277a900
GS
200
201 attempt to group failure causes
202
203 for each failure cause
f6af4394
DM
204 is that a regression?
205 if yes, figure out how to fix it
206 (more code? revert the code that broke it)
207 else
208 (presumably) it's relying on something un-or-under-documented
209 should the existing behaviour stay?
210 yes - goto "regression"
211 no - note it in perldelta as a significant bugfix
212 (also, try to inform the module's author)
1aff5354 213
f6af4394 214=item *
7277a900 215
8c35d285
JV
216I<You MAY SKIP this step for SNAPSHOT>
217
f6af4394 218Similarly, monitor the smoking of core tests, and try to fix.
f85d27e8 219See L<http://doc.procura.nl/smoke/index.html> for a summary.
7277a900 220
f6af4394 221=item *
7277a900 222
8c35d285
JV
223I<You MAY SKIP this step for SNAPSHOT>
224
636a1918
DM
225Similarly, monitor the smoking of perl for compiler warnings, and try to
226fix.
227
228=item *
229
8c35d285
JV
230I<You MAY SKIP this step for SNAPSHOT>
231
f6af4394
DM
232Run F<Porting/cmpVERSION.pl> to compare the current source tree with the
233previous version to check for for modules that have identical version
234numbers but different contents, e.g.:
7277a900 235
f6af4394 236 $ cd ~/some-perl-root
4c0f950e 237 $ ./perl -Ilib Porting/cmpVERSION.pl -xd . v5.10.0
f6af4394
DM
238
239then bump the version numbers of any non-dual-life modules that have
240changed since the previous release, but which still have the old version
241number. If there is more than one maintenance branch (e.g. 5.8.x, 5.10.x),
242then compare against both.
243
244Note that some of the files listed may be generated (e.g. copied from ext/
245to lib/, or a script like lib/lib_pm.PL is run to produce lib/lib.pm);
246make sure you edit the correct file!
247
248Once all version numbers have been bumped, re-run the checks.
249
250Then run again without the -x option, to check that dual-life modules are
251also sensible.
252
4c0f950e 253 $ ./perl -Ilib Porting/cmpVERSION.pl -d . v5.10.0
54356a6f 254
55878aed
JV
255=item *
256
8c35d285
JV
257I<You MAY SKIP this step for SNAPSHOT>
258
f6af4394 259Get perldelta in a mostly finished state.
db3f805e 260
04c2c53e 261Read F<Porting/how_to_write_a_perldelta.pod>, and try to make sure that
636a1918
DM
262every section it lists is, if necessary, populated and complete. Copy
263edit the whole document.
f6af4394
DM
264
265=item *
266
8c35d285
JV
267I<You MUST SKIP this step for SNAPSHOT>
268
2e831dfd
DM
269A week or two before the first release candidate, bump the perl version
270number (e.g. from 5.10.0 to 5.10.1), to allow sufficient time for testing
271and smoking with the target version built into the perl executable. For
272subsequent release candidates and the final release, it it not necessary
273to bump the version further.
f6af4394
DM
274
275There is a tool to semi-automate this process. It works in two stages.
276First, it generates a list of suggested changes, which you review and
277edit; then you feed this list back and it applies the edits. So, first
52a66c2c
DM
278scan the source directory looking for likely candidates. The command line
279arguments are the old and new version numbers, and -s means scan:
f6af4394
DM
280
281 $ Porting/bump-perl-version -s 5.10.0 5.10.1 > /tmp/scan
282
52a66c2c 283This produces a file containing a list of suggested edits, e.g.:
f6af4394
DM
284
285 NetWare/Makefile
286
287 89: -MODULE_DESC = "Perl 5.10.0 for NetWare"
288 +MODULE_DESC = "Perl 5.10.1 for NetWare"
289
290i.e. in the file F<NetWare/Makefile>, line 89 would be changed as shown.
291Review the file carefully, and delete any -/+ line pairs that you don't
52a66c2c
DM
292want changing. You can also edit just the C<+> line to change the
293suggested replacement text. Remember that this tool is largely just
294grepping for '5.10.0' or whatever, so it will generate false positives. Be
295careful not change text like "this was fixed in 5.10.0"! Then run:
f6af4394
DM
296
297 $ Porting/bump-perl-version -u < /tmp/scan
298
54356a6f 299which will update all the files shown.
f6af4394
DM
300
301Be particularly careful with F<INSTALL>, which contains a mixture of
302C<5.10.0>-type strings, some of which need bumping on every release, and
52a66c2c
DM
303some of which need to be left unchanged. Also note that this tool
304currently only detects a single substitution per line: so in particular,
305this line in README.vms needs special handling:
f6af4394
DM
306
307 rename perl-5^.10^.1.dir perl-5_10_1.dir
7277a900 308
54356a6f
JV
309Commit your changes:
310
311 $ git st
e91bd5c0
LB
312 $ git diff
313 B<review the delta carefully>
54356a6f
JV
314
315 $ git commit -a -m 'Bump the perl version in various places for 5.x.y'
dc0a62a1 316
81fc59ef
DG
317When the version number is bumped, you should also update Module::CoreList (as
318described below in L<"Building a release - on the day">) to reflect the new
319version number.
320
dc0a62a1
DM
321=item *
322
8c35d285
JV
323I<You MUST SKIP this step for SNAPSHOT>
324
dc0a62a1
DM
325Review and update INSTALL to account for the change in version number;
326in particular, the "Coexistence with earlier versions of perl 5" section.
327
f6af4394 328=item *
7277a900 329
b82efa27
RS
330I<You MUST SKIP this step for SNAPSHOT>
331
332Update the F<Changes> file to contain the git log command which would show
333all the changes in this release. You will need assume the existence of a
334not-yet created tag for the forthcoming release; e.g.
335
336 git log ... perl-5.10.0..perl-5.12.0
337
338Due to warts in the perforce-to-git migration, some branches require extra
339exclusions to avoid other branches being pulled in. Make sure you have the
340correct incantation: replace the not-yet-created tag with C<HEAD> and see
341if C<git log> produces roughly the right number of commits across roughly the
342right time period (you may find C<git log --pretty=oneline | wc> useful).
343
344=item *
345
52a66c2c
DM
346Check some more build configurations. The check that setuid builds and
347installs is for < 5.11.0 only.
348
349 $ sh Configure -Dprefix=/tmp/perl-5.x.y -Uinstallusrbinperl \
350 -Duseshrplib -Dd_dosuid
351 $ make
352 $ LD_LIBRARY_PATH=`pwd` make test # or similar for useshrplib
7277a900 353
52a66c2c
DM
354 $ make suidperl
355 $ su -c 'make install'
356 $ ls -l .../bin/sperl
357 -rws--x--x 1 root root 69974 2009-08-22 21:55 .../bin/sperl
7277a900 358
52a66c2c 359(Then delete the installation directory.)
7277a900 360
52a66c2c 361XXX think of other configurations that need testing.
7277a900 362
f6af4394 363=item *
7277a900 364
8c35d285
JV
365I<You MAY SKIP this step for SNAPSHOT>
366
347f5124
RGS
367L<perlport> has a section currently named I<Supported Platforms> that
368indicates which platforms are known to build in the current release.
369If necessary update the list and the indicated version number.
370
2e831dfd
DM
371=back
372
373=head2 Building a release - on the day
374
375This section describes the actions required to make a release (or snapshot
376etc) that are performed on the actual day.
377
378=over 4
379
380=item *
381
382Review all the items in the previous section,
383L<"Building a release - advance actions"> to ensure they are all done and
384up-to-date.
385
8c35d285
JV
386=item *
387
a0db33fe 388I<You MAY SKIP this step for SNAPSHOT>
2e831dfd 389
a0db33fe
DM
390Re-read the perldelta to try to find any embarrassing typos and thinkos;
391remove any C<TODO> or C<XXX> flags; update the "Known Problems" section
392with any serious issues for which fixes are not going to happen now; and
393run through pod and spell checkers, e.g.
2e831dfd 394
bf8ea215
JV
395 $ podchecker -warnings -warnings pod/perl5101delta.pod
396 $ spell pod/perl5101delta.pod
2e831dfd 397
a0db33fe
DM
398Also, you may want to generate and view an HTML version of it to check
399formatting, e.g.
2e831dfd 400
bf8ea215 401 $ perl pod/pod2html pod/perl5101delta.pod > /tmp/perl5101delta.html
2e831dfd 402
8c35d285
JV
403=item *
404
a0db33fe
DM
405Make sure you have a gitwise-clean perl directory (no modified files,
406unpushed commits etc):
8c35d285 407
a0db33fe 408 $ git status
8c35d285
JV
409
410=item *
411
a0db33fe
DM
412If not already built, Configure and build perl so that you have a Makefile
413and porting tools:
8c35d285 414
52a66c2c 415 $ ./Configure -Dusedevel -des && make
8c35d285
JV
416
417=item *
418
a0db33fe
DM
419Check that files managed by F<regen.pl> and friends are up to date. From
420within your working directory:
8c35d285 421
a0db33fe 422 $ git status
8f83713a 423 $ make regen_all
a0db33fe
DM
424 $ make regen_perly
425 $ git status
8c35d285 426
a0db33fe
DM
427If any of the files managed by F<regen.pl> have changed, then you should
428re-make perl to check that it's okay, then commit the updated versions:
8c35d285 429
73ec421b 430 $ git commit -a -m 'make regen; make regen_perly'
8c35d285
JV
431
432=item *
433
bfadf2ba
JV
434I<You MUST SKIP this step for SNAPSHOT>
435
52a66c2c 436Update C<Module::Corelist> with module version data for the new release.
bfadf2ba
JV
437
438Note that if this is a maint release, you should run the following actions
dd0e54ba
DM
439from the maint directory, but commit the C<Corelist.pm> changes in
440I<blead> and subsequently cherry-pick it.
bfadf2ba 441
a0db33fe 442F<corelist.pl> uses ftp.funet.fi to verify information about dual-lived
bfadf2ba 443modules on CPAN. It can use a full, local CPAN mirror or fall back
e8c01f92
SH
444to C<wget> or C<curl> to fetch only package metadata remotely. (If you're
445on Win32, then installing Cygwin is one way to have commands like C<wget>
446and C<curl> available.)
bfadf2ba
JV
447
448(If you'd prefer to have a full CPAN mirror, see
449http://www.cpan.org/misc/cpan-faq.html#How_mirror_CPAN)
450
a0db33fe 451Then change to your perl checkout, and if necessary,
bfadf2ba 452
a0db33fe 453 $ make perl
bfadf2ba 454
81fc59ef
DG
455If this not the first update for this version (e.g. if it was updated
456when the version number was originally bumped), first edit
d5bddf6e 457F<dist/Module-CoreList/lib/Module/CoreList.pm> to delete the existing
2ce7d676
RGS
458entries for this version from the C<%released> and C<%version> hashes:
459they will have a key like C<5.010001> for 5.10.1.
52a66c2c
DM
460
461XXX the edit-in-place functionality of Porting/corelist.pl should
462be fixed to handle this automatically.
463
bf8ea215 464Then, If you have a local CPAN mirror, run:
bfadf2ba 465
bfadf2ba
JV
466 $ ./perl -Ilib Porting/corelist.pl ~/my-cpan-mirror
467
468Otherwise, run:
469
bfadf2ba
JV
470 $ ./perl -Ilib Porting/corelist.pl cpan
471
52a66c2c 472This will chug for a while, possibly reporting various warnings about
2a720090 473badly-indexed CPAN modules unrelated to the modules actually in core.
2ce7d676 474Assuming all goes well, it will update
d5bddf6e 475F<dist/Module-CoreList/lib/Module/CoreList.pm>.
bfadf2ba
JV
476
477Check that file over carefully:
478
d5bddf6e 479 $ git diff dist/Module-CoreList/lib/Module/CoreList.pm
bfadf2ba 480
bfadf2ba
JV
481If necessary, bump C<$VERSION> (there's no need to do this for
482every RC; in RC1, bump the version to a new clean number that will
483appear in the final release, and leave as-is for the later RCs and final).
484
485Edit the version number in the new C<< 'Module::CoreList' => 'X.YZ' >>
486entry, as that is likely to reflect the previous version number.
487
e8c01f92
SH
488Also edit Module::CoreList's new version number in its F<Changes> file and
489in its F<META.yml> file.
490
a0db33fe 491In addition, if this is a final release (rather than a release candidate):
bfadf2ba
JV
492
493=over 4
494
495=item *
496
497Update this version's entry in the C<%released> hash with today's date.
498
499=item *
500
501Make sure that the script has correctly updated the C<CAVEATS> section
502
503=back
504
505Finally, commit the new version of Module::CoreList:
a0db33fe
DM
506(unless this is for maint; in which case commit it blead first, then
507cherry-pick it back).
bfadf2ba 508
770cf6ff 509 $ git commit -m 'Update Module::CoreList for 5.x.y' dist/Module-CoreList/lib/Module/CoreList.pm
bfadf2ba 510
bfadf2ba
JV
511=item *
512
a0db33fe 513Check that the manifest is sorted and correct:
8c35d285 514
a0db33fe
DM
515 $ make manisort
516 $ make distclean
300b5357 517 $ git clean -xdf # This shouldn't be necessary if distclean is correct
a0db33fe 518 $ perl Porting/manicheck
52a66c2c 519 $ git status
a0db33fe 520
d5bddf6e
JV
521 XXX manifest _sorting_ is now checked with make test_porting
522
a0db33fe
DM
523Commit MANIFEST if it has changed:
524
525 $ git commit -m 'Update MANIFEST' MANIFEST
526
527=item *
528
529I<You MUST SKIP this step for SNAPSHOT>
530
531Add an entry to F<pod/perlhist.pod> with the current date, e.g.:
532
533 David 5.10.1-RC1 2009-Aug-06
534
535Make sure that the correct pumpking is listed in the left-hand column, and
536if this is the first release under the stewardship of a new pumpking, make
537sure that his or her name is listed in the section entitled
538C<THE KEEPERS OF THE PUMPKIN>.
539
540Be sure to commit your changes:
541
542 $ git commit -m 'add new release to perlhist' pod/perlhist.pod
8c35d285
JV
543
544=item *
545
d7eb1120
DM
546I<You MUST SKIP this step for SNAPSHOT>
547
a42352ee
DM
548Update F<patchlevel.h> to add a C<-RC1>-or-whatever string; or, if this is
549a final release, remove it. For example:
d7eb1120
DM
550
551 static const char * const local_patches[] = {
552 NULL
553 + ,"RC1"
554 PERL_GIT_UNPUSHED_COMMITS /* do not remove this line */
555
556Be sure to commit your change:
557
558 $ git commit -m 'bump version to RCnnn' patchlevel.h
559
560=item *
561
a0db33fe
DM
562Build perl, then make sure it passes its own test suite, and installs:
563
564 $ git clean -xdf
a42352ee
DM
565 $ ./Configure -des -Dprefix=/tmp/perl-5.x.y-pretest
566
567 # or if it's an odd-numbered version:
a0db33fe 568 $ ./Configure -des -Dusedevel -Dprefix=/tmp/perl-5.x.y-pretest
a42352ee 569
a0db33fe
DM
570 $ make test install
571
572=item *
573
52a66c2c
DM
574Check that the output of C</tmp/perl-5.x.y-pretest/bin/perl -v> and
575C</tmp/perl-5.x.y-pretest/bin/perl -V> are as expected,
a0db33fe 576especially as regards version numbers, patch and/or RC levels, and @INC
52a66c2c
DM
577paths. Note that as they have been been built from a git working
578directory, they will still identify themselves using git tags and
579commits.
580
581Then delete the temporary installation.
582
583=item *
584
585If this is maint release, make sure F<Porting/mergelog> is saved and
586committed.
a0db33fe
DM
587
588=item *
589
590Push all your recent commits:
591
592 $ git push origin ....
593
96054f12
JV
594
595=item *
596
597I<You MUST SKIP this step for SNAPSHOT>
598
e8c01f92 599Tag the release (e.g.):
96054f12
JV
600
601 $ git tag v5.11.0 -m'First release of the v5.11 series!'
602
e8c01f92
SH
603(Adjust the syntax appropriately if you're working on Win32, i.e. use
604C<-m "..."> rather than C<-m'...'>.)
605
f662f3b7
JV
606It is VERY important that from this point forward, you not push
607your git changes to the Perl master repository. If anything goes
608wrong before you publish your newly-created tag, you can delete
609and recreate it. Once you push your tag, we're stuck with it
610and you'll need to use a new version number for your release.
611
a0db33fe
DM
612=item *
613
8c35d285
JV
614Create a tarball. Use the C<-s> option to specify a suitable suffix for
615the tarball and directory name:
616
617 $ cd root/of/perl/tree
618 $ make distclean
75a012fe
DM
619 $ git clean -xdf # make sure perl and git agree on files
620 $ git status # and there's nothing lying around
8c35d285
JV
621
622 $ perl Porting/makerel -b -s `git describe` # for a snapshot
623 $ perl Porting/makerel -b -s RC1 # for a release candidate
624 $ perl Porting/makerel -b # for a final release
625
626This creates the directory F<../perl-x.y.z-RC1> or similar, copies all
627the MANIFEST files into it, sets the correct permissions on them,
628adds DOS line endings to some, then tars it up as
629F<../perl-x.y.z-RC1.tar.gz>. With C<-b>, it also creates a C<tar.bz2> file.
630
6480287f
MT
631If you're getting your tarball suffixed with -uncommitted and you're sure
632your changes were all committed, you can override the suffix with:
633
634 $ perl Porting/makerel -b -s ''
96054f12 635
8c35d285
JV
636XXX if we go for extra tags and branches stuff, then add the extra details
637here
638
639=item *
640
a42352ee
DM
641Clean up the temporary directory, e.g.
642
643 $ rm -rf ../perl-x.y.z-RC1
644
645=item *
646
8c35d285
JV
647Copy the tarballs (.gz and possibly .bz2) to a web server somewhere you
648have access to.
649
650=item *
651
652Download the tarball to some other machine. For a release candidate,
653you really want to test your tarball on two or more different platforms
654and architectures. The #p5p IRC channel on irc.perl.org is a good place
655to find willing victims.
656
657=item *
658
659Check that basic configuration and tests work on each test machine:
660
661 $ ./Configure -des && make all test
f6af4394
DM
662
663=item *
664
8c35d285
JV
665Check that the test harness and install work on each test machine:
666
a42352ee 667 $ make distclean
8c35d285 668 $ ./Configure -des -Dprefix=/install/path && make all test_harness install
a42352ee 669 $ cd /install/path
8c35d285
JV
670
671=item *
672
673Check that the output of C<perl -v> and C<perl -V> are as expected,
674especially as regards version numbers, patch and/or RC levels, and @INC
675paths.
676
677Note that the results may be different without a F<.git/> directory,
678which is why you should test from the tarball.
679
680=item *
681
459fc3ca
DM
682Run the Installation Verification Procedure utility:
683
684 $ bin/perlivp
685 ...
686 All tests successful.
687 $
688
689=item *
690
d60a1044
DM
691Compare the pathnames of all installed files with those of the previous
692release (i.e. against the last installed tarball on this branch which you
693have previously verified using this same procedure). In particular, look
694for files in the wrong place, or files no longer included which should be.
695For example, suppose the about-to-be-released version is 5.10.1 and the
696previous is 5.10.0:
697
698 cd installdir-5.10.0/
699 find . -type f | perl -pe's/5\.10\.0/5.10.1/g' | sort > /tmp/f1
700 cd installdir-5.10.1/
701 find . -type f | sort > /tmp/f2
702 diff -u /tmp/f[12]
703
704=item *
705
8c35d285
JV
706Bootstrap the CPAN client on the clean install:
707
75a012fe 708 $ bin/perl -MCPAN -e'shell'
8c35d285 709
e8c01f92
SH
710(Use C<... -e "shell"> instead on Win32. You probably also need a set of
711Unix command-line tools available for CPAN to function correctly without
712Perl alternatives like LWP installed. Cygwin is an obvious choice.)
713
8c35d285
JV
714=item *
715
a42352ee
DM
716Try installing a popular CPAN module that's reasonably complex and that
717has dependencies; for example:
8c35d285 718
a42352ee
DM
719 CPAN> install Inline
720 CPAN> quit
8c35d285
JV
721
722Check that your perl can run this:
723
75a012fe 724 $ bin/perl -lwe 'use Inline C => "int f() { return 42;} "; print f'
a42352ee
DM
725 42
726 $
8c35d285 727
e8c01f92
SH
728(Use C<... -lwe "use ..."> instead on Win32.)
729
8c35d285
JV
730=item *
731
732Bootstrap the CPANPLUS client on the clean install:
733
75a012fe 734 $ bin/cpanp
8c35d285 735
e8c01f92
SH
736(Again, on Win32 you'll need something like Cygwin installed, but make sure
737that you don't end up with its various F<bin/cpan*> programs being found on
738the PATH before those of the Perl that you're trying to test.)
739
8c35d285
JV
740=item *
741
a42352ee 742Install an XS module, for example:
8c35d285 743
a42352ee
DM
744 CPAN Terminal> i DBI
745 CPAN Terminal> quit
746 $ bin/perl -MDBI -e 1
75a012fe 747 $
8c35d285
JV
748
749=item *
750
bc4c40f2
JV
751I<If you're building a SNAPSHOT, you should STOP HERE>
752
753=item *
8c35d285 754
47b1f096
DM
755Check that the C<perlbug> utility works. Try the following:
756
a14438df 757 $ bin/perlbug
47b1f096
DM
758 ...
759 Subject: test bug report
760 Local perl administrator [yourself]:
761 Editor [vi]:
762 Module:
763 Category [core]:
764 Severity [low]:
765 (edit report)
766 Action (Send/Display/Edit/Subject/Save to File): f
767 Name of file to save message in [perlbug.rep]:
768 Action (Send/Display/Edit/Subject/Save to File): q
769
770and carefully examine the output (in F<perlbug.rep]>), especially
771the "Locally applied patches" section. If everything appears okay, then
75a012fe
DM
772delete the file, and try it again, this time actually submitting the bug
773report. Check that it shows up, then remember to close it!
47b1f096
DM
774
775=item *
776
f6af4394
DM
777Wait for the smoke tests to catch up with the commit which this release is
778based on (or at least the last commit of any consequence).
7277a900 779
f6af4394
DM
780Then check that the smoke tests pass (particularly on Win32). If not, go
781back and fix things.
7277a900 782
7277a900 783
f6af4394 784=item *
7277a900 785
f6af4394 786Once smoking is okay, upload it to PAUSE. This is the point of no return.
db3f805e
JV
787If anything goes wrong after this point, you will need to re-prepare
788a new release with a new minor version or RC number.
789
a14438df
DM
790 https://pause.perl.org/
791
792(Login, then select 'Upload a file to CPAN')
793
45924287
RS
794If your workstation is not connected to a high-bandwidth,
795high-reliability connection to the Internet, you should probably use the
796"GET URL" feature (rather than "HTTP UPLOAD") to have PAUSE retrieve the
797new release from wherever you put it for testers to find it. This will
798eliminate anxious gnashing of teeth while you wait to see if your
79915 megabyte HTTP upload successfully completes across your slow, twitchy
c27b4e97
SH
800cable modem. You can make use of your home directory on dromedary for
801this purpose: F<http://users.perl5.git.perl.org/~USERNAME> maps to
802F</home/USERNAME/public_html>, where F<USERNAME> is your login account
803on dromedary. I<Remember>: if your upload is partially successful, you
804may need to contact a PAUSE administrator or even bump the version of perl.
45924287 805
a42352ee 806Upload both the .gz and .bz2 versions of the tarball.
f6af4394 807
c27b4e97
SH
808Wait until you receive notification emails from the PAUSE indexer
809confirming that your uploads have been successfully indexed. Do not
810proceed any further until you are sure that the indexing of your uploads
811has been successful.
812
210de33e
DM
813=item *
814
f662f3b7 815Now that you've shipped the new perl release to PAUSE, it's
e8c01f92 816time to publish the tag you created earlier to the public git repo (e.g.):
f662f3b7
JV
817
818 $ git push origin tag v5.11.0
f6af4394
DM
819
820=item *
821
a42352ee 822Disarm the F<patchlevel.h> change; for example,
d7eb1120
DM
823
824 static const char * const local_patches[] = {
825 NULL
826 - ,"RC1"
827 PERL_GIT_UNPUSHED_COMMITS /* do not remove this line */
828
829Be sure to commit your change:
830
831 $ git commit -m 'disarm RCnnn bump' patchlevel.h
a14438df 832 $ git push origin ....
d7eb1120 833
2e831dfd
DM
834
835=item *
836
db3f805e 837Mail p5p to announce your new release, with a quote you prepared earlier.
f6af4394
DM
838
839=item *
840
85531b0a
DG
841Add your quote to F<Porting/epigraphs.pod> and commit it.
842
843=item *
844
f6af4394 845Wait 24 hours or so, then post the announcement to use.perl.org.
addebd58
DM
846(if you don't have access rights to post news, ask someone like Rafael to
847do it for you.)
f6af4394 848
f6af4394 849=item *
7277a900 850
a377de85
SH
851Check http://www.cpan.org/src/ to see if the new tarballs have appeared.
852They should appear automatically, but if they don't then ask Jarkko to look
853into it, since his scripts must have broken.
746c0b35
DM
854
855=item *
856
bc4c40f2 857I<You MUST SKIP this step for RC, BLEAD>
7277a900 858
746c0b35
DM
859Ask Jarkko to update the descriptions of which tarballs are current in
860http://www.cpan.org/src/README.html, and Rafael to update
861http://dev.perl.org/perl5/
7277a900 862
f6af4394 863=item *
7277a900 864
bc4c40f2 865I<You MUST SKIP this step for RC>
8c35d285 866
75a012fe
DM
867Remind the current maintainer of C<Module::CoreList> to push a new release
868to CPAN.
7277a900 869
75a012fe 870=item *
a2cba4bc 871
bc4c40f2 872I<You MUST SKIP this step for RC>
7277a900 873
e8c01f92 874Bump the perlXYZdelta version number.
7277a900 875
75a012fe
DM
876First, create a new empty perlNNNdelta.pod file for the current release + 1;
877see F<Porting/how_to_write_a_perldelta.pod>.
7277a900 878
75a012fe
DM
879You should be able to do this by just copying in a skeleton template and
880then doing a quick fix up of the version numbers, e.g.
7277a900 881
8e967a1c
DG
882Then commit this file. (If this new perldelta needs to get cherrypicked
883anywhere, this provides a clean base to merge from.)
884
885For example, assuming 5.10.2:
886
ef72e12f 887 $ cp -i Porting/perldelta_template.pod pod/perl5102delta.pod
75a012fe
DM
888 $ (edit it)
889 $ git add pod/perl5102delta.pod
8e967a1c
DG
890 $ git commit -m 'create perl5102delta'
891
892Edit the previous delta file to change the C<NAME> from C<perldelta>
893to C<perlNNNdelta> and commit it. For example:
894
895 $ git add pod/perl5101delta.pod
896 $ git commit -m 'retitle perl5101delta'
897
898Now you need to update various tables of contents, most of which can be
899generated automatically.
7277a900 900
75a012fe
DM
901Edit F<pod.lst>: add the new entry, flagged as 'D', and unflag the previous
902entry from being 'D'; for example:
903
904 -D perl5101delta Perl changes in version 5.10.1
905 +D perl5102delta Perl changes in version 5.10.2
906 + perl5101delta Perl changes in version 5.10.1
7277a900 907
75a012fe
DM
908Run C<perl pod/buildtoc --build-all> to update the F<perldelta> version in
909the following files:
57433fbf
JV
910
911 MANIFEST
75a012fe
DM
912 Makefile.SH
913 pod.lst
57433fbf 914 pod/perl.pod
57433fbf 915 vms/descrip_mms.template
75a012fe
DM
916 win32/Makefile
917 win32/makefile.mk
918 win32/pod.mak
919
920Then manually edit (F<vms/descrip_mms.template> to bump the version
921in the following entry:
57433fbf 922
75a012fe
DM
923 [.pod]perldelta.pod : [.pod]perl5101delta.pod
924
925XXX this previous step needs to fixed to automate it in pod/buildtoc.
926
927Manually update references to the perlNNNdelta version in these files:
928
929 INSTALL
930 README
931
75a012fe
DM
932These two lists of files probably aren't exhaustive; do a recursive grep
933on the previous filename to look for suitable candidates that may have
934been missed.
935
936Finally, commit:
937
8e967a1c 938 $ git commit -a -m 'update TOC and perldelta references'
75a012fe
DM
939
940At this point you may want to compare the commit with a previous bump to
941see if they look similar. See commit ca8de22071 for an example of a
942previous version bump.
57433fbf
JV
943
944=item *
945
bc4c40f2 946I<You MUST SKIP this step for RC, BLEAD>
dc0a62a1 947
8c35d285
JV
948If this was a maint release, then edit F<Porting/mergelog> to change
949all the C<d> (deferred) flags to C<.> (needs review).
addebd58 950
addebd58
DM
951=item *
952
66d8ce14 953I<You MUST SKIP this step for RC, BLEAD>
addebd58 954
66d8ce14
JV
955If this was the first release of a new maint series, (5.x.0 where x is
956even), then create a new maint branch based on the commit tagged as
957the current release and bump the version in the blead branch in git,
958e.g. 5.12.0 to 5.13.0.
addebd58
DM
959
960[ XXX probably lots more stuff to do, including perldelta,
f6af4394 961C<lib/feature.pm> ]
7277a900 962
233ca920
JV
963Assuming you're using git 1.7.x or newer:
964
965 $ git checkout -b maint-5.12
966 $ git push origin -u maint-5.12
addebd58
DM
967
968=item *
969
bc4c40f2 970I<You MUST SKIP this step for RC, BLEAD>
8c35d285 971
75a012fe
DM
972Copy the perlNNNdelta.pod for this release into the other branches; for
973example:
7277a900 974
75a012fe
DM
975 $ cp -i ../5.10.x/pod/perl5101delta.pod pod/ # for example
976 $ git add pod/perl5101delta.pod
977
978Edit F<pod.lst> to add an entry for the file, e.g.:
979
980 perl5101delta Perl changes in version 5.10.1
bc4c40f2 981
75a012fe 982Then rebuild various files:
7277a900 983
75a012fe
DM
984 $ perl pod/buildtoc --build-all
985
986Finally, commit:
987
988 $ git commit -a -m 'add perlXXXdelta'
7277a900 989
f6af4394 990=item *
7277a900 991
f6af4394
DM
992Make sure any recent F<pod/perlhist.pod> entries are copied to
993F<perlhist.pod> on other branches; typically the RC* and final entries,
994e.g.
7277a900 995
f6af4394
DM
996 5.8.9-RC1 2008-Nov-10
997 5.8.9-RC2 2008-Dec-06
998 5.8.9 2008-Dec-14
7277a900 999
6e40fbf9
DM
1000=item *
1001
a3738a12
DM
1002If necessary, send an email to C<perlbug-admin at perl.org> requesting
1003that new version numbers be added to the RT fields C<Perl Version> and
1004C<Fixed In>.
1005
1006=item *
1007
bc4c40f2
JV
1008I<You MUST RETIRE to your preferred PUB, CAFE or SEASIDE VILLA for some
1009much-needed rest and relaxation>.
8c35d285
JV
1010
1011Thanks for releasing perl!
1012
7277a900
GS
1013=back
1014
1015=head1 SOURCE
1016
f6af4394
DM
1017Based on
1018http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2009-05/msg00608.html,
1019plus a whole bunch of other sources, including private correspondence.
7277a900
GS
1020
1021=cut
1022