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