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