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