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 | ||
f6af4394 | 10 | |
7277a900 GS |
11 | =head1 SYNOPSIS |
12 | ||
f6af4394 | 13 | This document describes the series of tasks required - some automatic, some |
dc0a4df9 DM |
14 | manual - to produce a perl release of some description, be that a release |
15 | candidate, or final, numbered release of maint or blead. | |
f6af4394 | 16 | |
8c35d285 | 17 | The release process has traditionally been executed by the current |
ee76d676 JV |
18 | pumpking. Blead releases from 5.11.0 forward are made each month on the |
19 | 20th by a non-pumpking release engineer. The release engineer roster | |
20 | and schedule can be found in Porting/release_schedule.pod. | |
7277a900 | 21 | |
8c35d285 JV |
22 | This document both helps as a check-list for the release engineer |
23 | and is a base for ideas on how the various tasks could be automated | |
24 | or distributed. | |
7277a900 | 25 | |
636a1918 | 26 | The outline of a typical release cycle is as follows: |
f6af4394 | 27 | |
636a1918 | 28 | (5.10.1 is released, and post-release actions have been done) |
f6af4394 DM |
29 | |
30 | ...time passes... | |
31 | ||
f6af4394 DM |
32 | a few weeks before the release, a number of steps are performed, |
33 | including bumping the version to 5.10.2 | |
636a1918 DM |
34 | |
35 | ...a few weeks passes... | |
46743ef7 | 36 | |
f6af4394 DM |
37 | perl-5.10.2-RC1 is released |
38 | ||
39 | perl-5.10.2 is released | |
40 | ||
41 | post-release actions are performed, including creating new | |
c5b87fed | 42 | perldelta.pod |
f6af4394 DM |
43 | |
44 | ... the cycle continues ... | |
7277a900 | 45 | |
dc0a4df9 | 46 | |
7277a900 GS |
47 | =head1 DETAILS |
48 | ||
6a958a95 DM |
49 | Some of the tasks described below apply to all four types of |
50 | release of Perl. (blead, RC, final release of maint, final | |
8c35d285 JV |
51 | release of blead). Some of these tasks apply only to a subset |
52 | of these release types. If a step does not apply to a given | |
53 | type of release, you will see a notation to that effect at | |
54 | the beginning of the step. | |
55 | ||
dc0a4df9 | 56 | |
8c35d285 JV |
57 | =head2 Release types |
58 | ||
59 | =over 4 | |
60 | ||
8c35d285 JV |
61 | =item Release Candidate (RC) |
62 | ||
d60a1044 DM |
63 | A release candidate is an attempt to produce a tarball that is a close as |
64 | possible to the final release. Indeed, unless critical faults are found | |
65 | during the RC testing, the final release will be identical to the RC | |
66 | barring a few minor fixups (updating the release date in F<perlhist.pod>, | |
67 | removing the RC status from F<patchlevel.h>, etc). If faults are found, | |
68 | then the fixes should be put into a new release candidate, never directly | |
69 | into a final release. | |
8c35d285 | 70 | |
6a958a95 DM |
71 | |
72 | =item Stable/Maint release (MAINT). | |
73 | ||
74 | A release with an even version number, and subversion number > 0, such as | |
75 | 5.14.1 or 5.14.2. | |
8c35d285 JV |
76 | |
77 | At this point you should have a working release candidate with few or no | |
78 | changes since. | |
79 | ||
80 | It's essentially the same procedure as for making a release candidate, but | |
81 | with a whole bunch of extra post-release steps. | |
82 | ||
6a958a95 DM |
83 | =item A blead point release (BLEAD-POINT) |
84 | ||
85 | A release with an odd version number, such as 5.15.0 or 5.15.1. | |
86 | ||
87 | This isn't for production, so it has less stability requirements than for | |
88 | other release types, and isn't preceded by RC releases. Other than that, | |
89 | it is similar to a MAINT release. | |
90 | ||
91 | =item Blead final release (BLEAD-FINAL) | |
92 | ||
93 | A release with an even version number, and subversion number == 0, such as | |
dc0a4df9 | 94 | 5.14.0. That is to say, it's the big new release once per year. |
8c35d285 JV |
95 | |
96 | It's essentially the same procedure as for making a release candidate, but | |
6a958a95 | 97 | with a whole bunch of extra post-release steps, even more than for MAINT. |
8c35d285 JV |
98 | |
99 | =back | |
7277a900 | 100 | |
dc0a4df9 | 101 | |
fd838dcf JV |
102 | =head2 Prerequisites |
103 | ||
104 | Before you can make an official release of perl, there are a few | |
105 | hoops you need to jump through: | |
106 | ||
107 | =over 4 | |
108 | ||
8c35d285 JV |
109 | =item PAUSE account |
110 | ||
fd838dcf JV |
111 | Make sure you have a PAUSE account suitable for uploading a perl release. |
112 | If you don't have a PAUSE account, then request one: | |
113 | ||
114 | https://pause.perl.org/pause/query?ACTION=request_id | |
115 | ||
9a3b7d40 FR |
116 | Check that your account is allowed to upload perl distros: go to |
117 | L<https://pause.perl.org/pause/authenquery?ACTION=who_pumpkin> and check that | |
118 | your PAUSE ID is listed there. If not, ask Andreas KE<0xf6>nig to add your ID | |
119 | to the list of people allowed to upload something called perl. You can find | |
120 | Andreas' email address at: | |
4d2c8158 | 121 | |
fd838dcf JV |
122 | https://pause.perl.org/pause/query?ACTION=pause_04imprint |
123 | ||
fdabea7a JV |
124 | =item search.cpan.org |
125 | ||
126 | Make sure that search.cpan.org knows that you're allowed to upload | |
127 | perl distros. Contact Graham Barr to make sure that you're on the right | |
128 | list. | |
129 | ||
8c35d285 JV |
130 | =item CPAN mirror |
131 | ||
132 | Some release engineering steps require a full mirror of the CPAN. | |
133 | Work to fall back to using a remote mirror via HTTP is incomplete | |
134 | but ongoing. (No, a minicpan mirror is not sufficient) | |
135 | ||
136 | =item git checkout and commit bit | |
fd838dcf JV |
137 | |
138 | You will need a working C<git> installation, checkout of the perl | |
139 | git repository and perl commit bit. For information about working | |
c222ef46 | 140 | with perl and git, see F<pod/perlgit.pod>. |
fd838dcf JV |
141 | |
142 | If you are not yet a perl committer, you won't be able to make a | |
143 | release. Have a chat with whichever evil perl porter tried to talk | |
144 | you into the idea in the first place to figure out the best way to | |
145 | resolve the issue. | |
146 | ||
f6af4394 | 147 | |
8c35d285 | 148 | =item Quotation for release announcement epigraph |
f6af4394 | 149 | |
b1288acc | 150 | I<SKIP this step for RC> |
f6af4394 | 151 | |
6a958a95 | 152 | For all except an RC release of perl, you will need a quotation |
b1288acc | 153 | to use as an epigraph to your release announcement. |
46743ef7 | 154 | |
f6af4394 DM |
155 | |
156 | =back | |
157 | ||
b82efa27 | 158 | |
2e831dfd | 159 | =head2 Building a release - advance actions |
8c35d285 JV |
160 | |
161 | The work of building a release candidate for a numbered release of | |
162 | perl generally starts several weeks before the first release candidate. | |
52a66c2c DM |
163 | Some of the following steps should be done regularly, but all I<must> be |
164 | done in the run up to a release. | |
7277a900 | 165 | |
7277a900 | 166 | |
dc0a4df9 | 167 | =head3 dual-life CPAN module synchronisation |
f6af4394 | 168 | |
f6af4394 DM |
169 | Ensure that dual-life CPAN modules are synchronised with CPAN. Basically, |
170 | run the following: | |
171 | ||
db3f805e | 172 | $ ./perl -Ilib Porting/core-cpan-diff -a -o /tmp/corediffs |
7277a900 | 173 | |
f6af4394 DM |
174 | to see any inconsistencies between the core and CPAN versions of distros, |
175 | then fix the core, or cajole CPAN authors as appropriate. See also the | |
176 | C<-d> and C<-v> options for more detail. You'll probably want to use the | |
04dbb930 DG |
177 | C<-c cachedir> option to avoid repeated CPAN downloads and may want to |
178 | use C<-m file:///mirror/path> if you made a local CPAN mirror. | |
7277a900 | 179 | |
f6af4394 | 180 | To see which core distro versions differ from the current CPAN versions: |
7277a900 | 181 | |
db3f805e | 182 | $ ./perl -Ilib Porting/core-cpan-diff -x -a |
7277a900 | 183 | |
6a958a95 | 184 | If you are making a MAINT release, run C<core-cpan-diff> on both blead and |
636a1918 DM |
185 | maint, then diff the two outputs. Compare this with what you expect, and if |
186 | necessary, fix things up. For example, you might think that both blead | |
187 | and maint are synchronised with a particular CPAN module, but one might | |
188 | have some extra changes. | |
189 | ||
dc0a4df9 DM |
190 | |
191 | =head3 dual-life CPAN module stability | |
7277a900 | 192 | |
f6af4394 | 193 | Ensure dual-life CPAN modules are stable, which comes down to: |
7277a900 GS |
194 | |
195 | for each module that fails its regression tests on $current | |
f6af4394 DM |
196 | did it fail identically on $previous? |
197 | if yes, "SEP" (Somebody Else's Problem) | |
198 | else work out why it failed (a bisect is useful for this) | |
7277a900 GS |
199 | |
200 | attempt to group failure causes | |
201 | ||
202 | for each failure cause | |
f6af4394 DM |
203 | is that a regression? |
204 | if yes, figure out how to fix it | |
205 | (more code? revert the code that broke it) | |
206 | else | |
207 | (presumably) it's relying on something un-or-under-documented | |
208 | should the existing behaviour stay? | |
209 | yes - goto "regression" | |
210 | no - note it in perldelta as a significant bugfix | |
211 | (also, try to inform the module's author) | |
1aff5354 | 212 | |
dc0a4df9 DM |
213 | |
214 | =head3 smoking | |
7277a900 | 215 | |
5157df7a AB |
216 | Similarly, monitor the smoking of core tests, and try to fix. See |
217 | L<http://doc.procura.nl/smoke/index.html> for a summary. See also | |
218 | L<http://www.nntp.perl.org/group/perl.daily-build.reports/> which has | |
219 | the raw reports. | |
7277a900 | 220 | |
636a1918 DM |
221 | Similarly, monitor the smoking of perl for compiler warnings, and try to |
222 | fix. | |
223 | ||
dc0a4df9 DM |
224 | |
225 | =head3 perldelta | |
636a1918 | 226 | |
f6af4394 | 227 | Get perldelta in a mostly finished state. |
db3f805e | 228 | |
04c2c53e | 229 | Read F<Porting/how_to_write_a_perldelta.pod>, and try to make sure that |
636a1918 DM |
230 | every section it lists is, if necessary, populated and complete. Copy |
231 | edit the whole document. | |
f6af4394 | 232 | |
f6af4394 | 233 | |
dc0a4df9 DM |
234 | =head3 Bump the version number |
235 | ||
236 | Increase the version number (e.g. from 5.12.0 to 5.12.1). | |
04dbb930 | 237 | |
6a958a95 | 238 | For a BLEAD-POINT release, this can happen on the day of the release. For a |
04dbb930 DG |
239 | release candidate for a stable perl, this should happen a week or two |
240 | before the first release candidate to allow sufficient time for testing and | |
241 | smoking with the target version built into the perl executable. For | |
242 | subsequent release candidates and the final release, it it not necessary to | |
243 | bump the version further. | |
f6af4394 | 244 | |
8b2227e6 | 245 | There is a tool to semi-automate this process: |
f6af4394 | 246 | |
8b2227e6 | 247 | $ ./perl -Ilib Porting/bump-perl-version -i 5.10.0 5.10.1 |
f6af4394 | 248 | |
8b2227e6 LB |
249 | Remember that this tool is largely just grepping for '5.10.0' or whatever, |
250 | so it will generate false positives. Be careful not change text like | |
251 | "this was fixed in 5.10.0"! | |
ceb7f800 | 252 | |
8b2227e6 | 253 | Use git status and git diff to select changes you want to keep. |
ceb7f800 | 254 | |
f6af4394 DM |
255 | Be particularly careful with F<INSTALL>, which contains a mixture of |
256 | C<5.10.0>-type strings, some of which need bumping on every release, and | |
e03f126c Z |
257 | some of which need to be left unchanged. |
258 | The line in F<INSTALL> about "is binary incompatible with" requires a | |
259 | correct choice of earlier version to declare incompatibility with. | |
260 | ||
6a958a95 DM |
261 | When doing a BLEAD-POINT or BLEAD-FINAL release, also make sure the |
262 | C<PERL_API_*> constants in F<patchlevel.h> are in sync with the version | |
263 | you're releasing, unless you're | |
e43cb88f | 264 | absolutely sure the release you're about to make is 100% binary compatible |
6a958a95 | 265 | to an earlier release. When releasing a MAINT perl version, the C<PERL_API_*> |
e43cb88f TM |
266 | constants C<MUST NOT> be changed as we aim to guarantee binary compatibility |
267 | in maint branches. | |
45ce9531 | 268 | |
17163f85 DM |
269 | After editing, regenerate uconfig.h (this must be run on a system with a |
270 | /bin/sh available): | |
22be9667 | 271 | |
17163f85 | 272 | $ perl regen/uconfig_h.pl |
22be9667 JV |
273 | |
274 | Test your changes: | |
275 | ||
17163f85 | 276 | $ git clean -xdf # careful if you don't have local files to keep! |
22be9667 JV |
277 | $ ./Configure -des -Dusedevel |
278 | $ make | |
279 | $ make test | |
280 | ||
54356a6f JV |
281 | Commit your changes: |
282 | ||
04abd20e | 283 | $ git status |
e91bd5c0 LB |
284 | $ git diff |
285 | B<review the delta carefully> | |
54356a6f JV |
286 | |
287 | $ git commit -a -m 'Bump the perl version in various places for 5.x.y' | |
dc0a62a1 | 288 | |
21768cb3 FC |
289 | At this point you may want to compare the commit with a previous bump to |
290 | see if they look similar. See commit 8891dd8d for an example of a | |
291 | previous version bump. | |
292 | ||
dc0a4df9 DM |
293 | When the version number is bumped, you should also update Module::CoreList |
294 | (as described below in L<"update Module::CoreList">) to reflect the new | |
81fc59ef DG |
295 | version number. |
296 | ||
dc0a4df9 DM |
297 | |
298 | =head3 update INSTALL | |
dc0a62a1 DM |
299 | |
300 | Review and update INSTALL to account for the change in version number; | |
301 | in particular, the "Coexistence with earlier versions of perl 5" section. | |
302 | ||
6a958a95 DM |
303 | Be particularly careful with the section "Upgrading from 5.X.Y or earlier". |
304 | The "X.Y" needs to be changed to the most recent version that we are | |
305 | I<not> binary compatible with. | |
306 | ||
307 | For MAINT and BLEAD-FINAL releases, this needs to refer to the last | |
308 | release in the previous development cycle (so for example, for a 5.14.x | |
309 | release, this would be 5.13.11). | |
310 | ||
311 | For BLEAD-POINT releases, it needs to refer to the previous BLEAD-POINT | |
312 | release (so for 5.15.3 this would be 5.15.2). | |
313 | ||
dc0a4df9 | 314 | =head3 Check more build configurations |
b82efa27 | 315 | |
52a66c2c DM |
316 | Check some more build configurations. The check that setuid builds and |
317 | installs is for < 5.11.0 only. | |
318 | ||
319 | $ sh Configure -Dprefix=/tmp/perl-5.x.y -Uinstallusrbinperl \ | |
320 | -Duseshrplib -Dd_dosuid | |
321 | $ make | |
322 | $ LD_LIBRARY_PATH=`pwd` make test # or similar for useshrplib | |
7277a900 | 323 | |
52a66c2c DM |
324 | $ make suidperl |
325 | $ su -c 'make install' | |
326 | $ ls -l .../bin/sperl | |
327 | -rws--x--x 1 root root 69974 2009-08-22 21:55 .../bin/sperl | |
7277a900 | 328 | |
52a66c2c | 329 | (Then delete the installation directory.) |
7277a900 | 330 | |
52a66c2c | 331 | XXX think of other configurations that need testing. |
7277a900 | 332 | |
dc0a4df9 DM |
333 | |
334 | =head3 update perlport | |
7277a900 | 335 | |
347f5124 RGS |
336 | L<perlport> has a section currently named I<Supported Platforms> that |
337 | indicates which platforms are known to build in the current release. | |
338 | If necessary update the list and the indicated version number. | |
339 | ||
6a958a95 DM |
340 | |
341 | ||
2e831dfd DM |
342 | =head2 Building a release - on the day |
343 | ||
b1288acc DM |
344 | This section describes the actions required to make a release |
345 | that are performed on the actual day. | |
2e831dfd | 346 | |
2e831dfd | 347 | |
dc0a4df9 | 348 | =head3 re-check earlier actions |
2e831dfd | 349 | |
dc0a4df9 | 350 | Review all the actions in the previous section, |
2e831dfd DM |
351 | L<"Building a release - advance actions"> to ensure they are all done and |
352 | up-to-date. | |
353 | ||
dc0a4df9 DM |
354 | |
355 | =head3 bump version number | |
8c35d285 | 356 | |
6a958a95 DM |
357 | For a BLEAD-POINT release, if you did not bump the perl version number as |
358 | part of I<advance actions>, do that now. | |
04dbb930 | 359 | |
dc0a4df9 DM |
360 | |
361 | =head3 finalize perldelta | |
04dbb930 | 362 | |
04dbb930 | 363 | Finalize the perldelta. In particular, fill in the Acknowledgements |
548e9a3a | 364 | section, which can be generated with something like: |
38195a8c | 365 | |
548e9a3a | 366 | $ perl Porting/acknowledgements.pl v5.15.0..HEAD |
ef86391b | 367 | |
a0db33fe DM |
368 | Re-read the perldelta to try to find any embarrassing typos and thinkos; |
369 | remove any C<TODO> or C<XXX> flags; update the "Known Problems" section | |
370 | with any serious issues for which fixes are not going to happen now; and | |
371 | run through pod and spell checkers, e.g. | |
2e831dfd | 372 | |
c5b87fed FR |
373 | $ podchecker -warnings -warnings pod/perldelta.pod |
374 | $ spell pod/perldelta.pod | |
2e831dfd | 375 | |
a0db33fe DM |
376 | Also, you may want to generate and view an HTML version of it to check |
377 | formatting, e.g. | |
2e831dfd | 378 | |
84c2dc44 | 379 | $ ./perl -Ilib ext/Pod-Html/pod2html pod/perldelta.pod > /tmp/perldelta.html |
2e831dfd | 380 | |
38195a8c DG |
381 | Another good HTML preview option is http://search.cpan.org/pod2html |
382 | ||
383 | If you make changes, be sure to commit them. | |
384 | ||
a03432f2 KW |
385 | =head3 remove stale perldeltas |
386 | ||
387 | For the first RC release that is ONLY for a BLEAD-FINAL, the perldeltas | |
388 | from the BLEAD-POINT releases since the previous BLEAD_FINAL should have | |
389 | now been consolidated into the current perldelta, and hence are now just | |
390 | useless clutter. They can be removed using: | |
391 | ||
392 | $ git rm <file1> <file2> ... | |
393 | ||
394 | For example, for RC0 of 5.16.0: | |
395 | ||
396 | $ cd pod | |
397 | $ git rm perldelta515*.pod | |
398 | ||
399 | All mention to them should also be removed. Currently the files that | |
400 | need to be edited for this task are F<MANIFEST>, F<pod.list>, | |
401 | F<pod/perl.pod>, and F<win32/pod.mak> (including C<.man>, C<.html>, and | |
402 | C<.tex> entries for each removed pod). | |
403 | ||
404 | Then build a clean perl and do a full test | |
405 | ||
406 | $ git status | |
407 | $ git clean -dxf | |
408 | $ ./Configure -Dusedevel -des | |
409 | $ make | |
410 | $ make test | |
411 | ||
412 | Once all tests pass, commit your changes. | |
dc0a4df9 DM |
413 | |
414 | =head3 build a clean perl | |
8c35d285 | 415 | |
a03432f2 KW |
416 | If you skipped the previous step (removing the stale perldeltas) |
417 | make sure you have a gitwise-clean perl directory (no modified files, | |
a0db33fe | 418 | unpushed commits etc): |
8c35d285 | 419 | |
a0db33fe | 420 | $ git status |
24c5e187 | 421 | $ git clean -dxf |
8c35d285 | 422 | |
dc0a4df9 | 423 | then configure and build perl so that you have a Makefile and porting tools: |
8c35d285 | 424 | |
52a66c2c | 425 | $ ./Configure -Dusedevel -des && make |
8c35d285 | 426 | |
dc0a4df9 | 427 | =head3 update Module::CoreList |
8c35d285 | 428 | |
1bac61bb | 429 | Update C<Module::CoreList> with module version data for the new release. |
bfadf2ba | 430 | |
6a958a95 | 431 | Note that if this is a MAINT release, you should run the following actions |
1bac61bb | 432 | from the maint branch, but commit the C<CoreList.pm> changes in |
a9d1f3db LB |
433 | I<blead> and subsequently cherry-pick any releases since the last |
434 | maint release and then your recent commit. XXX need a better example | |
bfadf2ba | 435 | |
a0db33fe | 436 | F<corelist.pl> uses ftp.funet.fi to verify information about dual-lived |
bfadf2ba | 437 | modules on CPAN. It can use a full, local CPAN mirror or fall back |
e8c01f92 SH |
438 | to C<wget> or C<curl> to fetch only package metadata remotely. (If you're |
439 | on Win32, then installing Cygwin is one way to have commands like C<wget> | |
440 | and C<curl> available.) | |
bfadf2ba JV |
441 | |
442 | (If you'd prefer to have a full CPAN mirror, see | |
443 | http://www.cpan.org/misc/cpan-faq.html#How_mirror_CPAN) | |
444 | ||
a0db33fe | 445 | Then change to your perl checkout, and if necessary, |
bfadf2ba | 446 | |
595f83ae | 447 | $ make |
bfadf2ba | 448 | |
81fc59ef DG |
449 | If this not the first update for this version (e.g. if it was updated |
450 | when the version number was originally bumped), first edit | |
d5bddf6e | 451 | F<dist/Module-CoreList/lib/Module/CoreList.pm> to delete the existing |
2ce7d676 RGS |
452 | entries for this version from the C<%released> and C<%version> hashes: |
453 | they will have a key like C<5.010001> for 5.10.1. | |
52a66c2c DM |
454 | |
455 | XXX the edit-in-place functionality of Porting/corelist.pl should | |
456 | be fixed to handle this automatically. | |
457 | ||
bf8ea215 | 458 | Then, If you have a local CPAN mirror, run: |
bfadf2ba | 459 | |
bfadf2ba JV |
460 | $ ./perl -Ilib Porting/corelist.pl ~/my-cpan-mirror |
461 | ||
462 | Otherwise, run: | |
463 | ||
bfadf2ba JV |
464 | $ ./perl -Ilib Porting/corelist.pl cpan |
465 | ||
52a66c2c | 466 | This will chug for a while, possibly reporting various warnings about |
2a720090 | 467 | badly-indexed CPAN modules unrelated to the modules actually in core. |
2ce7d676 | 468 | Assuming all goes well, it will update |
d5bddf6e | 469 | F<dist/Module-CoreList/lib/Module/CoreList.pm>. |
bfadf2ba JV |
470 | |
471 | Check that file over carefully: | |
472 | ||
d5bddf6e | 473 | $ git diff dist/Module-CoreList/lib/Module/CoreList.pm |
bfadf2ba | 474 | |
bfadf2ba JV |
475 | If necessary, bump C<$VERSION> (there's no need to do this for |
476 | every RC; in RC1, bump the version to a new clean number that will | |
477 | appear in the final release, and leave as-is for the later RCs and final). | |
9709cbd8 FC |
478 | It may also happen that C<Module::CoreList> has been modified in blead, and |
479 | hence has a new version number already. (But make sure it is not the same | |
480 | number as a CPAN release.) | |
bfadf2ba JV |
481 | |
482 | Edit the version number in the new C<< 'Module::CoreList' => 'X.YZ' >> | |
483 | entry, as that is likely to reflect the previous version number. | |
484 | ||
cb9af4c0 AB |
485 | Also edit Module::CoreList's new version number in its F<Changes> |
486 | file. | |
e8c01f92 | 487 | |
70855f8b FC |
488 | Add a perldelta entry for the new Module::CoreList version. |
489 | ||
a0db33fe | 490 | In addition, if this is a final release (rather than a release candidate): |
bfadf2ba JV |
491 | |
492 | =over 4 | |
493 | ||
494 | =item * | |
495 | ||
496 | Update this version's entry in the C<%released> hash with today's date. | |
497 | ||
498 | =item * | |
499 | ||
500 | Make sure that the script has correctly updated the C<CAVEATS> section | |
501 | ||
502 | =back | |
503 | ||
504 | Finally, commit the new version of Module::CoreList: | |
6a958a95 | 505 | (unless this is for MAINT; in which case commit it to blead first, then |
a0db33fe | 506 | cherry-pick it back). |
bfadf2ba | 507 | |
770cf6ff | 508 | $ git commit -m 'Update Module::CoreList for 5.x.y' dist/Module-CoreList/lib/Module/CoreList.pm |
bfadf2ba | 509 | |
dc0a4df9 DM |
510 | |
511 | =head3 check MANIFEST | |
bfadf2ba | 512 | |
a0db33fe | 513 | Check that the manifest is sorted and correct: |
8c35d285 | 514 | |
a0db33fe | 515 | $ make distclean |
300b5357 | 516 | $ git clean -xdf # This shouldn't be necessary if distclean is correct |
a0db33fe | 517 | $ perl Porting/manicheck |
d5bddf6e | 518 | |
7081fd3a | 519 | If manicheck turns up anything wrong, update MANIFEST and begin this step again. |
a0db33fe | 520 | |
7081fd3a JV |
521 | $ ./configure -des -Dusedevel |
522 | $ make test_porting | |
a0db33fe DM |
523 | $ git commit -m 'Update MANIFEST' MANIFEST |
524 | ||
dc0a4df9 DM |
525 | |
526 | =head3 update perlhist.pod | |
a0db33fe | 527 | |
e8a7a70e | 528 | I<You MUST SKIP this step for a RC release> |
a0db33fe | 529 | |
e8a7a70e JV |
530 | Add an entry to F<pod/perlhist.pod> with the release date, e.g.: |
531 | ||
532 | David 5.10.1 2009-Aug-06 | |
a0db33fe DM |
533 | |
534 | Make sure that the correct pumpking is listed in the left-hand column, and | |
535 | if this is the first release under the stewardship of a new pumpking, make | |
536 | sure that his or her name is listed in the section entitled | |
537 | C<THE KEEPERS OF THE PUMPKIN>. | |
538 | ||
539 | Be sure to commit your changes: | |
540 | ||
541 | $ git commit -m 'add new release to perlhist' pod/perlhist.pod | |
8c35d285 | 542 | |
dc0a4df9 DM |
543 | |
544 | =head3 update patchlevel.h | |
8c35d285 | 545 | |
6a958a95 | 546 | I<You MUST SKIP this step for a BLEAD-POINT release> |
d7eb1120 | 547 | |
a42352ee DM |
548 | Update F<patchlevel.h> to add a C<-RC1>-or-whatever string; or, if this is |
549 | a final release, remove it. For example: | |
d7eb1120 DM |
550 | |
551 | static const char * const local_patches[] = { | |
552 | NULL | |
553 | + ,"RC1" | |
554 | PERL_GIT_UNPUSHED_COMMITS /* do not remove this line */ | |
555 | ||
556 | Be sure to commit your change: | |
557 | ||
558 | $ git commit -m 'bump version to RCnnn' patchlevel.h | |
559 | ||
dc0a4df9 DM |
560 | |
561 | =head3 build, test and check a fresh perl | |
d7eb1120 | 562 | |
a0db33fe DM |
563 | Build perl, then make sure it passes its own test suite, and installs: |
564 | ||
565 | $ git clean -xdf | |
a42352ee DM |
566 | $ ./Configure -des -Dprefix=/tmp/perl-5.x.y-pretest |
567 | ||
568 | # or if it's an odd-numbered version: | |
a0db33fe | 569 | $ ./Configure -des -Dusedevel -Dprefix=/tmp/perl-5.x.y-pretest |
a42352ee | 570 | |
a0db33fe DM |
571 | $ make test install |
572 | ||
52a66c2c DM |
573 | Check that the output of C</tmp/perl-5.x.y-pretest/bin/perl -v> and |
574 | C</tmp/perl-5.x.y-pretest/bin/perl -V> are as expected, | |
a0db33fe | 575 | especially as regards version numbers, patch and/or RC levels, and @INC |
52a66c2c DM |
576 | paths. Note that as they have been been built from a git working |
577 | directory, they will still identify themselves using git tags and | |
578 | commits. | |
579 | ||
580 | Then delete the temporary installation. | |
581 | ||
dc0a4df9 DM |
582 | |
583 | =head3 push the work so far | |
52a66c2c | 584 | |
a0db33fe DM |
585 | Push all your recent commits: |
586 | ||
587 | $ git push origin .... | |
588 | ||
96054f12 | 589 | |
dc0a4df9 | 590 | =head3 tag the release |
96054f12 | 591 | |
e8c01f92 | 592 | Tag the release (e.g.): |
96054f12 | 593 | |
b6d23947 | 594 | $ git tag v5.11.0 -m "First release of the v5.11 series!" |
e8c01f92 | 595 | |
6a958a95 | 596 | It is B<VERY> important that from this point forward, you not push |
f662f3b7 JV |
597 | your git changes to the Perl master repository. If anything goes |
598 | wrong before you publish your newly-created tag, you can delete | |
599 | and recreate it. Once you push your tag, we're stuck with it | |
600 | and you'll need to use a new version number for your release. | |
601 | ||
dc0a4df9 DM |
602 | |
603 | =head3 build the tarball | |
a0db33fe | 604 | |
0dcf3caa | 605 | Before you run the following, you might want to install 7-Zip (the |
0dcb816b | 606 | C<p7zip-full> package under Debian or the C<p7zip> port on MacPorts) or |
0dcf3caa LB |
607 | the AdvanceCOMP suite (e.g. the C<advancecomp> package under Debian, |
608 | or the C<advancecomp> port on macports - 7-Zip on Windows is the | |
609 | same code as AdvanceCOMP, so Windows users get the smallest files | |
610 | first time). These compress about 5% smaller than gzip and bzip2. | |
611 | Over the lifetime of your distribution this will save a lot of | |
612 | people a small amount of download time and disk space, which adds | |
613 | up. | |
614 | ||
8c35d285 JV |
615 | Create a tarball. Use the C<-s> option to specify a suitable suffix for |
616 | the tarball and directory name: | |
617 | ||
618 | $ cd root/of/perl/tree | |
619 | $ make distclean | |
75a012fe DM |
620 | $ git clean -xdf # make sure perl and git agree on files |
621 | $ git status # and there's nothing lying around | |
8c35d285 | 622 | |
8c35d285 JV |
623 | $ perl Porting/makerel -b -s RC1 # for a release candidate |
624 | $ perl Porting/makerel -b # for a final release | |
625 | ||
626 | This creates the directory F<../perl-x.y.z-RC1> or similar, copies all | |
627 | the MANIFEST files into it, sets the correct permissions on them, | |
628 | adds DOS line endings to some, then tars it up as | |
629 | F<../perl-x.y.z-RC1.tar.gz>. With C<-b>, it also creates a C<tar.bz2> file. | |
630 | ||
6480287f MT |
631 | If you're getting your tarball suffixed with -uncommitted and you're sure |
632 | your changes were all committed, you can override the suffix with: | |
633 | ||
634 | $ perl Porting/makerel -b -s '' | |
96054f12 | 635 | |
8c35d285 JV |
636 | XXX if we go for extra tags and branches stuff, then add the extra details |
637 | here | |
638 | ||
dc0a4df9 | 639 | Finally, clean up the temporary directory, e.g. |
a42352ee DM |
640 | |
641 | $ rm -rf ../perl-x.y.z-RC1 | |
642 | ||
dc0a4df9 DM |
643 | |
644 | =head3 test the tarball | |
645 | ||
646 | =over 4 | |
647 | ||
a42352ee DM |
648 | =item * |
649 | ||
8c35d285 JV |
650 | Copy the tarballs (.gz and possibly .bz2) to a web server somewhere you |
651 | have access to. | |
652 | ||
653 | =item * | |
654 | ||
655 | Download the tarball to some other machine. For a release candidate, | |
656 | you really want to test your tarball on two or more different platforms | |
657 | and architectures. The #p5p IRC channel on irc.perl.org is a good place | |
658 | to find willing victims. | |
659 | ||
660 | =item * | |
661 | ||
662 | Check that basic configuration and tests work on each test machine: | |
663 | ||
664 | $ ./Configure -des && make all test | |
f6af4394 DM |
665 | |
666 | =item * | |
667 | ||
8c35d285 JV |
668 | Check that the test harness and install work on each test machine: |
669 | ||
a42352ee | 670 | $ make distclean |
8c35d285 | 671 | $ ./Configure -des -Dprefix=/install/path && make all test_harness install |
a42352ee | 672 | $ cd /install/path |
8c35d285 JV |
673 | |
674 | =item * | |
675 | ||
676 | Check that the output of C<perl -v> and C<perl -V> are as expected, | |
677 | especially as regards version numbers, patch and/or RC levels, and @INC | |
678 | paths. | |
679 | ||
680 | Note that the results may be different without a F<.git/> directory, | |
681 | which is why you should test from the tarball. | |
682 | ||
683 | =item * | |
684 | ||
459fc3ca DM |
685 | Run the Installation Verification Procedure utility: |
686 | ||
9651cacc | 687 | $ ./perl utils/perlivp |
459fc3ca DM |
688 | ... |
689 | All tests successful. | |
690 | $ | |
691 | ||
692 | =item * | |
693 | ||
d60a1044 DM |
694 | Compare the pathnames of all installed files with those of the previous |
695 | release (i.e. against the last installed tarball on this branch which you | |
696 | have previously verified using this same procedure). In particular, look | |
697 | for files in the wrong place, or files no longer included which should be. | |
698 | For example, suppose the about-to-be-released version is 5.10.1 and the | |
699 | previous is 5.10.0: | |
700 | ||
701 | cd installdir-5.10.0/ | |
702 | find . -type f | perl -pe's/5\.10\.0/5.10.1/g' | sort > /tmp/f1 | |
703 | cd installdir-5.10.1/ | |
704 | find . -type f | sort > /tmp/f2 | |
705 | diff -u /tmp/f[12] | |
706 | ||
707 | =item * | |
708 | ||
8c35d285 JV |
709 | Bootstrap the CPAN client on the clean install: |
710 | ||
16c60e4e | 711 | $ bin/perl -MCPAN -e "shell" |
8c35d285 | 712 | |
16c60e4e AB |
713 | If you're running this on Win32 you probably also need a set of Unix |
714 | command-line tools available for CPAN to function correctly without | |
e8c01f92 SH |
715 | Perl alternatives like LWP installed. Cygwin is an obvious choice.) |
716 | ||
8c35d285 JV |
717 | =item * |
718 | ||
a42352ee DM |
719 | Try installing a popular CPAN module that's reasonably complex and that |
720 | has dependencies; for example: | |
8c35d285 | 721 | |
a42352ee DM |
722 | CPAN> install Inline |
723 | CPAN> quit | |
8c35d285 JV |
724 | |
725 | Check that your perl can run this: | |
726 | ||
16c60e4e | 727 | $ bin/perl -lwe "use Inline C => q[int f() { return 42;}]; print f" |
a42352ee DM |
728 | 42 |
729 | $ | |
8c35d285 JV |
730 | |
731 | =item * | |
732 | ||
733 | Bootstrap the CPANPLUS client on the clean install: | |
734 | ||
75a012fe | 735 | $ bin/cpanp |
8c35d285 | 736 | |
e8c01f92 SH |
737 | (Again, on Win32 you'll need something like Cygwin installed, but make sure |
738 | that you don't end up with its various F<bin/cpan*> programs being found on | |
739 | the PATH before those of the Perl that you're trying to test.) | |
740 | ||
8c35d285 JV |
741 | =item * |
742 | ||
a42352ee | 743 | Install an XS module, for example: |
8c35d285 | 744 | |
a42352ee DM |
745 | CPAN Terminal> i DBI |
746 | CPAN Terminal> quit | |
747 | $ bin/perl -MDBI -e 1 | |
75a012fe | 748 | $ |
8c35d285 JV |
749 | |
750 | =item * | |
751 | ||
7f89f796 | 752 | Check that the L<perlbug> utility works. Try the following: |
47b1f096 | 753 | |
a14438df | 754 | $ bin/perlbug |
47b1f096 DM |
755 | ... |
756 | Subject: test bug report | |
757 | Local perl administrator [yourself]: | |
758 | Editor [vi]: | |
759 | Module: | |
760 | Category [core]: | |
761 | Severity [low]: | |
762 | (edit report) | |
763 | Action (Send/Display/Edit/Subject/Save to File): f | |
764 | Name of file to save message in [perlbug.rep]: | |
765 | Action (Send/Display/Edit/Subject/Save to File): q | |
766 | ||
767 | and carefully examine the output (in F<perlbug.rep]>), especially | |
768 | the "Locally applied patches" section. If everything appears okay, then | |
75a012fe DM |
769 | delete the file, and try it again, this time actually submitting the bug |
770 | report. Check that it shows up, then remember to close it! | |
47b1f096 | 771 | |
dc0a4df9 DM |
772 | =back |
773 | ||
774 | ||
775 | =head3 monitor smokes | |
47b1f096 | 776 | |
f6af4394 DM |
777 | Wait for the smoke tests to catch up with the commit which this release is |
778 | based on (or at least the last commit of any consequence). | |
7277a900 | 779 | |
f6af4394 DM |
780 | Then check that the smoke tests pass (particularly on Win32). If not, go |
781 | back and fix things. | |
7277a900 | 782 | |
6a958a95 | 783 | Note that for I<BLEAD-POINT> releases this may not be practical. It takes a |
1eefd7d5 | 784 | long time for the smokers to catch up, especially the Win32 |
6a958a95 DM |
785 | smokers. This is why we have a RC cycle for I<MAINT> and I<BLEAD-FINAL> |
786 | releases, but for I<BLEAD-POINT> releases sometimes the best you can do is | |
787 | to plead with people on IRC to test stuff on their platforms, fire away, | |
788 | and then hope for the best. | |
7277a900 | 789 | |
dc0a4df9 DM |
790 | |
791 | =head3 upload to PAUSE | |
7277a900 | 792 | |
f6af4394 | 793 | Once smoking is okay, upload it to PAUSE. This is the point of no return. |
db3f805e JV |
794 | If anything goes wrong after this point, you will need to re-prepare |
795 | a new release with a new minor version or RC number. | |
796 | ||
a14438df DM |
797 | https://pause.perl.org/ |
798 | ||
799 | (Login, then select 'Upload a file to CPAN') | |
800 | ||
45924287 RS |
801 | If your workstation is not connected to a high-bandwidth, |
802 | high-reliability connection to the Internet, you should probably use the | |
803 | "GET URL" feature (rather than "HTTP UPLOAD") to have PAUSE retrieve the | |
804 | new release from wherever you put it for testers to find it. This will | |
805 | eliminate anxious gnashing of teeth while you wait to see if your | |
806 | 15 megabyte HTTP upload successfully completes across your slow, twitchy | |
c27b4e97 SH |
807 | cable modem. You can make use of your home directory on dromedary for |
808 | this purpose: F<http://users.perl5.git.perl.org/~USERNAME> maps to | |
809 | F</home/USERNAME/public_html>, where F<USERNAME> is your login account | |
810 | on dromedary. I<Remember>: if your upload is partially successful, you | |
811 | may need to contact a PAUSE administrator or even bump the version of perl. | |
45924287 | 812 | |
a42352ee | 813 | Upload both the .gz and .bz2 versions of the tarball. |
f6af4394 | 814 | |
c27b4e97 | 815 | Wait until you receive notification emails from the PAUSE indexer |
38195a8c | 816 | confirming that your uploads have been received. IMPORTANT -- you will |
b28f69c2 Z |
817 | probably get an email that indexing has failed, due to module permissions. |
818 | This is considered normal. | |
38195a8c DG |
819 | |
820 | Do not proceed any further until you are sure that your tarballs are on | |
821 | CPAN. Check your authors directory on one of the "fast" CPAN mirrors | |
b28f69c2 | 822 | (e.g., cpan.hexten.net |
38195a8c | 823 | or cpan.cpantesters.org) to confirm that your uploads have been successful. |
c27b4e97 | 824 | |
dc0a4df9 DM |
825 | |
826 | =head3 publish tag | |
210de33e | 827 | |
f662f3b7 | 828 | Now that you've shipped the new perl release to PAUSE, it's |
e8c01f92 | 829 | time to publish the tag you created earlier to the public git repo (e.g.): |
f662f3b7 JV |
830 | |
831 | $ git push origin tag v5.11.0 | |
f6af4394 | 832 | |
dc0a4df9 DM |
833 | |
834 | =head3 disarm patchlevel.h | |
f6af4394 | 835 | |
6a958a95 | 836 | I<You MUST SKIP this step for BLEAD-POINT release> |
113f3f4c | 837 | |
a42352ee | 838 | Disarm the F<patchlevel.h> change; for example, |
d7eb1120 DM |
839 | |
840 | static const char * const local_patches[] = { | |
841 | NULL | |
842 | - ,"RC1" | |
843 | PERL_GIT_UNPUSHED_COMMITS /* do not remove this line */ | |
844 | ||
845 | Be sure to commit your change: | |
846 | ||
847 | $ git commit -m 'disarm RCnnn bump' patchlevel.h | |
a14438df | 848 | $ git push origin .... |
d7eb1120 | 849 | |
2e831dfd | 850 | |
dc0a4df9 DM |
851 | |
852 | =head3 announce to p5p | |
2e831dfd | 853 | |
db3f805e | 854 | Mail p5p to announce your new release, with a quote you prepared earlier. |
f6af4394 | 855 | |
dc0a4df9 DM |
856 | |
857 | =head3 update epigraphs.pod | |
f6af4394 | 858 | |
85531b0a | 859 | Add your quote to F<Porting/epigraphs.pod> and commit it. |
606d51b7 Z |
860 | Your release announcement will probably not have reached the web-visible |
861 | archives yet, so you won't be able to include the customary link to the | |
862 | release announcement yet. | |
dc0a4df9 DM |
863 | |
864 | =head3 Module::CoreList nagging | |
85531b0a | 865 | |
bc4c40f2 | 866 | I<You MUST SKIP this step for RC> |
8c35d285 | 867 | |
75a012fe DM |
868 | Remind the current maintainer of C<Module::CoreList> to push a new release |
869 | to CPAN. | |
7277a900 | 870 | |
dc0a4df9 DM |
871 | |
872 | =head3 new perldelta | |
a2cba4bc | 873 | |
bc4c40f2 | 874 | I<You MUST SKIP this step for RC> |
7277a900 | 875 | |
c5b87fed | 876 | Create a new perldelta. |
7277a900 | 877 | |
17163f85 DM |
878 | B<Note>: currently, the buildtoc below must be run in a I<built> perl source |
879 | directory, as at least one of the pod files it expects to find is | |
880 | autogenerated: perluniprops.pod. But you can't build perl if you've added | |
881 | the new perldelta file and not updated toc. So, make sure you have a built | |
dc0a4df9 | 882 | perl (with a pod/perluniprops.pod file) now, I<before> continuing. |
17163f85 DM |
883 | |
884 | First, update the F<pod/.gitignore> file to ignore the next | |
885 | release's generated F<pod/perlNNNdelta.pod> file rather than this release's | |
5ef3945b SH |
886 | one which we are about to set in stone (where NNN is the perl version number |
887 | without the dots. i.e. 5135 for 5.13.5). | |
888 | ||
17163f85 DM |
889 | $ (edit pod/.gitignore ) |
890 | $ git add pod/.gitignore | |
8e967a1c | 891 | |
17163f85 DM |
892 | Then, move the existing F<pod/perldelta.pod> to F<pod/perlNNNdelta.pod>, |
893 | and edit the moved delta file to change the C<NAME> from C<perldelta> to | |
894 | C<perlNNNdelta>. For example, assuming you just released 5.10.1, and are | |
895 | about to create the 5.10.2 perldelta: | |
8e967a1c | 896 | |
17163f85 | 897 | $ rm pod/perl5101delta.pod # remove the auto-generated file, if any |
c5b87fed FR |
898 | $ git mv pod/perldelta.pod pod/perl5101delta.pod |
899 | $ (edit pod/perl5101delta.pod to retitle) | |
8e967a1c | 900 | $ git add pod/perl5101delta.pod |
c5b87fed | 901 | |
17163f85 DM |
902 | Then create a new empty perldelta.pod file for the new release; see |
903 | F<Porting/how_to_write_a_perldelta.pod>. You should be able to do this by | |
904 | just copying in a skeleton template and then doing a quick fix up of the | |
905 | version numbers. Then commit the move and the new file. | |
906 | ||
c5b87fed FR |
907 | $ cp -i Porting/perldelta_template.pod pod/perldelta.pod |
908 | $ (edit pod/perldelta.pod) | |
909 | $ git add pod/perldelta.pod | |
910 | $ git commit -m 'create perldelta for 5.10.2' | |
8e967a1c | 911 | |
dc0a4df9 | 912 | =head3 update perldelta TOC and references |
17163f85 DM |
913 | |
914 | Now you need to update various tables of contents related to perldelta, | |
915 | most of which can be generated automatically. | |
7277a900 | 916 | |
8a51675c FC |
917 | Edit F<pod.lst>: add the new entry for the perlNNNdelta file for the |
918 | current version (the file that will be symlinked to perldelta). | |
7277a900 | 919 | |
17163f85 DM |
920 | Manually create a temporary link to the new delta file; normally this is |
921 | done from the Makefile, but the Makefile is updated by buildtoc, and | |
922 | buildtoc won't run without the file there: | |
923 | ||
924 | $ ln -s perldelta.pod pod/perl5102delta.pod | |
925 | ||
75a012fe DM |
926 | Run C<perl pod/buildtoc --build-all> to update the F<perldelta> version in |
927 | the following files: | |
57433fbf JV |
928 | |
929 | MANIFEST | |
75a012fe | 930 | Makefile.SH |
57433fbf | 931 | pod/perl.pod |
57433fbf | 932 | vms/descrip_mms.template |
75a012fe DM |
933 | win32/Makefile |
934 | win32/makefile.mk | |
935 | win32/pod.mak | |
936 | ||
75a012fe DM |
937 | Finally, commit: |
938 | ||
c5b87fed | 939 | $ git commit -a -m 'update TOC for perlNNNdelta' |
75a012fe | 940 | |
21768cb3 FC |
941 | At this point you may want to compare the commit with a previous bump to |
942 | see if they look similar. See commit dd885b5 for an example of a | |
75a012fe | 943 | previous version bump. |
57433fbf | 944 | |
dc0a4df9 DM |
945 | |
946 | =head3 bump version | |
57433fbf | 947 | |
6a958a95 | 948 | I<You MUST SKIP this step for RC, BLEAD-POINT, MAINT> |
dc0a62a1 | 949 | |
6a958a95 DM |
950 | If this was a BLEAD-FINAL release (i.e. the first release of a new maint |
951 | series, 5.x.0 where x is even), then bump the version in the blead branch | |
952 | in git, e.g. 5.12.0 to 5.13.0. | |
17163f85 DM |
953 | |
954 | First, add a new feature bundle to F<lib/feature.pm>, initially by just | |
955 | copying the exiting entry, and bump the file's $VERSION; e.g. | |
956 | ||
957 | "5.14" => [qw(switch say state unicode_strings)], | |
958 | + "5.15" => [qw(switch say state unicode_strings)], | |
addebd58 | 959 | |
dc0a4df9 DM |
960 | Then follow the section L<"Bump the version number"> to bump the version |
961 | in the remaining files and test and commit. | |
17163f85 | 962 | |
17163f85 | 963 | |
d5c37431 NC |
964 | =head3 clean build and test |
965 | ||
966 | Run a clean build and test to make sure nothing obvious is broken. | |
967 | ||
968 | In particular, F<Porting/perldelta_template.pod> is intentionally exempted | |
969 | from podchecker tests, to avoid false positives about placeholder text. | |
970 | However, once it's copied to F<pod/perldelta.pod> the contents can now | |
ef4474b5 KW |
971 | cause test failures. Problems should resolved by doing one of the |
972 | following: | |
973 | ||
974 | =over | |
975 | ||
976 | =item 1 | |
977 | ||
978 | Replace placeholder text with correct text. | |
979 | ||
980 | =item 2 | |
981 | ||
982 | If the problem is from a broken placeholder link, you can add it to the | |
983 | array C<@perldelta_ignore_links> in F<t/porting/podcheck.t>. Lines | |
984 | containing such links should be marked with C<XXX> so that they get | |
985 | cleaned up before the next release. | |
986 | ||
987 | =item 3 | |
988 | ||
989 | Following the instructions output by F<t/porting/podcheck.t> on how to | |
990 | update its exceptions database. | |
991 | ||
992 | =back | |
d5c37431 | 993 | |
dc0a4df9 DM |
994 | =head3 push commits |
995 | ||
996 | Finally, push any commits done above. | |
997 | ||
998 | $ git push origin .... | |
999 | ||
1000 | ||
1001 | =head3 create maint branch | |
17163f85 | 1002 | |
6a958a95 | 1003 | I<You MUST SKIP this step for RC, BLEAD-POINT, MAINT> |
17163f85 | 1004 | |
6a958a95 DM |
1005 | If this was a BLEAD-FINAL release (i.e. the first release of a new maint |
1006 | series, 5.x.0 where x is even), then create a new maint branch based on | |
1007 | the commit tagged as the current release. | |
7277a900 | 1008 | |
233ca920 JV |
1009 | Assuming you're using git 1.7.x or newer: |
1010 | ||
17163f85 | 1011 | $ git checkout -b maint-5.12 v5.12.0 |
233ca920 | 1012 | $ git push origin -u maint-5.12 |
addebd58 | 1013 | |
dc0a4df9 | 1014 | |
d5722260 DK |
1015 | =head3 make the maint branch available in the APC |
1016 | ||
1017 | Clone the new branch into /srv/gitcommon/branches on camel so the APC will | |
1018 | receive its changes. | |
1019 | ||
07697565 | 1020 | $ git clone --branch maint-5.14 /gitroot/perl.git \ |
d5722260 | 1021 | ? /srv/gitcommon/branches/perl-5.14.x |
07697565 | 1022 | $ chmod -R g=u /srv/gitcommon/branches/perl-5.14.x |
d5722260 DK |
1023 | |
1024 | And nag the sysadmins to make this directory available via rsync. | |
1025 | ||
1026 | ||
dc0a4df9 | 1027 | =head3 copy perldelta.pod to other branches |
addebd58 | 1028 | |
6a958a95 | 1029 | I<You MUST SKIP this step for RC, BLEAD-POINT> |
8c35d285 | 1030 | |
c5b87fed | 1031 | Copy the perldelta.pod for this release into the other branches; for |
75a012fe | 1032 | example: |
7277a900 | 1033 | |
c5b87fed | 1034 | $ cp -i ../5.10.x/pod/perldelta.pod pod/perl5101delta.pod # for example |
75a012fe DM |
1035 | $ git add pod/perl5101delta.pod |
1036 | ||
1037 | Edit F<pod.lst> to add an entry for the file, e.g.: | |
1038 | ||
1039 | perl5101delta Perl changes in version 5.10.1 | |
bc4c40f2 | 1040 | |
75a012fe | 1041 | Then rebuild various files: |
7277a900 | 1042 | |
75a012fe DM |
1043 | $ perl pod/buildtoc --build-all |
1044 | ||
1045 | Finally, commit: | |
1046 | ||
1047 | $ git commit -a -m 'add perlXXXdelta' | |
7277a900 | 1048 | |
dc0a4df9 DM |
1049 | |
1050 | =head3 update perlhist.pod in other branches | |
7277a900 | 1051 | |
f6af4394 | 1052 | Make sure any recent F<pod/perlhist.pod> entries are copied to |
e8a7a70e | 1053 | F<perlhist.pod> on other branches |
f6af4394 | 1054 | e.g. |
7277a900 | 1055 | |
f6af4394 | 1056 | 5.8.9 2008-Dec-14 |
7277a900 | 1057 | |
dc0a4df9 DM |
1058 | |
1059 | =head3 bump RT version number | |
6e40fbf9 | 1060 | |
1530afd8 LB |
1061 | Log into http://rt.perl.org/ and check whether the new version is |
1062 | in the RT fields C<Perl Version> and C<Fixed In>. If not, send an | |
1063 | email to C<perlbug-admin at perl.org> requesting this. | |
dc0a4df9 DM |
1064 | |
1065 | =head3 Relax! | |
a3738a12 | 1066 | |
bc4c40f2 JV |
1067 | I<You MUST RETIRE to your preferred PUB, CAFE or SEASIDE VILLA for some |
1068 | much-needed rest and relaxation>. | |
8c35d285 JV |
1069 | |
1070 | Thanks for releasing perl! | |
1071 | ||
7277a900 | 1072 | |
b28f69c2 Z |
1073 | =head2 Building a release - the day after |
1074 | ||
606d51b7 Z |
1075 | =head3 link announcement in epigraphs.pod |
1076 | ||
1077 | Add, to your quote to F<Porting/epigraphs.pod>, a link to the release | |
1078 | announcement in the web-visible mailing list archive. Commit it. | |
1079 | ||
dc0a4df9 DM |
1080 | =head3 check tarball availability |
1081 | ||
1082 | Check various website entries to make sure the that tarball has appeared | |
1083 | and is properly indexed: | |
1084 | ||
b28f69c2 Z |
1085 | =over 4 |
1086 | ||
1087 | =item * | |
1088 | ||
98df743a Z |
1089 | Check your author directory under L<http://www.cpan.org/authors/id/> |
1090 | to ensure that the tarballs are available on the website. | |
b28f69c2 Z |
1091 | |
1092 | =item * | |
1093 | ||
98df743a Z |
1094 | Check C</src> on CPAN (on a fast mirror) to ensure that links to |
1095 | the new tarballs have appeared. There should be links in C</src/5.0> | |
1096 | (which is accumulating all new versions), links in C</src> (which shows | |
1097 | only the latest version on each branch), and an appropriate mention in | |
1098 | C</src/README.html> (which describes the latest versions). | |
1099 | ||
1100 | These links should appear automatically, some hours after upload. | |
1101 | If they don't, or the C<README.html> description is inadequate, | |
1102 | ask Ask <ask@perl.org>. | |
b28f69c2 Z |
1103 | |
1104 | =item * | |
1105 | ||
98df743a Z |
1106 | Check L<http://www.cpan.org/src/> to ensure that the C</src> updates |
1107 | have been correctly mirrored to the website. | |
1108 | If they haven't, ask Ask <ask@perl.org>. | |
1109 | ||
1110 | =item * | |
b28f69c2 | 1111 | |
98df743a Z |
1112 | Check L<http://search.cpan.org> to see if it has indexed the distribution. |
1113 | It should be visible at a URL like C<http://search.cpan.org/dist/perl-5.10.1/>. | |
b28f69c2 | 1114 | |
dc0a4df9 | 1115 | =back |
b28f69c2 | 1116 | |
dc0a4df9 DM |
1117 | |
1118 | =head3 update dev.perl.org | |
1119 | ||
512b502a | 1120 | I<This step ONLY for BLEAD-FINAL and MAINT> |
98df743a | 1121 | |
e294df83 | 1122 | Ask Leo Lapworth to update L<http://dev.perl.org/perl5/>. |
b28f69c2 | 1123 | |
b28f69c2 | 1124 | |
7277a900 GS |
1125 | =head1 SOURCE |
1126 | ||
f6af4394 DM |
1127 | Based on |
1128 | http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2009-05/msg00608.html, | |
1129 | plus a whole bunch of other sources, including private correspondence. | |
7277a900 GS |
1130 | |
1131 | =cut | |
1132 |