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