This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Correct spelling of LC_MESSAGES
[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
c78277ad
DR
10=head1 MAKING A CHECKLIST
11
12If you are preparing to do a release, you can run the
13F<Porting/make-rmg-checklist> script to generate a new version of this
14document that starts with a checklist for your release.
15
16This script is run as:
17
18 perl Porting/make-rmg-checklist \
19 --type [BLEAD-POINT or MAINT or ...] > /tmp/rmg.pod
20
21You can also pass the C<--html> flag to generate an HTML document instead of
22POD.
f6af4394 23
0056d3d2
DR
24 perl Porting/make-rmg-checklist --html \
25 --type [BLEAD-POINT or MAINT or ...] > /tmp/rmg.html
26
7277a900
GS
27=head1 SYNOPSIS
28
f6af4394 29This document describes the series of tasks required - some automatic, some
dc0a4df9
DM
30manual - to produce a perl release of some description, be that a release
31candidate, or final, numbered release of maint or blead.
f6af4394 32
8c35d285 33The release process has traditionally been executed by the current
ee76d676
JV
34pumpking. Blead releases from 5.11.0 forward are made each month on the
3520th by a non-pumpking release engineer. The release engineer roster
36and schedule can be found in Porting/release_schedule.pod.
7277a900 37
fdaa3f94
CBW
38This document both helps as a check-list for the release engineer
39and is a base for ideas on how the various tasks could be automated
8c35d285 40or distributed.
7277a900 41
da571fa1 42The checklist of a typical release cycle is as follows:
f6af4394 43
636a1918 44 (5.10.1 is released, and post-release actions have been done)
f6af4394
DM
45
46 ...time passes...
47
f6af4394
DM
48 a few weeks before the release, a number of steps are performed,
49 including bumping the version to 5.10.2
636a1918
DM
50
51 ...a few weeks passes...
46743ef7 52
f6af4394
DM
53 perl-5.10.2-RC1 is released
54
55 perl-5.10.2 is released
56
57 post-release actions are performed, including creating new
c5b87fed 58 perldelta.pod
f6af4394
DM
59
60 ... the cycle continues ...
7277a900
GS
61
62=head1 DETAILS
63
6a958a95
DM
64Some of the tasks described below apply to all four types of
65release of Perl. (blead, RC, final release of maint, final
8c35d285 66release of blead). Some of these tasks apply only to a subset
fdaa3f94 67of these release types. If a step does not apply to a given
8c35d285
JV
68type of release, you will see a notation to that effect at
69the beginning of the step.
70
71=head2 Release types
72
73=over 4
74
8c35d285
JV
75=item Release Candidate (RC)
76
d60a1044
DM
77A release candidate is an attempt to produce a tarball that is a close as
78possible to the final release. Indeed, unless critical faults are found
79during the RC testing, the final release will be identical to the RC
80barring a few minor fixups (updating the release date in F<perlhist.pod>,
81removing the RC status from F<patchlevel.h>, etc). If faults are found,
82then the fixes should be put into a new release candidate, never directly
83into a final release.
8c35d285 84
6a958a95
DM
85
86=item Stable/Maint release (MAINT).
87
88A release with an even version number, and subversion number > 0, such as
895.14.1 or 5.14.2.
8c35d285
JV
90
91At this point you should have a working release candidate with few or no
92changes since.
93
94It's essentially the same procedure as for making a release candidate, but
95with a whole bunch of extra post-release steps.
96
74648505
DM
97Note that for a maint release there are two versions of this guide to
98consider: the one in the maint branch, and the one in blead. Which one to
99use is a fine judgement. The blead one will be most up-to-date, while
100it might describe some steps or new tools that aren't applicable to older
101maint branches. It is probably best to review both versions of this
102document, but to most closely follow the steps in the maint version.
103
6a958a95
DM
104=item A blead point release (BLEAD-POINT)
105
106A release with an odd version number, such as 5.15.0 or 5.15.1.
107
108This isn't for production, so it has less stability requirements than for
109other release types, and isn't preceded by RC releases. Other than that,
110it is similar to a MAINT release.
111
112=item Blead final release (BLEAD-FINAL)
113
114A release with an even version number, and subversion number == 0, such as
dc0a4df9 1155.14.0. That is to say, it's the big new release once per year.
8c35d285
JV
116
117It's essentially the same procedure as for making a release candidate, but
6a958a95 118with a whole bunch of extra post-release steps, even more than for MAINT.
8c35d285
JV
119
120=back
7277a900 121
da571fa1 122=for checklist begin
dc0a4df9 123
fd838dcf
JV
124=head2 Prerequisites
125
126Before you can make an official release of perl, there are a few
127hoops you need to jump through:
128
00c28750 129=head3 PAUSE account with pumpkin status
8c35d285 130
fd838dcf
JV
131Make sure you have a PAUSE account suitable for uploading a perl release.
132If you don't have a PAUSE account, then request one:
133
134 https://pause.perl.org/pause/query?ACTION=request_id
135
9a3b7d40
FR
136Check that your account is allowed to upload perl distros: go to
137L<https://pause.perl.org/pause/authenquery?ACTION=who_pumpkin> and check that
138your PAUSE ID is listed there. If not, ask Andreas KE<0xf6>nig to add your ID
139to the list of people allowed to upload something called perl. You can find
140Andreas' email address at:
4d2c8158 141
fd838dcf
JV
142 https://pause.perl.org/pause/query?ACTION=pause_04imprint
143
00c28750 144=head3 search.cpan.org pumpkin status
fdabea7a
JV
145
146Make sure that search.cpan.org knows that you're allowed to upload
147perl distros. Contact Graham Barr to make sure that you're on the right
148list.
149
a72d816c
RS
150=head3 rt.perl.org update access
151
152Make sure you have permission to close tickets on L<http://rt.perl.org/>
153so you can respond to bug report as necessary during your stint. If you
154don't, make an account (if you don't have one) and contact the pumpking
155with your username to get ticket-closing permission.
156
da571fa1 157=head3 git checkout and commit bit
fd838dcf
JV
158
159You will need a working C<git> installation, checkout of the perl
160git repository and perl commit bit. For information about working
c222ef46 161with perl and git, see F<pod/perlgit.pod>.
fd838dcf
JV
162
163If you are not yet a perl committer, you won't be able to make a
164release. Have a chat with whichever evil perl porter tried to talk
165you into the idea in the first place to figure out the best way to
166resolve the issue.
167
845a9291
MM
168=head3 git clone of https://github.com/perlorg/perlweb
169
170For updating the L<http://dev.perl.org> web pages, either a Github account or
171sweet-talking somebody with a Github account into obedience is needed. This
172is only needed on the day of the release or shortly afterwards.
173
da571fa1 174=for checklist skip RC
f6af4394 175
da571fa1 176=head3 Quotation for release announcement epigraph
f6af4394 177
b1288acc 178I<SKIP this step for RC>
f6af4394 179
6a958a95 180For all except an RC release of perl, you will need a quotation
b1288acc 181to use as an epigraph to your release announcement.
46743ef7 182
2e831dfd 183=head2 Building a release - advance actions
8c35d285 184
9c39c536
A
185The work of building a release candidate for an even numbered release
186(BLEAD-FINAL) of perl generally starts several weeks before the first
187release candidate. Some of the following steps should be done regularly,
188but all I<must> be done in the run up to a release.
7277a900 189
dc0a4df9 190=head3 dual-life CPAN module synchronisation
f6af4394 191
1d84c074 192To see which core distro versions differ from the current CPAN versions:
f6af4394 193
1d84c074 194 $ ./perl -Ilib Porting/core-cpan-diff -x -a
7277a900 195
1dbf7599
DG
196However, this only checks whether the version recorded in
197F<Porting/Maintainers.pl> differs from the latest on CPAN. It doesn't tell you
198if the code itself has diverged from CPAN.
7277a900 199
1d84c074
JL
200You can also run an actual diff of the contents of the modules, comparing core
201to CPAN, to ensure that there were no erroneous/extraneous changes that need to
202be dealt with. You do this by not passing the C<-x> option:
7277a900 203
1d84c074
JL
204 $ ./perl -Ilib Porting/core-cpan-diff -a -o /tmp/corediffs
205
1dbf7599
DG
206Passing C<-u cpan> (and maybe C<-u undef>) will probably be helpful, since
207it limits the search to distributions with those upstream sources. (It's
208OK for blead upstream to differ from CPAN because those dual-life releases
209usually come I<after> perl is released.
210
211See also the C<-d> and C<-v> options for more detail (and the C<-u> option as
212mentioned above). You'll probably want to use the C<-c cachedir> option to
213avoid repeated CPAN downloads and may want to use C<-m file:///mirror/path> if
214you made a local CPAN mirror. Note that a minicpan mirror won't actually work,
215but can provide a good first pass to quickly get a list of modules which
216definitely haven't changed, to avoid having to download absolutely everything.
217
218For a BLEAD release with 'cpan' upstream, if a CPAN release appears to be ahead
219of blead, then consider updating it (or asking the relevant porter to do so).
220If blead contains edits to a 'cpan' upstream module, this is naughty but
221sometimes unavoidable to keep blead tests passing. Make sure the affected file
222has a CUSTOMIZED entry in F<Porting/Maintainers.pl>. For 'undef' upstream,
223you'll have to use your judgment for whether any delta should be ignored (like
224'blead' upstream) or treated like a 'cpan' upstream and flagged. Ask around on
225#p5p if you're not sure.
7277a900 226
6a958a95 227If you are making a MAINT release, run C<core-cpan-diff> on both blead and
636a1918
DM
228maint, then diff the two outputs. Compare this with what you expect, and if
229necessary, fix things up. For example, you might think that both blead
230and maint are synchronised with a particular CPAN module, but one might
fdaa3f94 231have some extra changes.
636a1918 232
9c39c536
A
233=head3 How to sync a CPAN module with a cpan/ distro
234
235=over 4
236
237=item *
238
239Fetch the most recent version from CPAN.
240
241=item *
242
243Unpack the retrieved tarball. Rename the old directory; rename the new
244directory to the original name.
245
246=item *
247
9e40a104 248Restore any F<.gitignore> file. This can be done by issuing
02cbdfef 249C<git checkout .gitignore> in the F<cpan/Distro> directory.
9c39c536
A
250
251=item *
252
253Remove files we do not need. That is, remove any files that match the
fdaa3f94 254entries in C<@IGNORE> in F<Porting/Maintainer.pl>, and anything that
9c39c536
A
255matches the C<EXCLUDED> section of the distro's entry in the C<%Modules>
256hash.
257
258=item *
259
260Restore any files mentioned in the C<CUSTOMIZED> section, using
261C<git checkout>. Make any new customizations if necessary. Also,
262restore any files that are mentioned in C<@IGNORE>, but were checked
c5fb089a 263into the repository anyway.
9c39c536
A
264
265=item *
266
267For any new files in the distro, determine whether they are needed.
268If not, delete them, and list them in either C<EXCLUDED> or C<@INGORE>.
269Otherwise, add them to C<MANIFEST>, and run C<git add> to add the files
270to the repository.
271
272=item *
273
274For any files that are gone, remove them from C<MANIFEST>, and use
275C<git rm> to tell git the files will be gone.
276
277=item *
278
279If the C<MANIFEST> file was changed in any of the previous steps, run
280C<perl Porting/manisort --output MANIFEST.sort; mv MANIFEST.sort MANIFEST>.
281
282=item *
283
284For any files that have an execute bit set, either remove the execute
02cbdfef 285bit, or edit F<Porting/exec-bit.txt>
9c39c536
A
286
287=item *
288
0b7399e1 289Run C<make> (or C<nmake> on Windows), see if C<perl> compiles.
9c39c536
A
290
291=item *
292
293Run the tests for the package.
294
295=item *
296
02cbdfef 297Run the tests in F<t/porting>.
9c39c536
A
298
299=item *
300
02cbdfef 301Update the C<DISTRIBUTION> entry in F<Porting/Maintainers.pl>.
9c39c536
A
302
303=item *
304
305Run a full configure/build/test cycle.
306
307=item *
308
309If everything is ok, commit the changes.
310
311=back
312
313For entries with a non-simple C<FILES> section, or with a C<MAP>, you
314may have to take more steps than listed above.
315
02cbdfef 316F<Porting/sync-with-cpan> is a script that automates most of the steps
0b7399e1
SH
317above; but see the comments at the beginning of the file. In particular,
318it has not yet been exercised on Windows, but will certainly require a set
319of Unix tools such as Cygwin, and steps that run C<make> will need to run
320C<nmake> instead.
9c39c536 321
dc0a4df9 322=head3 dual-life CPAN module stability
7277a900 323
f6af4394 324Ensure dual-life CPAN modules are stable, which comes down to:
7277a900
GS
325
326 for each module that fails its regression tests on $current
f6af4394
DM
327 did it fail identically on $previous?
328 if yes, "SEP" (Somebody Else's Problem)
329 else work out why it failed (a bisect is useful for this)
7277a900
GS
330
331 attempt to group failure causes
332
333 for each failure cause
f6af4394
DM
334 is that a regression?
335 if yes, figure out how to fix it
336 (more code? revert the code that broke it)
337 else
338 (presumably) it's relying on something un-or-under-documented
339 should the existing behaviour stay?
340 yes - goto "regression"
341 no - note it in perldelta as a significant bugfix
342 (also, try to inform the module's author)
1aff5354 343
00c28750 344=head3 monitor smoke tests for failures
7277a900 345
5157df7a 346Similarly, monitor the smoking of core tests, and try to fix. See
c840542b
MB
347L<http://doc.procura.nl/smoke/index.html> and L<http://perl5.test-smoke.org/>
348for a summary. See also
5157df7a
AB
349L<http://www.nntp.perl.org/group/perl.daily-build.reports/> which has
350the raw reports.
7277a900 351
636a1918
DM
352Similarly, monitor the smoking of perl for compiler warnings, and try to
353fix.
354
00c28750 355=head3 update perldelta
636a1918 356
f6af4394 357Get perldelta in a mostly finished state.
db3f805e 358
04c2c53e 359Read F<Porting/how_to_write_a_perldelta.pod>, and try to make sure that
636a1918
DM
360every section it lists is, if necessary, populated and complete. Copy
361edit the whole document.
f6af4394 362
1dbf7599
DG
363You won't be able to automatically fill in the "Updated Modules" section until
364after Module::CoreList is updated (as described below in
365L<"update Module::CoreList">).
f6af4394 366
dc0a4df9
DM
367=head3 Bump the version number
368
30f926b5
JL
369Do not do this yet for a BLEAD-POINT release! You will do this at the end of
370the release process.
371
dc0a4df9 372Increase the version number (e.g. from 5.12.0 to 5.12.1).
04dbb930 373
30f926b5 374For a release candidate for a stable perl, this should happen a week or two
04dbb930
DG
375before the first release candidate to allow sufficient time for testing and
376smoking with the target version built into the perl executable. For
c5fb089a 377subsequent release candidates and the final release, it is not necessary to
04dbb930 378bump the version further.
f6af4394 379
8b2227e6 380There is a tool to semi-automate this process:
f6af4394 381
8b2227e6 382 $ ./perl -Ilib Porting/bump-perl-version -i 5.10.0 5.10.1
f6af4394 383
8b2227e6
LB
384Remember that this tool is largely just grepping for '5.10.0' or whatever,
385so it will generate false positives. Be careful not change text like
386"this was fixed in 5.10.0"!
ceb7f800 387
8b2227e6 388Use git status and git diff to select changes you want to keep.
ceb7f800 389
f6af4394
DM
390Be particularly careful with F<INSTALL>, which contains a mixture of
391C<5.10.0>-type strings, some of which need bumping on every release, and
e03f126c
Z
392some of which need to be left unchanged.
393The line in F<INSTALL> about "is binary incompatible with" requires a
394correct choice of earlier version to declare incompatibility with.
395
6a958a95
DM
396When doing a BLEAD-POINT or BLEAD-FINAL release, also make sure the
397C<PERL_API_*> constants in F<patchlevel.h> are in sync with the version
ac2aec01
SH
398you're releasing, unless you're absolutely sure the release you're about to
399make is 100% binary compatible to an earlier release. When releasing a MAINT
400perl version, the C<PERL_API_*> constants C<MUST NOT> be changed as we aim
401to guarantee binary compatibility in maint branches.
45ce9531 402
17163f85
DM
403After editing, regenerate uconfig.h (this must be run on a system with a
404/bin/sh available):
22be9667 405
17163f85 406 $ perl regen/uconfig_h.pl
22be9667 407
78957677
JL
408This might not cause any new changes.
409
22be9667
JV
410Test your changes:
411
17163f85 412 $ git clean -xdf # careful if you don't have local files to keep!
22be9667
JV
413 $ ./Configure -des -Dusedevel
414 $ make
415 $ make test
416
54356a6f
JV
417Commit your changes:
418
04abd20e 419 $ git status
e91bd5c0
LB
420 $ git diff
421 B<review the delta carefully>
54356a6f
JV
422
423 $ git commit -a -m 'Bump the perl version in various places for 5.x.y'
dc0a62a1 424
21768cb3 425At this point you may want to compare the commit with a previous bump to
ac2aec01 426see if they look similar. See commit f7cf42bb69 for an example of a
21768cb3
FC
427previous version bump.
428
dc0a4df9
DM
429When the version number is bumped, you should also update Module::CoreList
430(as described below in L<"update Module::CoreList">) to reflect the new
81fc59ef
DG
431version number.
432
dc0a4df9 433=head3 update INSTALL
dc0a62a1
DM
434
435Review and update INSTALL to account for the change in version number;
436in particular, the "Coexistence with earlier versions of perl 5" section.
437
6a958a95
DM
438Be particularly careful with the section "Upgrading from 5.X.Y or earlier".
439The "X.Y" needs to be changed to the most recent version that we are
440I<not> binary compatible with.
441
442For MAINT and BLEAD-FINAL releases, this needs to refer to the last
443release in the previous development cycle (so for example, for a 5.14.x
444release, this would be 5.13.11).
445
446For BLEAD-POINT releases, it needs to refer to the previous BLEAD-POINT
447release (so for 5.15.3 this would be 5.15.2).
448
dc0a4df9 449=head3 Check more build configurations
b82efa27 450
d8fc5aa0
DR
451Try running the full test suite against multiple Perl configurations. Here are
452some sets of Configure flags you can try:
52a66c2c 453
d8fc5aa0 454=over 4
7277a900 455
d8fc5aa0
DR
456=item *
457
458C<-Duseshrplib -Dusesitecustomize>
459
460=item *
461
462C<-Duserelocatableinc>
463
464=item *
465
466C<-Dusethreads>
467
468=back
7277a900 469
d8fc5aa0
DR
470If you have multiple compilers on your machine, you might also consider
471compiling with C<-Dcc=$other_compiler>.
dc0a4df9
DM
472
473=head3 update perlport
7277a900 474
347f5124
RGS
475L<perlport> has a section currently named I<Supported Platforms> that
476indicates which platforms are known to build in the current release.
477If necessary update the list and the indicated version number.
478
1dbf7599
DG
479=head3 check a readonly build
480
481Even before other prep work, follow the steps in L<build the tarball> and test
482it locally. Because a perl source tarballs sets many files read-only, it could
483test differently than tests run from the repository. After you're sure
484permissions aren't a problem, delete the generated directory and tarballs.
6a958a95 485
2e831dfd
DM
486=head2 Building a release - on the day
487
b1288acc 488This section describes the actions required to make a release
f6b1864d 489that are performed near to, or on the actual release day.
2e831dfd 490
dc0a4df9 491=head3 re-check earlier actions
2e831dfd 492
dc0a4df9 493Review all the actions in the previous section,
2e831dfd
DM
494L<"Building a release - advance actions"> to ensure they are all done and
495up-to-date.
496
ff721450
JL
497=head3 create a release branch
498
499For BLEAD-POINT releases, making a release from a release branch avoids the
500need to freeze blead during the release. This is less important for
501BLEAD-FINAL, MAINT, and RC releases, since blead will already be frozen in
502those cases. Create the branch by running
503
504 git checkout -b release-5.xx.yy
505
dc0a4df9 506=head3 build a clean perl
8c35d285 507
1dbf7599 508Make sure you have a gitwise-clean perl directory (no modified files,
a0db33fe 509unpushed commits etc):
8c35d285 510
a0db33fe 511 $ git status
24c5e187 512 $ git clean -dxf
8c35d285 513
dc0a4df9 514then configure and build perl so that you have a Makefile and porting tools:
8c35d285 515
52a66c2c 516 $ ./Configure -Dusedevel -des && make
8c35d285 517
dc0a4df9 518=head3 update Module::CoreList
8c35d285 519
1bac61bb 520Update C<Module::CoreList> with module version data for the new release.
bfadf2ba 521
6a958a95 522Note that if this is a MAINT release, you should run the following actions
1bac61bb 523from the maint branch, but commit the C<CoreList.pm> changes in
a9d1f3db
LB
524I<blead> and subsequently cherry-pick any releases since the last
525maint release and then your recent commit. XXX need a better example
bfadf2ba 526
89781932
DM
527[ Note that the procedure for handling Module::CoreList in maint branches
528is a bit complex, and the RMG currently don't describe a full and
529workable approach. The main issue is keeping Module::CoreList
530and its version number synchronised across all maint branches, blead and
531CPAN, while having to bump its version number for every RC release.
532See this brief p5p thread:
533
534 Message-ID: <20130311174402.GZ2294@iabyn.com>
535
536If you can devise a workable system, feel free to try it out, and to
38e4b857 537update the RMG accordingly!
89781932
DM
538
539DAPM May 2013 ]
540
541
a0db33fe 542F<corelist.pl> uses ftp.funet.fi to verify information about dual-lived
218a07e7
SH
543modules on CPAN. It can use a full, local CPAN mirror and/or fall back
544on HTTP::Tiny to fetch package metadata remotely.
bfadf2ba 545
fdaa3f94 546(If you'd prefer to have a full CPAN mirror, see
bfadf2ba
JV
547http://www.cpan.org/misc/cpan-faq.html#How_mirror_CPAN)
548
a0db33fe 549Then change to your perl checkout, and if necessary,
bfadf2ba 550
595f83ae 551 $ make
bfadf2ba 552
1dbf7599
DG
553Before updating Module::CoreList, first edit
554F<dist/Module-CoreList/lib/Module/CoreList.pm> and delete any existing
ac2aec01
SH
555entries for this version from the C<%released>, C<%delta> and
556C<%deprecated> hashes: they will have a key like C<5.010001> for 5.10.1.
52a66c2c
DM
557
558XXX the edit-in-place functionality of Porting/corelist.pl should
559be fixed to handle this automatically.
560
bf8ea215 561Then, If you have a local CPAN mirror, run:
bfadf2ba 562
bfadf2ba
JV
563 $ ./perl -Ilib Porting/corelist.pl ~/my-cpan-mirror
564
565Otherwise, run:
566
bfadf2ba
JV
567 $ ./perl -Ilib Porting/corelist.pl cpan
568
52a66c2c 569This will chug for a while, possibly reporting various warnings about
2a720090 570badly-indexed CPAN modules unrelated to the modules actually in core.
2ce7d676 571Assuming all goes well, it will update
ab0bff1f
SH
572F<dist/Module-CoreList/lib/Module/CoreList.pm> and possibly
573F<dist/Module-CoreList/lib/Module/CoreList.pod>.
bfadf2ba 574
ab0bff1f 575Check those files over carefully:
bfadf2ba 576
d5bddf6e 577 $ git diff dist/Module-CoreList/lib/Module/CoreList.pm
ab0bff1f 578 $ git diff dist/Module-CoreList/lib/Module/CoreList.pod
1dbf7599 579
da571fa1
DR
580=head4 Bump C<$Module::CoreList::VERSION>
581
00c28750 582If necessary, bump C<$Module::CoreList::VERSION> (there's no need to do this for
bfadf2ba
JV
583every RC; in RC1, bump the version to a new clean number that will
584appear in the final release, and leave as-is for the later RCs and final).
9709cbd8
FC
585It may also happen that C<Module::CoreList> has been modified in blead, and
586hence has a new version number already. (But make sure it is not the same
587number as a CPAN release.)
bfadf2ba
JV
588
589Edit the version number in the new C<< 'Module::CoreList' => 'X.YZ' >>
590entry, as that is likely to reflect the previous version number.
591
6fb18cd5
FR
592=head4 Bump C<$Module::CoreList::TieHashDelta::VERSION>
593
594C<$Module::CoreList::TieHashDelta::VERSION> should always be equal to
595C<$Module::CoreList::VERSION>. Make sure the two versions match before
596proceeding.
597
03708946
FR
598Edit the version number in the new
599C<< 'Module::CoreList::TieHashDelta' => 'X.YZ' >> entry, as that is likely to
600reflect the previous version number.
601
7ac0c338
CBW
602=head4 Bump C<$Module::CoreList::Utils::VERSION>
603
604C<$Module::CoreList::Utils::VERSION> should always be equal to
605C<$Module::CoreList::VERSION>. Make sure the two versions match before
606proceeding.
607
608Edit the version number in the new
609C<< 'Module::CoreList::Utils' => 'X.YZ' >> entry, as that is likely to
610reflect the previous version number.
611
00c28750
DR
612=head4 Bump version in Module::CoreList F<Changes>
613
cb9af4c0
AB
614Also edit Module::CoreList's new version number in its F<Changes>
615file.
e8c01f92 616
00c28750
DR
617=head4 Add Module::CoreList version bump to perldelta
618
70855f8b
FC
619Add a perldelta entry for the new Module::CoreList version.
620
da571fa1
DR
621=for checklist skip RC
622
48100be1 623=head4 Update C<%Module::CoreList::released> and C<CAVEATS>
da571fa1 624
a0db33fe 625In addition, if this is a final release (rather than a release candidate):
bfadf2ba 626
fdaa3f94 627=over 4
bfadf2ba
JV
628
629=item *
630
631Update this version's entry in the C<%released> hash with today's date.
632
633=item *
634
635Make sure that the script has correctly updated the C<CAVEATS> section
688b7920
A
636(Note, the C<CAVEATS> section is in
637F<dist/Module-CoreList/lib/Module/CoreList.pod>)
bfadf2ba
JV
638
639=back
640
00c28750
DR
641=head4 Commit Module::CoreList changes
642
bfadf2ba 643Finally, commit the new version of Module::CoreList:
6a958a95 644(unless this is for MAINT; in which case commit it to blead first, then
a0db33fe 645cherry-pick it back).
bfadf2ba 646
688b7920 647 $ git commit -m 'Update Module::CoreList for 5.x.y' dist/Module-CoreList/lib/Module/CoreList.pm dist/Module-CoreList/lib/Module/CoreList.pod
bfadf2ba 648
1dbf7599
DG
649=head4 Rebuild and test
650
651Build and test to get the changes into the currently built lib directory and to ensure
652all tests are passing.
653
654=head3 finalize perldelta
655
656Finalize the perldelta. In particular, fill in the Acknowledgements
657section, which can be generated with something like:
658
659 $ perl Porting/acknowledgements.pl v5.15.0..HEAD
660
661Fill in the "Updated Modules" section now that Module::CoreList is updated.
662
663Re-read the perldelta to try to find any embarrassing typos and thinkos;
664remove any C<TODO> or C<XXX> flags; update the "Known Problems" section
665with any serious issues for which fixes are not going to happen now; and
666run through pod and spell checkers, e.g.
667
668 $ podchecker -warnings -warnings pod/perldelta.pod
669 $ spell pod/perldelta.pod
670
671Also, you may want to generate and view an HTML version of it to check
672formatting, e.g.
673
674 $ ./perl -Ilib ext/Pod-Html/bin/pod2html pod/perldelta.pod > /tmp/perldelta.html
675
676Another good HTML preview option is http://search.cpan.org/pod2html
677
678If you make changes, be sure to commit them.
679
680=for checklist skip BLEAD-POINT MAINT RC
681
682=head3 remove stale perldeltas
683
684For the first RC release that is ONLY for a BLEAD-FINAL, the perldeltas
1f6591ac 685from the BLEAD-POINT releases since the previous BLEAD-FINAL should have
1dbf7599
DG
686now been consolidated into the current perldelta, and hence are now just
687useless clutter. They can be removed using:
688
689 $ git rm <file1> <file2> ...
690
691For example, for RC0 of 5.16.0:
692
693 $ cd pod
694 $ git rm perldelta515*.pod
695
1f6591ac 696=for checklist skip BLEAD-FINAL BLEAD-POINT
1dbf7599
DG
697
698=head3 add recent perldeltas
699
700For the first RC for a MAINT release, copy in any recent perldeltas from
701blead that have been added since the last release on this branch. This
702should include any recent maint releases on branches older than your one,
703but not newer. For example if you're producing a 5.14.x release, copy any
704perldeltas from recent 5.10.x, 5.12.x etc maint releases, but not from
7055.16.x or higher. Remember to
706
707 $ git add <file1> <file2> ...
708
709=head3 update and commit perldelta files
710
711If you have added or removed any perldelta files via the previous two
712steps, then edit F<pod/perl.pod> to add/remove them from its table of
713contents, then run F<Porting/pod_rules.pl> to propagate your changes there
714into all the other files that mention them (including F<MANIFEST>). You'll
715need to C<git add> the files that it changes.
716
717Then build a clean perl and do a full test
718
719 $ git status
720 $ git clean -dxf
721 $ ./Configure -Dusedevel -des
722 $ make
723 $ make test
724
725Once all tests pass, commit your changes.
726
727=head3 build a clean perl
728
729If you skipped the previous step (adding/removing perldeltas),
730again, make sure you have a gitwise-clean perl directory (no modified files,
731unpushed commits etc):
732
733 $ git status
734 $ git clean -dxf
735
736then configure and build perl so that you have a Makefile and porting tools:
737
738 $ ./Configure -Dusedevel -des && make
739
1f6591ac 740=for checklist skip BLEAD-FINAL BLEAD-POINT
80dd5f25
DM
741
742=head3 synchronise from blead's perlhist.pod
743
744For the first RC for a MAINT release, copy in the latest
745F<pod/perlhist.pod> from blead; this will include details of newer
746releases in all branches. In theory, blead's version should be a strict
747superset of the one in this branch, but it's probably safest to diff them
748first to ensure that there's nothing in this branch that was forgotten
749from blead:
750
751 $ diff pod/perlhist.pod ..../blead/pod/perlhist.pod
752 $ cp ..../blead/pod/perlhist.pod pod/
753 $ git commit -m 'sync perlhist from blead' pod/perlhist.pod
754
da571fa1 755=for checklist skip RC
dc0a4df9 756
dc0a4df9 757=head3 update perlhist.pod
a0db33fe 758
e8a7a70e 759I<You MUST SKIP this step for a RC release>
a0db33fe 760
e8a7a70e
JV
761Add an entry to F<pod/perlhist.pod> with the release date, e.g.:
762
763 David 5.10.1 2009-Aug-06
a0db33fe
DM
764
765Make sure that the correct pumpking is listed in the left-hand column, and
766if this is the first release under the stewardship of a new pumpking, make
767sure that his or her name is listed in the section entitled
768C<THE KEEPERS OF THE PUMPKIN>.
769
56e2d9fb 770I<If you're making a BLEAD-FINAL release>, also update the "SELECTED
bd4ce907
RS
771RELEASE SIZES" section with the output of
772F<Porting/perlhist_calculate.pl>.
773
a0db33fe
DM
774Be sure to commit your changes:
775
776 $ git commit -m 'add new release to perlhist' pod/perlhist.pod
8c35d285 777
da571fa1 778=for checklist skip BLEAD-POINT
dc0a4df9
DM
779
780=head3 update patchlevel.h
8c35d285 781
6a958a95 782I<You MUST SKIP this step for a BLEAD-POINT release>
d7eb1120 783
a42352ee
DM
784Update F<patchlevel.h> to add a C<-RC1>-or-whatever string; or, if this is
785a final release, remove it. For example:
d7eb1120
DM
786
787 static const char * const local_patches[] = {
788 NULL
789 + ,"RC1"
790 PERL_GIT_UNPUSHED_COMMITS /* do not remove this line */
791
792Be sure to commit your change:
793
794 $ git commit -m 'bump version to RCnnn' patchlevel.h
795
4612967b
CBW
796=head3 run makemeta to update META files
797
e4fbed99 798 $ ./perl -Ilib Porting/makemeta
4612967b
CBW
799
800Be sure to commit any changes (if applicable):
801
e4fbed99 802 $ git status # any changes?
4612967b 803 $ git commit -m 'Update META files' META.*
dc0a4df9
DM
804
805=head3 build, test and check a fresh perl
d7eb1120 806
a0db33fe
DM
807Build perl, then make sure it passes its own test suite, and installs:
808
809 $ git clean -xdf
a42352ee
DM
810 $ ./Configure -des -Dprefix=/tmp/perl-5.x.y-pretest
811
812 # or if it's an odd-numbered version:
a0db33fe 813 $ ./Configure -des -Dusedevel -Dprefix=/tmp/perl-5.x.y-pretest
a42352ee 814
a0db33fe
DM
815 $ make test install
816
52a66c2c
DM
817Check that the output of C</tmp/perl-5.x.y-pretest/bin/perl -v> and
818C</tmp/perl-5.x.y-pretest/bin/perl -V> are as expected,
a0db33fe 819especially as regards version numbers, patch and/or RC levels, and @INC
c5fb089a 820paths. Note that as they have been built from a git working
52a66c2c 821directory, they will still identify themselves using git tags and
01725c10
A
822commits. (Note that for an odd-numbered version, perl will install
823itself as C<perl5.x.y>). C<perl -v> will identify itself as:
824
78957677 825 This is perl 5, version X, subversion Y (v5.X.Y (v5.X.Z-NNN-gdeadbeef))
01725c10 826
78957677 827where 5.X.Z is the latest tag, NNN the number of commits since this tag,
01725c10 828and C<< deadbeef >> commit of that tag.
52a66c2c
DM
829
830Then delete the temporary installation.
831
c90225ed 832=head3 create the release tag
dc0a4df9 833
c90225ed 834Create the tag identifying this release (e.g.):
96054f12 835
b6d23947 836 $ git tag v5.11.0 -m "First release of the v5.11 series!"
e8c01f92 837
6a958a95 838It is B<VERY> important that from this point forward, you not push
f662f3b7
JV
839your git changes to the Perl master repository. If anything goes
840wrong before you publish your newly-created tag, you can delete
841and recreate it. Once you push your tag, we're stuck with it
842and you'll need to use a new version number for your release.
843
dc0a4df9 844=head3 build the tarball
a0db33fe 845
0dcf3caa 846Before you run the following, you might want to install 7-Zip (the
0dcb816b 847C<p7zip-full> package under Debian or the C<p7zip> port on MacPorts) or
0dcf3caa
LB
848the AdvanceCOMP suite (e.g. the C<advancecomp> package under Debian,
849or the C<advancecomp> port on macports - 7-Zip on Windows is the
850same code as AdvanceCOMP, so Windows users get the smallest files
851first time). These compress about 5% smaller than gzip and bzip2.
852Over the lifetime of your distribution this will save a lot of
853people a small amount of download time and disk space, which adds
854up.
855
8c35d285
JV
856Create a tarball. Use the C<-s> option to specify a suitable suffix for
857the tarball and directory name:
858
859 $ cd root/of/perl/tree
860 $ make distclean
75a012fe
DM
861 $ git clean -xdf # make sure perl and git agree on files
862 $ git status # and there's nothing lying around
8c35d285 863
8c35d285
JV
864 $ perl Porting/makerel -b -s RC1 # for a release candidate
865 $ perl Porting/makerel -b # for a final release
866
867This creates the directory F<../perl-x.y.z-RC1> or similar, copies all
ac2aec01
SH
868the MANIFEST files into it, sets the correct permissions on them, then
869tars it up as F<../perl-x.y.z-RC1.tar.gz>. With C<-b>, it also creates a
870C<tar.bz2> file.
8c35d285 871
6480287f
MT
872If you're getting your tarball suffixed with -uncommitted and you're sure
873your changes were all committed, you can override the suffix with:
874
875 $ perl Porting/makerel -b -s ''
96054f12 876
8c35d285
JV
877XXX if we go for extra tags and branches stuff, then add the extra details
878here
879
dc0a4df9 880Finally, clean up the temporary directory, e.g.
a42352ee
DM
881
882 $ rm -rf ../perl-x.y.z-RC1
883
dc0a4df9
DM
884=head3 test the tarball
885
00c28750 886Once you have a tarball it's time to test the tarball (not the repository).
dc0a4df9 887
00c28750 888=head4 Copy the tarball to a web server
a42352ee 889
8c35d285
JV
890Copy the tarballs (.gz and possibly .bz2) to a web server somewhere you
891have access to.
892
00c28750 893=head4 Download the tarball to another machine
8c35d285 894
fdaa3f94 895Download the tarball to some other machine. For a release candidate,
8c35d285
JV
896you really want to test your tarball on two or more different platforms
897and architectures. The #p5p IRC channel on irc.perl.org is a good place
898to find willing victims.
899
00c28750 900=head4 Check that F<Configure> works
8c35d285
JV
901
902Check that basic configuration and tests work on each test machine:
903
904 $ ./Configure -des && make all test
f6af4394 905
00c28750 906=head4 Run the test harness and install
f6af4394 907
8c35d285
JV
908Check that the test harness and install work on each test machine:
909
a42352ee 910 $ make distclean
8c35d285 911 $ ./Configure -des -Dprefix=/install/path && make all test_harness install
a42352ee 912 $ cd /install/path
8c35d285 913
00c28750 914=head4 Check C<perl -v> and C<perl -V>
8c35d285
JV
915
916Check that the output of C<perl -v> and C<perl -V> are as expected,
917especially as regards version numbers, patch and/or RC levels, and @INC
fdaa3f94 918paths.
8c35d285
JV
919
920Note that the results may be different without a F<.git/> directory,
921which is why you should test from the tarball.
922
00c28750 923=head4 Run the Installation Verification Procedure utility
459fc3ca 924
9651cacc 925 $ ./perl utils/perlivp
459fc3ca
DM
926 ...
927 All tests successful.
928 $
929
00c28750 930=head4 Compare the installed paths to the last release
459fc3ca 931
d60a1044
DM
932Compare the pathnames of all installed files with those of the previous
933release (i.e. against the last installed tarball on this branch which you
934have previously verified using this same procedure). In particular, look
935for files in the wrong place, or files no longer included which should be.
936For example, suppose the about-to-be-released version is 5.10.1 and the
937previous is 5.10.0:
938
939 cd installdir-5.10.0/
940 find . -type f | perl -pe's/5\.10\.0/5.10.1/g' | sort > /tmp/f1
941 cd installdir-5.10.1/
942 find . -type f | sort > /tmp/f2
943 diff -u /tmp/f[12]
944
29205e9c 945=head4 Bootstrap the CPAN client
d60a1044 946
8c35d285
JV
947Bootstrap the CPAN client on the clean install:
948
29205e9c 949 $ bin/cpan
8c35d285 950
29205e9c 951=head4 Install the Inline module with CPAN and test it
8c35d285 952
a42352ee
DM
953Try installing a popular CPAN module that's reasonably complex and that
954has dependencies; for example:
8c35d285 955
a42352ee
DM
956 CPAN> install Inline
957 CPAN> quit
8c35d285
JV
958
959Check that your perl can run this:
960
16c60e4e 961 $ bin/perl -lwe "use Inline C => q[int f() { return 42;}]; print f"
a42352ee
DM
962 42
963 $
8c35d285 964
00c28750 965=head4 Make sure that perlbug works
8c35d285 966
00c28750 967Test L<perlbug> with the following:
47b1f096 968
a14438df 969 $ bin/perlbug
47b1f096
DM
970 ...
971 Subject: test bug report
fdaa3f94
CBW
972 Local perl administrator [yourself]:
973 Editor [vi]:
974 Module:
975 Category [core]:
976 Severity [low]:
47b1f096
DM
977 (edit report)
978 Action (Send/Display/Edit/Subject/Save to File): f
fdaa3f94 979 Name of file to save message in [perlbug.rep]:
47b1f096
DM
980 Action (Send/Display/Edit/Subject/Save to File): q
981
982and carefully examine the output (in F<perlbug.rep]>), especially
983the "Locally applied patches" section. If everything appears okay, then
75a012fe
DM
984delete the file, and try it again, this time actually submitting the bug
985report. Check that it shows up, then remember to close it!
47b1f096 986
da571fa1 987=for checklist skip BLEAD-POINT
dc0a4df9
DM
988
989=head3 monitor smokes
47b1f096 990
1dbf7599
DG
991XXX This is probably irrelevant if working on a release branch, though
992MAINT or RC might want to push a smoke branch and wait.
993
f6af4394
DM
994Wait for the smoke tests to catch up with the commit which this release is
995based on (or at least the last commit of any consequence).
7277a900 996
f6af4394
DM
997Then check that the smoke tests pass (particularly on Win32). If not, go
998back and fix things.
7277a900 999
6a958a95 1000Note that for I<BLEAD-POINT> releases this may not be practical. It takes a
1eefd7d5 1001long time for the smokers to catch up, especially the Win32
6a958a95
DM
1002smokers. This is why we have a RC cycle for I<MAINT> and I<BLEAD-FINAL>
1003releases, but for I<BLEAD-POINT> releases sometimes the best you can do is
1004to plead with people on IRC to test stuff on their platforms, fire away,
1005and then hope for the best.
7277a900 1006
dc0a4df9 1007=head3 upload to PAUSE
7277a900 1008
f6af4394 1009Once smoking is okay, upload it to PAUSE. This is the point of no return.
db3f805e
JV
1010If anything goes wrong after this point, you will need to re-prepare
1011a new release with a new minor version or RC number.
1012
a14438df
DM
1013 https://pause.perl.org/
1014
1015(Login, then select 'Upload a file to CPAN')
1016
45924287
RS
1017If your workstation is not connected to a high-bandwidth,
1018high-reliability connection to the Internet, you should probably use the
1019"GET URL" feature (rather than "HTTP UPLOAD") to have PAUSE retrieve the
1020new release from wherever you put it for testers to find it. This will
1021eliminate anxious gnashing of teeth while you wait to see if your
102215 megabyte HTTP upload successfully completes across your slow, twitchy
c27b4e97
SH
1023cable modem. You can make use of your home directory on dromedary for
1024this purpose: F<http://users.perl5.git.perl.org/~USERNAME> maps to
1025F</home/USERNAME/public_html>, where F<USERNAME> is your login account
1026on dromedary. I<Remember>: if your upload is partially successful, you
1027may need to contact a PAUSE administrator or even bump the version of perl.
45924287 1028
a42352ee 1029Upload both the .gz and .bz2 versions of the tarball.
f6af4394 1030
1dbf7599
DG
1031Do not proceed any further until you are sure that your tarballs are on CPAN.
1032Check your authors directory www.cpan.org (the globally balanced "fast"
1033mirror) to confirm that your uploads have been successful.
c27b4e97 1034
1dbf7599 1035=for checklist skip RC BLEAD-POINT
00c28750
DR
1036
1037=head3 wait for indexing
1038
1dbf7599 1039I<You MUST SKIP this step for RC and BLEAD-POINT>
76526317
FR
1040
1041Wait until you receive notification emails from the PAUSE indexer
1042confirming that your uploads have been received. IMPORTANT -- you will
1043probably get an email that indexing has failed, due to module permissions.
1044This is considered normal.
1045
da571fa1 1046=for checklist skip BLEAD-POINT
dc0a4df9
DM
1047
1048=head3 disarm patchlevel.h
f6af4394 1049
6a958a95 1050I<You MUST SKIP this step for BLEAD-POINT release>
113f3f4c 1051
a42352ee 1052Disarm the F<patchlevel.h> change; for example,
d7eb1120
DM
1053
1054 static const char * const local_patches[] = {
1055 NULL
1056 - ,"RC1"
1057 PERL_GIT_UNPUSHED_COMMITS /* do not remove this line */
1058
1059Be sure to commit your change:
1060
1061 $ git commit -m 'disarm RCnnn bump' patchlevel.h
dc0a4df9
DM
1062
1063=head3 announce to p5p
2e831dfd 1064
db3f805e 1065Mail p5p to announce your new release, with a quote you prepared earlier.
f6af4394 1066
098d30ef 1067Use the template at Porting/release_announcement_template.txt
dc0a4df9 1068
a8cecd9d
RS
1069Send a carbon copy to C<noc@metacpan.org>
1070
ff721450
JL
1071=head3 merge release branch back to blead
1072
c90225ed 1073Merge the (local) release branch back into master now, and delete it.
ff721450
JL
1074
1075 git checkout blead
1076 git pull
1077 git merge release-5.xx.yy
1078 git push
ff721450
JL
1079 git branch -d release-5.xx.yy
1080
c90225ed
SH
1081=head3 publish the release tag
1082
1083Now that you've shipped the new perl release to PAUSE and pushed your changes
1084to the Perl master repository, it's time to publish the tag you created
1085earlier too (e.g.):
1086
1087 $ git push origin tag v5.11.0
1088
dc0a4df9 1089=head3 update epigraphs.pod
f6af4394 1090
85531b0a 1091Add your quote to F<Porting/epigraphs.pod> and commit it.
606d51b7
Z
1092Your release announcement will probably not have reached the web-visible
1093archives yet, so you won't be able to include the customary link to the
1094release announcement yet.
dc0a4df9 1095
b02b3ec7
DR
1096=head3 blog about your epigraph
1097
1098If you have a blog, please consider writing an entry in your blog explaining
1099why you chose that particular quote for your epigraph.
1100
da571fa1
DR
1101=for checklist skip RC
1102
dc0a4df9 1103=head3 Module::CoreList nagging
85531b0a 1104
bc4c40f2 1105I<You MUST SKIP this step for RC>
8c35d285 1106
75a012fe
DM
1107Remind the current maintainer of C<Module::CoreList> to push a new release
1108to CPAN.
7277a900 1109
da571fa1 1110=for checklist skip RC
dc0a4df9
DM
1111
1112=head3 new perldelta
a2cba4bc 1113
bc4c40f2 1114I<You MUST SKIP this step for RC>
7277a900 1115
bcfe7366 1116Create a new perldelta.
5ef3945b 1117
bcfe7366 1118=over 4
8e967a1c 1119
bcfe7366 1120=item *
8e967a1c 1121
bcfe7366 1122Confirm that you have a clean checkout with no local changes.
c5b87fed 1123
bcfe7366 1124=item *
17163f85 1125
bcfe7366 1126Run F<Porting/new-perldelta.pl>
8e967a1c 1127
bcfe7366 1128=item *
17163f85 1129
bcfe7366 1130Run the C<git add> commands it outputs to add new and modified files.
7277a900 1131
bcfe7366 1132=item *
7277a900 1133
bcfe7366 1134Verify that the build still works, by running C<./Configure> and
e0373c35 1135C<make test_porting>. (On Win32 use the appropriate make utility).
17163f85 1136
bcfe7366 1137=item *
17163f85 1138
bcfe7366
NC
1139If F<t/porting/podcheck.t> spots errors in the new F<pod/perldelta.pod>,
1140run C<./perl -MTestInit t/porting/podcheck.t | less> for more detail.
1141Skip to the end of its test output to see the options it offers you.
57433fbf 1142
bcfe7366 1143=item *
75a012fe 1144
bcfe7366 1145When C<make test_porting> passes, commit the new perldelta.
75a012fe 1146
bcfe7366 1147=back
75a012fe 1148
21768cb3 1149At this point you may want to compare the commit with a previous bump to
ac2aec01 1150see if they look similar. See commit ba03bc34a4 for an example of a
75a012fe 1151previous version bump.
57433fbf 1152
30f926b5 1153=for checklist skip MAINT RC
dc0a4df9
DM
1154
1155=head3 bump version
57433fbf 1156
30f926b5 1157I<You MUST SKIP this step for RC and MAINT>
dc0a62a1 1158
6a958a95
DM
1159If this was a BLEAD-FINAL release (i.e. the first release of a new maint
1160series, 5.x.0 where x is even), then bump the version in the blead branch
1161in git, e.g. 5.12.0 to 5.13.0.
17163f85 1162
6d5e92cd
FC
1163First, add a new feature bundle to F<regen/feature.pl>, initially by just
1164copying the exiting entry, and bump the file's $VERSION (after the __END__
1165marker); e.g.
17163f85
DM
1166
1167 "5.14" => [qw(switch say state unicode_strings)],
1168 + "5.15" => [qw(switch say state unicode_strings)],
addebd58 1169
57fef7cc
FC
1170Run F<regen/feature.pl> to propagate the changes to F<lib/feature.pm>.
1171
dc0a4df9
DM
1172Then follow the section L<"Bump the version number"> to bump the version
1173in the remaining files and test and commit.
17163f85 1174
30f926b5
JL
1175If this was a BLEAD-POINT release, then just follow the section
1176L<"Bump the version number">.
1177
2136887a
DG
1178After bumping the version, follow the section L<"update INSTALL"> to
1179ensure all version number references are correct.
17163f85 1180
d5c37431
NC
1181=head3 clean build and test
1182
1183Run a clean build and test to make sure nothing obvious is broken.
1184
1185In particular, F<Porting/perldelta_template.pod> is intentionally exempted
1186from podchecker tests, to avoid false positives about placeholder text.
1187However, once it's copied to F<pod/perldelta.pod> the contents can now
ef4474b5
KW
1188cause test failures. Problems should resolved by doing one of the
1189following:
1190
1191=over
1192
1193=item 1
1194
1195Replace placeholder text with correct text.
1196
1197=item 2
1198
1199If the problem is from a broken placeholder link, you can add it to the
1200array C<@perldelta_ignore_links> in F<t/porting/podcheck.t>. Lines
1201containing such links should be marked with C<XXX> so that they get
1202cleaned up before the next release.
1203
1204=item 3
1205
1206Following the instructions output by F<t/porting/podcheck.t> on how to
1207update its exceptions database.
1208
1209=back
d5c37431 1210
dc0a4df9
DM
1211=head3 push commits
1212
1213Finally, push any commits done above.
1214
1215 $ git push origin ....
1216
da571fa1 1217=for checklist skip BLEAD-POINT MAINT RC
dc0a4df9
DM
1218
1219=head3 create maint branch
17163f85 1220
6a958a95 1221I<You MUST SKIP this step for RC, BLEAD-POINT, MAINT>
17163f85 1222
6a958a95
DM
1223If this was a BLEAD-FINAL release (i.e. the first release of a new maint
1224series, 5.x.0 where x is even), then create a new maint branch based on
1225the commit tagged as the current release.
7277a900 1226
233ca920
JV
1227Assuming you're using git 1.7.x or newer:
1228
17163f85 1229 $ git checkout -b maint-5.12 v5.12.0
233ca920 1230 $ git push origin -u maint-5.12
addebd58 1231
dc0a4df9 1232
da571fa1
DR
1233=for checklist skip BLEAD-POINT MAINT RC
1234
d5722260
DK
1235=head3 make the maint branch available in the APC
1236
1237Clone the new branch into /srv/gitcommon/branches on camel so the APC will
1238receive its changes.
1239
07697565 1240 $ git clone --branch maint-5.14 /gitroot/perl.git \
d5722260 1241 ? /srv/gitcommon/branches/perl-5.14.x
07697565 1242 $ chmod -R g=u /srv/gitcommon/branches/perl-5.14.x
d5722260
DK
1243
1244And nag the sysadmins to make this directory available via rsync.
1245
1dbf7599
DG
1246XXX Who are the sysadmins? Contact info?
1247
da571fa1 1248=for checklist skip BLEAD-POINT RC
d5722260 1249
f6b1864d 1250=head3 copy perldelta.pod to blead
addebd58 1251
6a958a95 1252I<You MUST SKIP this step for RC, BLEAD-POINT>
8c35d285 1253
f6b1864d 1254Copy the perldelta.pod for this release into blead; for example:
7277a900 1255
f6b1864d 1256 $ cd ..../blead
c5b87fed 1257 $ cp -i ../5.10.x/pod/perldelta.pod pod/perl5101delta.pod # for example
75a012fe
DM
1258 $ git add pod/perl5101delta.pod
1259
0aef0fe5 1260Edit F<pod/perl.pod> to add an entry for the file, e.g.:
75a012fe
DM
1261
1262 perl5101delta Perl changes in version 5.10.1
bc4c40f2 1263
75a012fe 1264Then rebuild various files:
7277a900 1265
00b85c8d 1266 $ perl Porting/pod_rules.pl
75a012fe 1267
c90225ed 1268Finally, commit and push:
75a012fe
DM
1269
1270 $ git commit -a -m 'add perlXXXdelta'
c90225ed 1271 $ git push origin ....
dc0a4df9 1272
819435de 1273=for checklist skip BLEAD-POINT
7277a900 1274
819435de 1275=head3 copy perlhist.pod entries to blead
1dbf7599 1276
f6af4394 1277Make sure any recent F<pod/perlhist.pod> entries are copied to
80dd5f25 1278F<perlhist.pod> on blead. e.g.
7277a900 1279
f6af4394 1280 5.8.9 2008-Dec-14
7277a900 1281
dc0a4df9 1282=head3 bump RT version number
6e40fbf9 1283
7c139051 1284Log into http://rt.perl.org/ and check whether the new version is in the RT
1dbf7599
DG
1285fields C<Perl Version> and C<Fixed In>. The easiest way to determine this is to
1286open up any ticket for modification and check the drop downs next to the
1287C<Perl Version> and C<Fixed In> labels.
7c139051
DR
1288
1289If the new version is not listed there, send an email to C<perlbug-admin at
1290perl.org> requesting this.
dc0a4df9
DM
1291
1292=head3 Relax!
a3738a12 1293
bc4c40f2
JV
1294I<You MUST RETIRE to your preferred PUB, CAFE or SEASIDE VILLA for some
1295much-needed rest and relaxation>.
8c35d285
JV
1296
1297Thanks for releasing perl!
1298
b28f69c2
Z
1299=head2 Building a release - the day after
1300
606d51b7
Z
1301=head3 link announcement in epigraphs.pod
1302
1303Add, to your quote to F<Porting/epigraphs.pod>, a link to the release
1304announcement in the web-visible mailing list archive. Commit it.
1305
ab0bff1f 1306=for checklist skip BLEAD-FINAL, MAINT, RC
042e7a25 1307
ab0bff1f 1308=head3 update Module::CoreList
042e7a25
DG
1309
1310I<After a BLEAD-POINT release only>
1311
1312After Module::CoreList has shipped to CPAN by the maintainer, update
1313Module::CoreList in the source so that it reflects the new blead
ab0bff1f
SH
1314version number:
1315
1316=over 4
1317
1318=item *
1319
1320Update F<Porting/Maintainers.pl> to list the new DISTRIBUTION on CPAN,
1321which should be identical to what is currently in blead.
1322
1323=item *
1324
1325Bump the $VERSION in F<dist/Module-CoreList/lib/Module/CoreList.pm>,
1326F<dist/Module-CoreList/lib/Module/CoreList/TieHashDelta.pm> and
1327F<dist/Module-CoreList/lib/Module/CoreList/Utils.pm>.
1328
1329=item *
1330
1331If you have a local CPAN mirror, run:
1332
1333 $ ./perl -Ilib Porting/corelist.pl ~/my-cpan-mirror
1334
1335Otherwise, run:
1336
1337 $ ./perl -Ilib Porting/corelist.pl cpan
1338
1339This will update F<dist/Module-CoreList/lib/Module/CoreList.pm> and
1340F<dist/Module-CoreList/lib/Module/CoreList.pod> as it did before, but
1341this time adding new sections for the next BLEAD-POINT release.
1342
1343=item *
1344
1345Manually edit F<dist/Module-CoreList/lib/Module/CoreList/Utils.pm> to
1346add a similar entry for that up-coming version to C<%delta>.
1347
1348XXX Porting/corelist.pl should have done that itself.
1349
1350=item *
1351
1352Add the new $Module::CoreList::VERSION to
1353F<dist/Module-CoreList/Changes>.
1354
1355=item *
1356
1357Update F<pod/perldelta.pod> to mention the upgrade to Module::CoreList.
1358
1359=item *
1360
1361Remake perl to get your changed .pm files propagated into F<lib/> and
1362then run at least the F<dist/Module-CoreList/t/*.t> tests and the
1363test_porting makefile target to check that they're ok.
1364
1365=item *
1366
1367Run
1368
1369 $ ./perl -Ilib -MModule::CoreList -le 'print Module::CoreList->find_version($]) ? "ok" : "not ok"'
1370
1371and check that it outputs "ok" to prove that Module::CoreList now knows
1372about blead's current version.
1373
1374=item *
1375
1376Commit and push your changes.
1377
1378=back
042e7a25 1379
dc0a4df9
DM
1380=head3 check tarball availability
1381
1382Check various website entries to make sure the that tarball has appeared
1383and is properly indexed:
1384
b28f69c2
Z
1385=over 4
1386
1387=item *
1388
98df743a
Z
1389Check your author directory under L<http://www.cpan.org/authors/id/>
1390to ensure that the tarballs are available on the website.
b28f69c2
Z
1391
1392=item *
1393
98df743a 1394Check C</src> on CPAN (on a fast mirror) to ensure that links to
ac2aec01
SH
1395the new tarballs have appeared: There should be links in C</src/5.0>
1396(which is accumulating all new versions), and (for BLEAD-FINAL and
1397MAINT only) an appropriate mention in C</src/README.html> (which describes
1398the latest versions in each stable branch, with links).
98df743a 1399
1dbf7599 1400The C</src/5.0> links should appear automatically, some hours after upload.
02e2c3c0 1401If they don't, or the C</src> description is inadequate,
98df743a 1402ask Ask <ask@perl.org>.
b28f69c2
Z
1403
1404=item *
1405
98df743a
Z
1406Check L<http://www.cpan.org/src/> to ensure that the C</src> updates
1407have been correctly mirrored to the website.
1408If they haven't, ask Ask <ask@perl.org>.
1409
1410=item *
b28f69c2 1411
98df743a
Z
1412Check L<http://search.cpan.org> to see if it has indexed the distribution.
1413It should be visible at a URL like C<http://search.cpan.org/dist/perl-5.10.1/>.
b28f69c2 1414
dc0a4df9 1415=back
b28f69c2 1416
e7b51df1 1417=for checklist skip RC
dc0a4df9
DM
1418
1419=head3 update dev.perl.org
1420
e7b51df1 1421I<You MUST SKIP this step for a RC release>
98df743a 1422
5fbaa27a 1423In your C<perlweb> repository, link to the new release. For a new
7a664ed5
RS
1424latest-maint release, edit F<docs/shared/tpl/stats.html>. Otherwise,
1425edit F<docs/dev/perl5/index.html>.
1426
1427Then make a pull request to Leo Lapworth. If this fails for some reason
1428and you cannot cajole anybody else into submitting that change, you can
1429mail Leo as last resort.
b28f69c2 1430
7dbb22ac
A
1431This repository can be found on L<github|https://github.com/perlorg/perlweb>.
1432
1dbf7599
DG
1433=head3 update release manager's guide
1434
1435Go over your notes from the release (you did take some, right?) and update
1436F<Porting/release_managers_guide.pod> with any fixes or information that
1437will make life easier for the next release manager.
1438
da571fa1 1439=for checklist end
b28f69c2 1440
7277a900
GS
1441=head1 SOURCE
1442
f6af4394
DM
1443Based on
1444http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2009-05/msg00608.html,
1445plus a whole bunch of other sources, including private correspondence.
7277a900
GS
1446
1447=cut
1448