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