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