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