This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
A first stab at walking through the release-manager guide Primarily fixing bugs and...
[perl5.git] / Porting / release_managers_guide.pod
CommitLineData
7277a900
GS
1
2=head1 NAME
3
4release_managers_guide - Releasing a new version of perl 5.x
5
636a1918
DM
6XXX as of Jul 2009, this file is still a work-in-progress. I think it
7contains all the actions needed to build a release, but things may have
8got skipped, and some things could do with polishing. Note that things
9change each release, there may be new things not covered here, or
10tools may need updating. DAPM
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,
16release candidate, or final release.
17
7277a900
GS
18The release process is primarily executed by the current pumpking.
19
1aff5354 20This document both helps as a check-list for the pumpking and is
7277a900
GS
21a base for ideas on how the various tasks could be automated or
22distributed.
23
636a1918 24The outline of a typical release cycle is as follows:
f6af4394 25
636a1918 26 (5.10.1 is released, and post-release actions have been done)
f6af4394
DM
27
28 ...time passes...
29
30 an occasional snapshot is released, that still identifies itself as
31 5.10.1
32
33 ...time passes...
34
35 a few weeks before the release, a number of steps are performed,
36 including bumping the version to 5.10.2
636a1918
DM
37
38 ...a few weeks passes...
46743ef7 39
f6af4394
DM
40 perl-5.10.2-RC1 is released
41
42 perl-5.10.2 is released
43
44 post-release actions are performed, including creating new
45 perl5103delta.pod
46
47 ... the cycle continues ...
7277a900
GS
48
49=head1 DETAILS
50
7277a900 51
f6af4394
DM
52=head2 Building a snapshot
53
54A snapshot is intended to encourage in-depth testing from time-to-time,
55for example after a key point in the stabilisation of a branch. It
56requires less steps than a full release, and the version number of perl in
57the tarball will usually still be the old one.
58
59=over 4
60
61=item *
62
63As there are no regular smokes [ XXX yet - please fix?] find out about the
64state of VMS. If it's bad, think again.
65
66=item *
67
46743ef7
JV
68Configure and build perl so that you have a Makefile and porting tools:
69
70 $ ./Configure -Dusedevel -des
71 $ make
72
73=item *
74
f6af4394
DM
75Rebuild META.yml:
76
77 $ rm META.yml
78 $ make META.yml
79
46743ef7
JV
80Commit META.yml if it has changed:
81
82 $ git commit -m 'Updating META.yml in preparation for release of 5.x.y' META.yml
f6af4394
DM
83
84=item *
85
86Check that the manifest is sorted and correct:
87
46743ef7 88 $ make manisort
f6af4394 89 $ make distclean
f6af4394
DM
90 $ perl Porting/manicheck
91
46743ef7
JV
92
93Commit MANIFEST if it has changed:
94
95 $ git commit -m 'Updating MANIFEST in preparation for release of 5.x.y' MANIFEST
96
97
98
f6af4394
DM
99=item *
100
101If this is a release candidate or final release, add an entry to
102F<pod/perlhist.pod> with the current date, e.g.
103
104 5.8.9-RC1 2008-Nov-10
105
ce4f4fe2 106Make sure the correct pumpking is listed, and if this is your first time,
f6af4394
DM
107append your name to C<THE KEEPERS OF THE PUMPKIN>.
108
109=item *
110
111Build perl, then make sure it passes its own test suite, and installs.
112
46743ef7
JV
113 $ ./Configure -des -Dusedevel -Dprefix=/tmp/perl-5.x.y-pretest
114 $ make test install
115
f6af4394
DM
116=item *
117
118Create a tarball. Use the C<-s> option to specify a suitable suffix for
119the tarball and directory name:
120
121 $ cd root/of/perl/tree
46743ef7 122 $ make distclean
f6af4394
DM
123 $ git clean -xdf # make sure perl and git agree on files
124
85bdf03b
DM
125 $ perl Porting/makerel -b -s `git describe` # for a snapshot
126 $ perl Porting/makerel -b -s RC1 # for a release candidate
127 $ perl Porting/makerel -b # for a final release
f6af4394
DM
128
129This creates the directory F<../perl-x.y.z-RC1> or similar, copies all
130the MANIFEST files into it, sets the correct permissions on them,
131adds DOS line endings to some, then tars it up as
85bdf03b 132F<../perl-x.y.z-RC1.tar.gz>. With C<-b>, it also creates a C<tar.bz2> file.
f6af4394
DM
133
134XXX if we go for extra tags and branches stuff, then add the extra details
135here
136
137=item *
138
85bdf03b
DM
139Copy the tarballs (.gz and possibly .bz2) to a web server somewhere you
140have access to.
f6af4394
DM
141
142=item *
143
46743ef7
JV
144Download the tarball to some other machine. For a release candidate,
145you really want to test your tarball on two or more different platforms
146and architectures. The #p5p IRC channel on irc.perl.org is a good place
147to find willing victims.
f6af4394
DM
148
149=item *
150
46743ef7
JV
151Check that C<./Configure -des && make all test> works on each test
152machine.
f6af4394
DM
153
154=item *
155
156Check that C<./Configure ... && make all test_harness install> works.
157
158=item *
159
160Check that the output of C<perl -v> and C<perl -V> are as expected,
161especially as regards version numbers, patch and/or RC levels, and @INC
46743ef7
JV
162paths.
163
164Note that the results may be different without a F<.git/> directory,
f6af4394
DM
165which is why you should test from the tarball.
166
167=item *
168
169Bootstrap the CPAN client on the clean install.
170
171=item *
172
46743ef7 173Install Inline.pm
f6af4394 174
46743ef7 175 perl -MCPAN -e'install Inline'
9db5571e 176
46743ef7 177Check that your perl can run this:
9db5571e 178
46743ef7 179 perl -lwe 'use Inline C => "int answer() { return 42;} "; print answer'
9db5571e 180
f6af4394
DM
181=item *
182
183Bootstrap the CPANPLUS client.
184
185=item *
186
187Install an XS module.
188
189=item *
190
85bdf03b 191If all is well, announce the snapshot to p5p. (For a release candidate,
f6af4394
DM
192instead follow the further steps described later.)
193
194=back
195
196=head2 Actions prior to the first release candidate
197
198A week or two before the first release candidate, there are some additional
199tasks you should perform (actually, some of these should be done regularly
200anyway, but they definitely need doing now):
7277a900
GS
201
202=over 4
203
f6af4394
DM
204=item *
205
206Check F<Maintainers.pl> for consistency; both these commands should
207produce no output:
208
209 perl Porting/Maintainers --checkmani
210 perl Porting/Maintainers --checkmani lib/ ext/
211
212=item *
213
214Ensure that dual-life CPAN modules are synchronised with CPAN. Basically,
215run the following:
216
217 ./perl -Ilib Porting/core-cpan-diff -a -o /tmp/corediffs
7277a900 218
f6af4394
DM
219to see any inconsistencies between the core and CPAN versions of distros,
220then fix the core, or cajole CPAN authors as appropriate. See also the
221C<-d> and C<-v> options for more detail. You'll probably want to use the
222C<-c cachedir> option to avoid repeated CPAN downloads.
7277a900 223
f6af4394 224To see which core distro versions differ from the current CPAN versions:
7277a900 225
f6af4394 226 ./perl -Ilib Porting/core-cpan-diff -x -a
7277a900 227
636a1918
DM
228if you are making a maint release, run C<core-cpan-diff> on both blead and
229maint, then diff the two outputs. Compare this with what you expect, and if
230necessary, fix things up. For example, you might think that both blead
231and maint are synchronised with a particular CPAN module, but one might
232have some extra changes.
233
f6af4394 234=item *
7277a900 235
f6af4394 236Ensure dual-life CPAN modules are stable, which comes down to:
7277a900
GS
237
238 for each module that fails its regression tests on $current
f6af4394
DM
239 did it fail identically on $previous?
240 if yes, "SEP" (Somebody Else's Problem)
241 else work out why it failed (a bisect is useful for this)
7277a900
GS
242
243 attempt to group failure causes
244
245 for each failure cause
f6af4394
DM
246 is that a regression?
247 if yes, figure out how to fix it
248 (more code? revert the code that broke it)
249 else
250 (presumably) it's relying on something un-or-under-documented
251 should the existing behaviour stay?
252 yes - goto "regression"
253 no - note it in perldelta as a significant bugfix
254 (also, try to inform the module's author)
1aff5354 255
f6af4394 256=item *
7277a900 257
f6af4394 258Similarly, monitor the smoking of core tests, and try to fix.
7277a900 259
f6af4394 260=item *
7277a900 261
636a1918
DM
262Similarly, monitor the smoking of perl for compiler warnings, and try to
263fix.
264
265=item *
266
f6af4394
DM
267Run F<Porting/cmpVERSION.pl> to compare the current source tree with the
268previous version to check for for modules that have identical version
269numbers but different contents, e.g.:
7277a900 270
f6af4394
DM
271 $ cd ~/some-perl-root
272 $ ./perl -Ilib Porting/cmpVERSION.pl -xd ~/my_perl-tarballs/perl-5.10.0 .
273
274then bump the version numbers of any non-dual-life modules that have
275changed since the previous release, but which still have the old version
276number. If there is more than one maintenance branch (e.g. 5.8.x, 5.10.x),
277then compare against both.
278
279Note that some of the files listed may be generated (e.g. copied from ext/
280to lib/, or a script like lib/lib_pm.PL is run to produce lib/lib.pm);
281make sure you edit the correct file!
282
283Once all version numbers have been bumped, re-run the checks.
284
285Then run again without the -x option, to check that dual-life modules are
286also sensible.
287
288
289=item *
290
291Get perldelta in a mostly finished state.
636a1918
DM
292Peruse F<Porting/how_to_write_a_perldelta.pod>, and try to make sure that
293every section it lists is, if necessary, populated and complete. Copy
294edit the whole document.
f6af4394
DM
295
296=item *
297
298Bump the perl version number (e.g. from 5.10.0 to 5.10.1).
299
300There is a tool to semi-automate this process. It works in two stages.
301First, it generates a list of suggested changes, which you review and
302edit; then you feed this list back and it applies the edits. So, first
303scan the source dir looking for likely candidates:
304
305 $ Porting/bump-perl-version -s 5.10.0 5.10.1 > /tmp/scan
306
307This produces a file containing a list of suggested edits, eg:
308
309 NetWare/Makefile
310
311 89: -MODULE_DESC = "Perl 5.10.0 for NetWare"
312 +MODULE_DESC = "Perl 5.10.1 for NetWare"
313
314i.e. in the file F<NetWare/Makefile>, line 89 would be changed as shown.
315Review the file carefully, and delete any -/+ line pairs that you don't
316want changing. Remember that this tool is largely just grepping for '5.10.0'
317or whatever, so it will generate false positives. Be careful not change
318text like "this was fixed in 5.10.0"! Then run:
319
320 $ Porting/bump-perl-version -u < /tmp/scan
321
322which will update all the files shown; then commit the changes.
323
324Be particularly careful with F<INSTALL>, which contains a mixture of
325C<5.10.0>-type strings, some of which need bumping on every release, and
326some of which need to be left. Also note that this tool currently only
327performs a single change per line, so in particular, this line in
328README.vms needs special handling:
329
330 rename perl-5^.10^.1.dir perl-5_10_1.dir
7277a900 331
dc0a62a1
DM
332
333=item *
334
335Review and update INSTALL to account for the change in version number;
336in particular, the "Coexistence with earlier versions of perl 5" section.
337
f6af4394 338=item *
7277a900 339
f6af4394
DM
340Update the F<Changes> file to contain the git log command which would show
341all the changes in this release. You will need assume the existence of a
342not-yet created tag for the forthcoming release; e.g.
7277a900 343
f6af4394 344 git log ... perl-5.10.0..perl5.12.0
7277a900 345
f6af4394
DM
346Due to warts in the perforce-to-git migration, some branches require extra
347exclusions to avoid other branches being pulled in. Make sure you have the
348correct incantation: replace the not-yet-created tag with C<HEAD> and see
349if git log produces roughly the right number of commits across roughly the
350right time period.
7277a900 351
dc0a62a1 352
f6af4394 353=item *
7277a900 354
f6af4394 355Check some more build configurations, e.g.
7277a900 356
f6af4394
DM
357 -Duseshrplib -Dd_dosuid
358 make suidperl
7277a900 359
f6af4394
DM
360Check that setuid installs works (for < 5.11.0 only).
361XXX any other configs?
7277a900 362
f6af4394 363=item *
7277a900 364
f6af4394
DM
365Make sure you have a PAUSE account suitable for uploading a perl release.
366If you don't have a PAUSE account, then request one:
7277a900 367
f6af4394 368 https://pause.perl.org/pause/query?ACTION=request_id
7277a900 369
f6af4394
DM
370Check that your account is allowed to upload perl distros: goto
371https://pause.perl.org/, login, then select 'upload file to CPAN'; there
372should be a "For pumpkings only: Send a CC" tickbox. If not, ask Andreas
373to add your ID to the list of people allowed to upload something called
374perl.
7277a900 375
f6af4394 376=item *
7277a900 377
f6af4394
DM
378Update F<AUTHORS>, using the C<Porting/checkAUTHORS.pl> script, and if
379necessary, update the script to include new alias mappings.
7277a900 380
f6af4394
DM
381XXX This script is currently broken (7/2009). It needs updating to work
382with git and a lack of Changes files.
383
384=back
385
386=head2 Building a release candidate
387
388(At this point you should already have performed the actions described in
dc0a62a1
DM
389L</"Actions prior to the first release candidate">.) You should review
390that section to ensure that everything there has done, and to see whether
391any of those actions (such as consistency checks) need to be repeated.
f6af4394
DM
392
393=over 4
394
395=item *
396
397Re-read the perldelta to try to find any embarrassing typos and thinkos;
398remove any C<TODO> or C<XXX> flags; and run through pod and spell
636a1918
DM
399checkers, e.g.
400
401 podchecker -warnings -warnings pod/perl5101delta.pod
402 spell pod/perl5101delta.pod
f6af4394
DM
403
404=item *
405
406Update patchlevel.h to add a C<-RC1>-or-whatever string; or, if this is a
407final release, remove it. [ XXX how now?? see 34813 for old way ]
408
409=item *
410
411Update C<Module::Corelist>.
210de33e 412
ce4f4fe2 413Note that if this is a maint release, you should run the following actions
210de33e
DM
414from the maint directory, but edit the C<Corelist.pm> in I<blead> and
415subsequently cherry-pick it.
416
417First, in order to update the C<%upstream> and C<%bug_tracker> hashes,
418the C<Porting/corelist.pl> script requires you to have a local CPAN
419mirror. See http://www.cpan.org/misc/cpan-faq.html#How_mirror_CPAN for
420more details, but basically:
421
422 $ mkdir ~/cpan-mirror
423 $ rsync -av --delete ftp.funet.fi::CPAN ~/cpan-mirror/
424
425(and re-run the rsync each time you need it to be up-to-date).
426[XXX this really needs fixing to not require a whole CPAN mirror]
427
428If necessary, bump C<$VERSION> (there's no need to do this for
429every RC; in RC1, bump the version to a new clean number that will
430appear in the final release, and leave as-is for the later RCs and final).
431
432Then do
433
434 $ cd ~/perl/root; make perl
435 $ ./perl -Ilib Porting/corelist.pl ~/cpan-mirror/ > /tmp/corelist
436
437This creates a file that looks something like
438
439 5.010001 => {
440 'AnyDBM_File' => '1.00',
441 ...
442 },
443
444 %upstream = (
445 'App::Prove' => undef,
446 ...
447 );
448
449 %bug_tracker = (
450 'App::Prove' => 'http://rt.cpan.org/...',
451 ...
452 );
453
210de33e
DM
454Cut and paste these tables into F<lib/Module/CoreList.pm>: the module
455version list should be appended as the last entry in the C<%version> hash
456(or replaced, if we've already added it for an earlier release candidate),
457while the existing C<%upstream> and C<%bug_tracker> hashes should be
458replaced with the new versions.
459
ce4f4fe2 460Edit the version number in the new C<< 'Module::CoreList' => 'X.YZ' >>
210de33e
DM
461entry, as that is likely to reflect the previous version number.
462
463Then, add the current perl version to the C<CAVEATS> paragraph.
464
465Add or update an entry to the C<%released> hash, including today's date
466(if this is just a release candidate, set the date to '????-??-??').
467
7277a900 468
f6af4394
DM
469=item *
470
471Follow the instructions in the section L</"Building a snapshot">, then
472carry on with the extra steps that follow here.
473
474=item *
7277a900 475
addebd58
DM
476Disarm the patchlevel.h change [ XXX expand ]
477
478=item *
479
f6af4394
DM
480Wait for the smoke tests to catch up with the commit which this release is
481based on (or at least the last commit of any consequence).
7277a900 482
f6af4394
DM
483Then check that the smoke tests pass (particularly on Win32). If not, go
484back and fix things.
7277a900 485
7277a900 486
f6af4394 487=item *
7277a900 488
f6af4394 489Once smoking is okay, upload it to PAUSE. This is the point of no return.
addebd58 490You may wish to create a .bz2 version of the tarball and upload that too.
f6af4394 491
210de33e
DM
492=item *
493
494create a tag [XXX and branches and stuff ????], e.g.:
495
496 $ git tag perl-5.10.1-RC1 -m'Release Candidate 1 of Perl 5.10.1'
497 $ git push origin tag perl-5.10.1-RC1
f6af4394
DM
498
499=item *
500
501Mail p5p to announce it, with a quote you prepared earlier.
502
503=item *
504
505Wait 24 hours or so, then post the announcement to use.perl.org.
addebd58
DM
506(if you don't have access rights to post news, ask someone like Rafael to
507do it for you.)
f6af4394
DM
508
509=back
510
511
512=head2 Making a final release
513
514At this point you should have a working release candidate with few or no
515changes since.
516
517It's essentially the same procedure as for making a release candidate, but
518with a whole bunch of extra post-release steps.
519
520=over 4
7277a900 521
f6af4394 522=item *
7277a900 523
f6af4394 524Follow the same steps as for making a release candidate, then
7277a900 525
f6af4394 526=item *
7277a900 527
f6af4394
DM
528Ask Jarkko to update http://www.cpan.org/src/README.html and
529Rafael to update http://dev.perl.org/perl5/
7277a900 530
f6af4394 531=item *
7277a900 532
f6af4394
DM
533Create a new empty perlNNNdelta.pod file for the current release + 1;
534see F<Porting/how_to_write_a_perldelta.pod>.
535[ XXX Perhaps we should have an empty template file we can copy in. ]
7277a900 536
a2cba4bc
NC
537In addition, edit F<pod.lst>, adding the new entry as 'D', and unmark previous
538entry as 'D', then run C<perl pod/buildtoc --build-all> to update the
539following files:
7277a900 540
f6af4394 541 MANIFEST
f6af4394 542 pod/perl.pod
a2cba4bc
NC
543 win32/pod.mak
544 vms/descrip_mms.template
545
546(F<vms/descrip_mms.template> still needs a manual edit to bump the
547C<perldelta.pod> entry - it would be good for someone to figure out the fix.)
7277a900 548
f6af4394 549and change perlNNNdelta references to the new version in these files
7277a900 550
f6af4394
DM
551 INSTALL
552 win32/Makefile.mk
553 win32/Makefile
554 Makefile.SH
555 README
7277a900 556
f6af4394
DM
557Also, edit the previous delta file to change the C<NAME> from C<perldelta>
558to C<perlNNNdelta>.
7277a900 559
f6af4394
DM
560These two lists of files probably aren't exhaustive; do a recursive grep
561on the previous filename to look for suitable candidates.
7277a900 562
f6af4394 563(see 16410843ea for an example).
7277a900 564
f6af4394 565=item *
7277a900 566
dc0a62a1
DM
567If this was a maintenance release, then edit F<Porting/mergelog> to change
568all the C<d> (deferred) flags to C<.> (needs review).
569
570
571=item *
572
addebd58
DM
573If this was a major release, then
574
575=over
576
577=item *
578
579bump the version, e.g. 5.12.0 to 5.13.0;
580
581=item *
582
583[ XXX probably lots more stuff to do, including perldelta,
f6af4394 584C<lib/feature.pm> ]
7277a900 585
f6af4394 586=item *
7277a900 587
addebd58
DM
588Create a new maint branch with an empty Porting/mergelog file
589[ XXX and lots of other stuff too, probably ]
590
591=back
592
593=item *
594
f6af4394
DM
595Copy the perlNNNdelta.pod for this release into the other branches, and
596remember to update these files on those branches too:
7277a900 597
f6af4394
DM
598 MANIFEST
599 pod.lst
600 pod/perl.pod
601 vms/descrip_mms.template
602 win32/pod.mak
7277a900 603
f6af4394 604(see fc5be80860 for an example).
7277a900 605
f6af4394 606=item *
7277a900 607
f6af4394
DM
608Make sure any recent F<pod/perlhist.pod> entries are copied to
609F<perlhist.pod> on other branches; typically the RC* and final entries,
610e.g.
7277a900 611
f6af4394
DM
612 5.8.9-RC1 2008-Nov-10
613 5.8.9-RC2 2008-Dec-06
614 5.8.9 2008-Dec-14
7277a900 615
6e40fbf9
DM
616=item *
617
618Remind the current maintainer of C<Module::CoreList> to push a new release
619to CPAN.
620
7277a900
GS
621=back
622
623=head1 SOURCE
624
f6af4394
DM
625Based on
626http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2009-05/msg00608.html,
627plus a whole bunch of other sources, including private correspondence.
7277a900
GS
628
629=cut
630