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