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