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 |
38195a8c DG |
364 | section. You can generate a list of contributors with checkAUTHORS.pl. |
365 | For example: | |
366 | ||
c34fab5f | 367 | $ git log --pretty=fuller v5.13.${last}..HEAD | \ |
38195a8c | 368 | perl Porting/checkAUTHORS.pl --who - |
04dbb930 | 369 | |
ef86391b AB |
370 | Look at the previous L<perldelta> for how to write the opening |
371 | paragraph of the Acknowledgements section. To get the amount of | |
372 | changed files and number of lines use this command: | |
373 | ||
a599c209 LB |
374 | $ git diff --shortstat v5.15.0..HEAD | \ |
375 | ./perl -Ilib -nE 'my ($files, $insert, $delete) = /(\d+)/ga; say $insert + $delete, " lines of changes across $files files"' | |
ef86391b AB |
376 | |
377 | Making sure to round off the number of lines changed. | |
378 | ||
a0db33fe DM |
379 | Re-read the perldelta to try to find any embarrassing typos and thinkos; |
380 | remove any C<TODO> or C<XXX> flags; update the "Known Problems" section | |
381 | with any serious issues for which fixes are not going to happen now; and | |
382 | run through pod and spell checkers, e.g. | |
2e831dfd | 383 | |
c5b87fed FR |
384 | $ podchecker -warnings -warnings pod/perldelta.pod |
385 | $ spell pod/perldelta.pod | |
2e831dfd | 386 | |
a0db33fe DM |
387 | Also, you may want to generate and view an HTML version of it to check |
388 | formatting, e.g. | |
2e831dfd | 389 | |
84c2dc44 | 390 | $ ./perl -Ilib ext/Pod-Html/pod2html pod/perldelta.pod > /tmp/perldelta.html |
2e831dfd | 391 | |
38195a8c DG |
392 | Another good HTML preview option is http://search.cpan.org/pod2html |
393 | ||
394 | If you make changes, be sure to commit them. | |
395 | ||
dc0a4df9 DM |
396 | |
397 | =head3 build a clean perl | |
8c35d285 | 398 | |
a0db33fe DM |
399 | Make sure you have a gitwise-clean perl directory (no modified files, |
400 | unpushed commits etc): | |
8c35d285 | 401 | |
a0db33fe | 402 | $ git status |
24c5e187 | 403 | $ git clean -dxf |
8c35d285 | 404 | |
dc0a4df9 | 405 | then configure and build perl so that you have a Makefile and porting tools: |
8c35d285 | 406 | |
52a66c2c | 407 | $ ./Configure -Dusedevel -des && make |
8c35d285 | 408 | |
dc0a4df9 DM |
409 | |
410 | =head3 update Module::CoreList | |
8c35d285 | 411 | |
1bac61bb | 412 | Update C<Module::CoreList> with module version data for the new release. |
bfadf2ba | 413 | |
6a958a95 | 414 | Note that if this is a MAINT release, you should run the following actions |
1bac61bb | 415 | from the maint branch, but commit the C<CoreList.pm> changes in |
a9d1f3db LB |
416 | I<blead> and subsequently cherry-pick any releases since the last |
417 | maint release and then your recent commit. XXX need a better example | |
bfadf2ba | 418 | |
a0db33fe | 419 | F<corelist.pl> uses ftp.funet.fi to verify information about dual-lived |
bfadf2ba | 420 | modules on CPAN. It can use a full, local CPAN mirror or fall back |
e8c01f92 SH |
421 | to C<wget> or C<curl> to fetch only package metadata remotely. (If you're |
422 | on Win32, then installing Cygwin is one way to have commands like C<wget> | |
423 | and C<curl> available.) | |
bfadf2ba JV |
424 | |
425 | (If you'd prefer to have a full CPAN mirror, see | |
426 | http://www.cpan.org/misc/cpan-faq.html#How_mirror_CPAN) | |
427 | ||
a0db33fe | 428 | Then change to your perl checkout, and if necessary, |
bfadf2ba | 429 | |
595f83ae | 430 | $ make |
bfadf2ba | 431 | |
81fc59ef DG |
432 | If this not the first update for this version (e.g. if it was updated |
433 | when the version number was originally bumped), first edit | |
d5bddf6e | 434 | F<dist/Module-CoreList/lib/Module/CoreList.pm> to delete the existing |
2ce7d676 RGS |
435 | entries for this version from the C<%released> and C<%version> hashes: |
436 | they will have a key like C<5.010001> for 5.10.1. | |
52a66c2c DM |
437 | |
438 | XXX the edit-in-place functionality of Porting/corelist.pl should | |
439 | be fixed to handle this automatically. | |
440 | ||
bf8ea215 | 441 | Then, If you have a local CPAN mirror, run: |
bfadf2ba | 442 | |
bfadf2ba JV |
443 | $ ./perl -Ilib Porting/corelist.pl ~/my-cpan-mirror |
444 | ||
445 | Otherwise, run: | |
446 | ||
bfadf2ba JV |
447 | $ ./perl -Ilib Porting/corelist.pl cpan |
448 | ||
52a66c2c | 449 | This will chug for a while, possibly reporting various warnings about |
2a720090 | 450 | badly-indexed CPAN modules unrelated to the modules actually in core. |
2ce7d676 | 451 | Assuming all goes well, it will update |
d5bddf6e | 452 | F<dist/Module-CoreList/lib/Module/CoreList.pm>. |
bfadf2ba JV |
453 | |
454 | Check that file over carefully: | |
455 | ||
d5bddf6e | 456 | $ git diff dist/Module-CoreList/lib/Module/CoreList.pm |
bfadf2ba | 457 | |
bfadf2ba JV |
458 | If necessary, bump C<$VERSION> (there's no need to do this for |
459 | every RC; in RC1, bump the version to a new clean number that will | |
460 | appear in the final release, and leave as-is for the later RCs and final). | |
461 | ||
462 | Edit the version number in the new C<< 'Module::CoreList' => 'X.YZ' >> | |
463 | entry, as that is likely to reflect the previous version number. | |
464 | ||
cb9af4c0 AB |
465 | Also edit Module::CoreList's new version number in its F<Changes> |
466 | file. | |
e8c01f92 | 467 | |
70855f8b FC |
468 | Add a perldelta entry for the new Module::CoreList version. |
469 | ||
3dbfcde0 AB |
470 | You should also add the version you're about to release to the |
471 | L<Module::CoreList/CAVEATS> section which enumerates the perl releases | |
472 | that Module::CoreList covers. | |
473 | ||
a0db33fe | 474 | In addition, if this is a final release (rather than a release candidate): |
bfadf2ba JV |
475 | |
476 | =over 4 | |
477 | ||
478 | =item * | |
479 | ||
480 | Update this version's entry in the C<%released> hash with today's date. | |
481 | ||
482 | =item * | |
483 | ||
484 | Make sure that the script has correctly updated the C<CAVEATS> section | |
485 | ||
486 | =back | |
487 | ||
488 | Finally, commit the new version of Module::CoreList: | |
6a958a95 | 489 | (unless this is for MAINT; in which case commit it to blead first, then |
a0db33fe | 490 | cherry-pick it back). |
bfadf2ba | 491 | |
770cf6ff | 492 | $ git commit -m 'Update Module::CoreList for 5.x.y' dist/Module-CoreList/lib/Module/CoreList.pm |
bfadf2ba | 493 | |
dc0a4df9 DM |
494 | |
495 | =head3 check MANIFEST | |
bfadf2ba | 496 | |
a0db33fe | 497 | Check that the manifest is sorted and correct: |
8c35d285 | 498 | |
a0db33fe | 499 | $ make distclean |
300b5357 | 500 | $ git clean -xdf # This shouldn't be necessary if distclean is correct |
a0db33fe | 501 | $ perl Porting/manicheck |
d5bddf6e | 502 | |
7081fd3a | 503 | If manicheck turns up anything wrong, update MANIFEST and begin this step again. |
a0db33fe | 504 | |
7081fd3a JV |
505 | $ ./configure -des -Dusedevel |
506 | $ make test_porting | |
a0db33fe DM |
507 | $ git commit -m 'Update MANIFEST' MANIFEST |
508 | ||
dc0a4df9 DM |
509 | |
510 | =head3 update perlhist.pod | |
a0db33fe | 511 | |
e8a7a70e | 512 | I<You MUST SKIP this step for a RC release> |
a0db33fe | 513 | |
e8a7a70e JV |
514 | Add an entry to F<pod/perlhist.pod> with the release date, e.g.: |
515 | ||
516 | David 5.10.1 2009-Aug-06 | |
a0db33fe DM |
517 | |
518 | Make sure that the correct pumpking is listed in the left-hand column, and | |
519 | if this is the first release under the stewardship of a new pumpking, make | |
520 | sure that his or her name is listed in the section entitled | |
521 | C<THE KEEPERS OF THE PUMPKIN>. | |
522 | ||
523 | Be sure to commit your changes: | |
524 | ||
525 | $ git commit -m 'add new release to perlhist' pod/perlhist.pod | |
8c35d285 | 526 | |
dc0a4df9 DM |
527 | |
528 | =head3 update patchlevel.h | |
8c35d285 | 529 | |
6a958a95 | 530 | I<You MUST SKIP this step for a BLEAD-POINT release> |
d7eb1120 | 531 | |
a42352ee DM |
532 | Update F<patchlevel.h> to add a C<-RC1>-or-whatever string; or, if this is |
533 | a final release, remove it. For example: | |
d7eb1120 DM |
534 | |
535 | static const char * const local_patches[] = { | |
536 | NULL | |
537 | + ,"RC1" | |
538 | PERL_GIT_UNPUSHED_COMMITS /* do not remove this line */ | |
539 | ||
540 | Be sure to commit your change: | |
541 | ||
542 | $ git commit -m 'bump version to RCnnn' patchlevel.h | |
543 | ||
dc0a4df9 DM |
544 | |
545 | =head3 build, test and check a fresh perl | |
d7eb1120 | 546 | |
a0db33fe DM |
547 | Build perl, then make sure it passes its own test suite, and installs: |
548 | ||
549 | $ git clean -xdf | |
a42352ee DM |
550 | $ ./Configure -des -Dprefix=/tmp/perl-5.x.y-pretest |
551 | ||
552 | # or if it's an odd-numbered version: | |
a0db33fe | 553 | $ ./Configure -des -Dusedevel -Dprefix=/tmp/perl-5.x.y-pretest |
a42352ee | 554 | |
a0db33fe DM |
555 | $ make test install |
556 | ||
52a66c2c DM |
557 | Check that the output of C</tmp/perl-5.x.y-pretest/bin/perl -v> and |
558 | C</tmp/perl-5.x.y-pretest/bin/perl -V> are as expected, | |
a0db33fe | 559 | especially as regards version numbers, patch and/or RC levels, and @INC |
52a66c2c DM |
560 | paths. Note that as they have been been built from a git working |
561 | directory, they will still identify themselves using git tags and | |
562 | commits. | |
563 | ||
564 | Then delete the temporary installation. | |
565 | ||
dc0a4df9 DM |
566 | |
567 | =head3 push the work so far | |
52a66c2c | 568 | |
a0db33fe DM |
569 | Push all your recent commits: |
570 | ||
571 | $ git push origin .... | |
572 | ||
96054f12 | 573 | |
dc0a4df9 | 574 | =head3 tag the release |
96054f12 | 575 | |
e8c01f92 | 576 | Tag the release (e.g.): |
96054f12 | 577 | |
b6d23947 | 578 | $ git tag v5.11.0 -m "First release of the v5.11 series!" |
e8c01f92 | 579 | |
6a958a95 | 580 | It is B<VERY> important that from this point forward, you not push |
f662f3b7 JV |
581 | your git changes to the Perl master repository. If anything goes |
582 | wrong before you publish your newly-created tag, you can delete | |
583 | and recreate it. Once you push your tag, we're stuck with it | |
584 | and you'll need to use a new version number for your release. | |
585 | ||
dc0a4df9 DM |
586 | |
587 | =head3 build the tarball | |
a0db33fe | 588 | |
0dcf3caa LB |
589 | Before you run the following, you might want to install 7-Zip (the |
590 | C<p7-full> package under Debian or the C<p7zip> port on MacPorts) or | |
591 | the AdvanceCOMP suite (e.g. the C<advancecomp> package under Debian, | |
592 | or the C<advancecomp> port on macports - 7-Zip on Windows is the | |
593 | same code as AdvanceCOMP, so Windows users get the smallest files | |
594 | first time). These compress about 5% smaller than gzip and bzip2. | |
595 | Over the lifetime of your distribution this will save a lot of | |
596 | people a small amount of download time and disk space, which adds | |
597 | up. | |
598 | ||
8c35d285 JV |
599 | Create a tarball. Use the C<-s> option to specify a suitable suffix for |
600 | the tarball and directory name: | |
601 | ||
602 | $ cd root/of/perl/tree | |
603 | $ make distclean | |
75a012fe DM |
604 | $ git clean -xdf # make sure perl and git agree on files |
605 | $ git status # and there's nothing lying around | |
8c35d285 | 606 | |
8c35d285 JV |
607 | $ perl Porting/makerel -b -s RC1 # for a release candidate |
608 | $ perl Porting/makerel -b # for a final release | |
609 | ||
610 | This creates the directory F<../perl-x.y.z-RC1> or similar, copies all | |
611 | the MANIFEST files into it, sets the correct permissions on them, | |
612 | adds DOS line endings to some, then tars it up as | |
613 | F<../perl-x.y.z-RC1.tar.gz>. With C<-b>, it also creates a C<tar.bz2> file. | |
614 | ||
6480287f MT |
615 | If you're getting your tarball suffixed with -uncommitted and you're sure |
616 | your changes were all committed, you can override the suffix with: | |
617 | ||
618 | $ perl Porting/makerel -b -s '' | |
96054f12 | 619 | |
8c35d285 JV |
620 | XXX if we go for extra tags and branches stuff, then add the extra details |
621 | here | |
622 | ||
dc0a4df9 | 623 | Finally, clean up the temporary directory, e.g. |
a42352ee DM |
624 | |
625 | $ rm -rf ../perl-x.y.z-RC1 | |
626 | ||
dc0a4df9 DM |
627 | |
628 | =head3 test the tarball | |
629 | ||
630 | =over 4 | |
631 | ||
a42352ee DM |
632 | =item * |
633 | ||
8c35d285 JV |
634 | Copy the tarballs (.gz and possibly .bz2) to a web server somewhere you |
635 | have access to. | |
636 | ||
637 | =item * | |
638 | ||
639 | Download the tarball to some other machine. For a release candidate, | |
640 | you really want to test your tarball on two or more different platforms | |
641 | and architectures. The #p5p IRC channel on irc.perl.org is a good place | |
642 | to find willing victims. | |
643 | ||
644 | =item * | |
645 | ||
646 | Check that basic configuration and tests work on each test machine: | |
647 | ||
648 | $ ./Configure -des && make all test | |
f6af4394 DM |
649 | |
650 | =item * | |
651 | ||
8c35d285 JV |
652 | Check that the test harness and install work on each test machine: |
653 | ||
a42352ee | 654 | $ make distclean |
8c35d285 | 655 | $ ./Configure -des -Dprefix=/install/path && make all test_harness install |
a42352ee | 656 | $ cd /install/path |
8c35d285 JV |
657 | |
658 | =item * | |
659 | ||
660 | Check that the output of C<perl -v> and C<perl -V> are as expected, | |
661 | especially as regards version numbers, patch and/or RC levels, and @INC | |
662 | paths. | |
663 | ||
664 | Note that the results may be different without a F<.git/> directory, | |
665 | which is why you should test from the tarball. | |
666 | ||
667 | =item * | |
668 | ||
459fc3ca DM |
669 | Run the Installation Verification Procedure utility: |
670 | ||
9651cacc | 671 | $ ./perl utils/perlivp |
459fc3ca DM |
672 | ... |
673 | All tests successful. | |
674 | $ | |
675 | ||
676 | =item * | |
677 | ||
d60a1044 DM |
678 | Compare the pathnames of all installed files with those of the previous |
679 | release (i.e. against the last installed tarball on this branch which you | |
680 | have previously verified using this same procedure). In particular, look | |
681 | for files in the wrong place, or files no longer included which should be. | |
682 | For example, suppose the about-to-be-released version is 5.10.1 and the | |
683 | previous is 5.10.0: | |
684 | ||
685 | cd installdir-5.10.0/ | |
686 | find . -type f | perl -pe's/5\.10\.0/5.10.1/g' | sort > /tmp/f1 | |
687 | cd installdir-5.10.1/ | |
688 | find . -type f | sort > /tmp/f2 | |
689 | diff -u /tmp/f[12] | |
690 | ||
691 | =item * | |
692 | ||
8c35d285 JV |
693 | Bootstrap the CPAN client on the clean install: |
694 | ||
16c60e4e | 695 | $ bin/perl -MCPAN -e "shell" |
8c35d285 | 696 | |
16c60e4e AB |
697 | If you're running this on Win32 you probably also need a set of Unix |
698 | command-line tools available for CPAN to function correctly without | |
e8c01f92 SH |
699 | Perl alternatives like LWP installed. Cygwin is an obvious choice.) |
700 | ||
8c35d285 JV |
701 | =item * |
702 | ||
a42352ee DM |
703 | Try installing a popular CPAN module that's reasonably complex and that |
704 | has dependencies; for example: | |
8c35d285 | 705 | |
a42352ee DM |
706 | CPAN> install Inline |
707 | CPAN> quit | |
8c35d285 JV |
708 | |
709 | Check that your perl can run this: | |
710 | ||
16c60e4e | 711 | $ bin/perl -lwe "use Inline C => q[int f() { return 42;}]; print f" |
a42352ee DM |
712 | 42 |
713 | $ | |
8c35d285 JV |
714 | |
715 | =item * | |
716 | ||
717 | Bootstrap the CPANPLUS client on the clean install: | |
718 | ||
75a012fe | 719 | $ bin/cpanp |
8c35d285 | 720 | |
e8c01f92 SH |
721 | (Again, on Win32 you'll need something like Cygwin installed, but make sure |
722 | that you don't end up with its various F<bin/cpan*> programs being found on | |
723 | the PATH before those of the Perl that you're trying to test.) | |
724 | ||
8c35d285 JV |
725 | =item * |
726 | ||
a42352ee | 727 | Install an XS module, for example: |
8c35d285 | 728 | |
a42352ee DM |
729 | CPAN Terminal> i DBI |
730 | CPAN Terminal> quit | |
731 | $ bin/perl -MDBI -e 1 | |
75a012fe | 732 | $ |
8c35d285 JV |
733 | |
734 | =item * | |
735 | ||
7f89f796 | 736 | Check that the L<perlbug> utility works. Try the following: |
47b1f096 | 737 | |
a14438df | 738 | $ bin/perlbug |
47b1f096 DM |
739 | ... |
740 | Subject: test bug report | |
741 | Local perl administrator [yourself]: | |
742 | Editor [vi]: | |
743 | Module: | |
744 | Category [core]: | |
745 | Severity [low]: | |
746 | (edit report) | |
747 | Action (Send/Display/Edit/Subject/Save to File): f | |
748 | Name of file to save message in [perlbug.rep]: | |
749 | Action (Send/Display/Edit/Subject/Save to File): q | |
750 | ||
751 | and carefully examine the output (in F<perlbug.rep]>), especially | |
752 | the "Locally applied patches" section. If everything appears okay, then | |
75a012fe DM |
753 | delete the file, and try it again, this time actually submitting the bug |
754 | report. Check that it shows up, then remember to close it! | |
47b1f096 | 755 | |
dc0a4df9 DM |
756 | =back |
757 | ||
758 | ||
759 | =head3 monitor smokes | |
47b1f096 | 760 | |
f6af4394 DM |
761 | Wait for the smoke tests to catch up with the commit which this release is |
762 | based on (or at least the last commit of any consequence). | |
7277a900 | 763 | |
f6af4394 DM |
764 | Then check that the smoke tests pass (particularly on Win32). If not, go |
765 | back and fix things. | |
7277a900 | 766 | |
6a958a95 | 767 | Note that for I<BLEAD-POINT> releases this may not be practical. It takes a |
1eefd7d5 | 768 | long time for the smokers to catch up, especially the Win32 |
6a958a95 DM |
769 | smokers. This is why we have a RC cycle for I<MAINT> and I<BLEAD-FINAL> |
770 | releases, but for I<BLEAD-POINT> releases sometimes the best you can do is | |
771 | to plead with people on IRC to test stuff on their platforms, fire away, | |
772 | and then hope for the best. | |
7277a900 | 773 | |
dc0a4df9 DM |
774 | |
775 | =head3 upload to PAUSE | |
7277a900 | 776 | |
f6af4394 | 777 | Once smoking is okay, upload it to PAUSE. This is the point of no return. |
db3f805e JV |
778 | If anything goes wrong after this point, you will need to re-prepare |
779 | a new release with a new minor version or RC number. | |
780 | ||
a14438df DM |
781 | https://pause.perl.org/ |
782 | ||
783 | (Login, then select 'Upload a file to CPAN') | |
784 | ||
45924287 RS |
785 | If your workstation is not connected to a high-bandwidth, |
786 | high-reliability connection to the Internet, you should probably use the | |
787 | "GET URL" feature (rather than "HTTP UPLOAD") to have PAUSE retrieve the | |
788 | new release from wherever you put it for testers to find it. This will | |
789 | eliminate anxious gnashing of teeth while you wait to see if your | |
790 | 15 megabyte HTTP upload successfully completes across your slow, twitchy | |
c27b4e97 SH |
791 | cable modem. You can make use of your home directory on dromedary for |
792 | this purpose: F<http://users.perl5.git.perl.org/~USERNAME> maps to | |
793 | F</home/USERNAME/public_html>, where F<USERNAME> is your login account | |
794 | on dromedary. I<Remember>: if your upload is partially successful, you | |
795 | may need to contact a PAUSE administrator or even bump the version of perl. | |
45924287 | 796 | |
a42352ee | 797 | Upload both the .gz and .bz2 versions of the tarball. |
f6af4394 | 798 | |
c27b4e97 | 799 | Wait until you receive notification emails from the PAUSE indexer |
38195a8c | 800 | confirming that your uploads have been received. IMPORTANT -- you will |
b28f69c2 Z |
801 | probably get an email that indexing has failed, due to module permissions. |
802 | This is considered normal. | |
38195a8c DG |
803 | |
804 | Do not proceed any further until you are sure that your tarballs are on | |
805 | CPAN. Check your authors directory on one of the "fast" CPAN mirrors | |
b28f69c2 | 806 | (e.g., cpan.hexten.net |
38195a8c | 807 | or cpan.cpantesters.org) to confirm that your uploads have been successful. |
c27b4e97 | 808 | |
dc0a4df9 DM |
809 | |
810 | =head3 publish tag | |
210de33e | 811 | |
f662f3b7 | 812 | Now that you've shipped the new perl release to PAUSE, it's |
e8c01f92 | 813 | time to publish the tag you created earlier to the public git repo (e.g.): |
f662f3b7 JV |
814 | |
815 | $ git push origin tag v5.11.0 | |
f6af4394 | 816 | |
dc0a4df9 DM |
817 | |
818 | =head3 disarm patchlevel.h | |
f6af4394 | 819 | |
6a958a95 | 820 | I<You MUST SKIP this step for BLEAD-POINT release> |
113f3f4c | 821 | |
a42352ee | 822 | Disarm the F<patchlevel.h> change; for example, |
d7eb1120 DM |
823 | |
824 | static const char * const local_patches[] = { | |
825 | NULL | |
826 | - ,"RC1" | |
827 | PERL_GIT_UNPUSHED_COMMITS /* do not remove this line */ | |
828 | ||
829 | Be sure to commit your change: | |
830 | ||
831 | $ git commit -m 'disarm RCnnn bump' patchlevel.h | |
a14438df | 832 | $ git push origin .... |
d7eb1120 | 833 | |
2e831dfd | 834 | |
dc0a4df9 DM |
835 | |
836 | =head3 announce to p5p | |
2e831dfd | 837 | |
db3f805e | 838 | Mail p5p to announce your new release, with a quote you prepared earlier. |
f6af4394 | 839 | |
dc0a4df9 DM |
840 | |
841 | =head3 update epigraphs.pod | |
f6af4394 | 842 | |
85531b0a DG |
843 | Add your quote to F<Porting/epigraphs.pod> and commit it. |
844 | ||
dc0a4df9 DM |
845 | |
846 | =head3 Module::CoreList nagging | |
85531b0a | 847 | |
bc4c40f2 | 848 | I<You MUST SKIP this step for RC> |
8c35d285 | 849 | |
75a012fe DM |
850 | Remind the current maintainer of C<Module::CoreList> to push a new release |
851 | to CPAN. | |
7277a900 | 852 | |
dc0a4df9 DM |
853 | |
854 | =head3 new perldelta | |
a2cba4bc | 855 | |
bc4c40f2 | 856 | I<You MUST SKIP this step for RC> |
7277a900 | 857 | |
c5b87fed | 858 | Create a new perldelta. |
7277a900 | 859 | |
17163f85 DM |
860 | B<Note>: currently, the buildtoc below must be run in a I<built> perl source |
861 | directory, as at least one of the pod files it expects to find is | |
862 | autogenerated: perluniprops.pod. But you can't build perl if you've added | |
863 | the new perldelta file and not updated toc. So, make sure you have a built | |
dc0a4df9 | 864 | perl (with a pod/perluniprops.pod file) now, I<before> continuing. |
17163f85 DM |
865 | |
866 | First, update the F<pod/.gitignore> file to ignore the next | |
867 | release's generated F<pod/perlNNNdelta.pod> file rather than this release's | |
5ef3945b SH |
868 | one which we are about to set in stone (where NNN is the perl version number |
869 | without the dots. i.e. 5135 for 5.13.5). | |
870 | ||
17163f85 DM |
871 | $ (edit pod/.gitignore ) |
872 | $ git add pod/.gitignore | |
8e967a1c | 873 | |
17163f85 DM |
874 | Then, move the existing F<pod/perldelta.pod> to F<pod/perlNNNdelta.pod>, |
875 | and edit the moved delta file to change the C<NAME> from C<perldelta> to | |
876 | C<perlNNNdelta>. For example, assuming you just released 5.10.1, and are | |
877 | about to create the 5.10.2 perldelta: | |
8e967a1c | 878 | |
17163f85 | 879 | $ rm pod/perl5101delta.pod # remove the auto-generated file, if any |
c5b87fed FR |
880 | $ git mv pod/perldelta.pod pod/perl5101delta.pod |
881 | $ (edit pod/perl5101delta.pod to retitle) | |
8e967a1c | 882 | $ git add pod/perl5101delta.pod |
c5b87fed | 883 | |
17163f85 DM |
884 | Then create a new empty perldelta.pod file for the new release; see |
885 | F<Porting/how_to_write_a_perldelta.pod>. You should be able to do this by | |
886 | just copying in a skeleton template and then doing a quick fix up of the | |
887 | version numbers. Then commit the move and the new file. | |
888 | ||
c5b87fed FR |
889 | $ cp -i Porting/perldelta_template.pod pod/perldelta.pod |
890 | $ (edit pod/perldelta.pod) | |
891 | $ git add pod/perldelta.pod | |
892 | $ git commit -m 'create perldelta for 5.10.2' | |
8e967a1c | 893 | |
dc0a4df9 | 894 | =head3 update perldelta TOC and references |
17163f85 DM |
895 | |
896 | Now you need to update various tables of contents related to perldelta, | |
897 | most of which can be generated automatically. | |
7277a900 | 898 | |
8a51675c FC |
899 | Edit F<pod.lst>: add the new entry for the perlNNNdelta file for the |
900 | current version (the file that will be symlinked to perldelta). | |
7277a900 | 901 | |
17163f85 DM |
902 | Manually create a temporary link to the new delta file; normally this is |
903 | done from the Makefile, but the Makefile is updated by buildtoc, and | |
904 | buildtoc won't run without the file there: | |
905 | ||
906 | $ ln -s perldelta.pod pod/perl5102delta.pod | |
907 | ||
75a012fe DM |
908 | Run C<perl pod/buildtoc --build-all> to update the F<perldelta> version in |
909 | the following files: | |
57433fbf JV |
910 | |
911 | MANIFEST | |
75a012fe | 912 | Makefile.SH |
57433fbf | 913 | pod/perl.pod |
57433fbf | 914 | vms/descrip_mms.template |
75a012fe DM |
915 | win32/Makefile |
916 | win32/makefile.mk | |
917 | win32/pod.mak | |
918 | ||
75a012fe DM |
919 | Finally, commit: |
920 | ||
c5b87fed | 921 | $ git commit -a -m 'update TOC for perlNNNdelta' |
75a012fe | 922 | |
21768cb3 FC |
923 | At this point you may want to compare the commit with a previous bump to |
924 | see if they look similar. See commit dd885b5 for an example of a | |
75a012fe | 925 | previous version bump. |
57433fbf | 926 | |
dc0a4df9 DM |
927 | |
928 | =head3 bump version | |
57433fbf | 929 | |
6a958a95 | 930 | I<You MUST SKIP this step for RC, BLEAD-POINT, MAINT> |
dc0a62a1 | 931 | |
6a958a95 DM |
932 | If this was a BLEAD-FINAL release (i.e. the first release of a new maint |
933 | series, 5.x.0 where x is even), then bump the version in the blead branch | |
934 | in git, e.g. 5.12.0 to 5.13.0. | |
17163f85 DM |
935 | |
936 | First, add a new feature bundle to F<lib/feature.pm>, initially by just | |
937 | copying the exiting entry, and bump the file's $VERSION; e.g. | |
938 | ||
939 | "5.14" => [qw(switch say state unicode_strings)], | |
940 | + "5.15" => [qw(switch say state unicode_strings)], | |
addebd58 | 941 | |
dc0a4df9 DM |
942 | Then follow the section L<"Bump the version number"> to bump the version |
943 | in the remaining files and test and commit. | |
17163f85 | 944 | |
17163f85 | 945 | |
dc0a4df9 DM |
946 | =head3 push commits |
947 | ||
948 | Finally, push any commits done above. | |
949 | ||
950 | $ git push origin .... | |
951 | ||
952 | ||
953 | =head3 create maint branch | |
17163f85 | 954 | |
6a958a95 | 955 | I<You MUST SKIP this step for RC, BLEAD-POINT, MAINT> |
17163f85 | 956 | |
6a958a95 DM |
957 | If this was a BLEAD-FINAL release (i.e. the first release of a new maint |
958 | series, 5.x.0 where x is even), then create a new maint branch based on | |
959 | the commit tagged as the current release. | |
7277a900 | 960 | |
233ca920 JV |
961 | Assuming you're using git 1.7.x or newer: |
962 | ||
17163f85 | 963 | $ git checkout -b maint-5.12 v5.12.0 |
233ca920 | 964 | $ git push origin -u maint-5.12 |
addebd58 | 965 | |
dc0a4df9 | 966 | |
d5722260 DK |
967 | =head3 make the maint branch available in the APC |
968 | ||
969 | Clone the new branch into /srv/gitcommon/branches on camel so the APC will | |
970 | receive its changes. | |
971 | ||
07697565 | 972 | $ git clone --branch maint-5.14 /gitroot/perl.git \ |
d5722260 | 973 | ? /srv/gitcommon/branches/perl-5.14.x |
07697565 | 974 | $ chmod -R g=u /srv/gitcommon/branches/perl-5.14.x |
d5722260 DK |
975 | |
976 | And nag the sysadmins to make this directory available via rsync. | |
977 | ||
978 | ||
dc0a4df9 | 979 | =head3 copy perldelta.pod to other branches |
addebd58 | 980 | |
6a958a95 | 981 | I<You MUST SKIP this step for RC, BLEAD-POINT> |
8c35d285 | 982 | |
c5b87fed | 983 | Copy the perldelta.pod for this release into the other branches; for |
75a012fe | 984 | example: |
7277a900 | 985 | |
c5b87fed | 986 | $ cp -i ../5.10.x/pod/perldelta.pod pod/perl5101delta.pod # for example |
75a012fe DM |
987 | $ git add pod/perl5101delta.pod |
988 | ||
989 | Edit F<pod.lst> to add an entry for the file, e.g.: | |
990 | ||
991 | perl5101delta Perl changes in version 5.10.1 | |
bc4c40f2 | 992 | |
75a012fe | 993 | Then rebuild various files: |
7277a900 | 994 | |
75a012fe DM |
995 | $ perl pod/buildtoc --build-all |
996 | ||
997 | Finally, commit: | |
998 | ||
999 | $ git commit -a -m 'add perlXXXdelta' | |
7277a900 | 1000 | |
dc0a4df9 DM |
1001 | |
1002 | =head3 update perlhist.pod in other branches | |
7277a900 | 1003 | |
f6af4394 | 1004 | Make sure any recent F<pod/perlhist.pod> entries are copied to |
e8a7a70e | 1005 | F<perlhist.pod> on other branches |
f6af4394 | 1006 | e.g. |
7277a900 | 1007 | |
f6af4394 | 1008 | 5.8.9 2008-Dec-14 |
7277a900 | 1009 | |
dc0a4df9 DM |
1010 | |
1011 | =head3 bump RT version number | |
6e40fbf9 | 1012 | |
1530afd8 LB |
1013 | Log into http://rt.perl.org/ and check whether the new version is |
1014 | in the RT fields C<Perl Version> and C<Fixed In>. If not, send an | |
1015 | email to C<perlbug-admin at perl.org> requesting this. | |
dc0a4df9 DM |
1016 | |
1017 | =head3 Relax! | |
a3738a12 | 1018 | |
bc4c40f2 JV |
1019 | I<You MUST RETIRE to your preferred PUB, CAFE or SEASIDE VILLA for some |
1020 | much-needed rest and relaxation>. | |
8c35d285 JV |
1021 | |
1022 | Thanks for releasing perl! | |
1023 | ||
7277a900 | 1024 | |
b28f69c2 Z |
1025 | =head2 Building a release - the day after |
1026 | ||
dc0a4df9 DM |
1027 | =head3 check tarball availability |
1028 | ||
1029 | Check various website entries to make sure the that tarball has appeared | |
1030 | and is properly indexed: | |
1031 | ||
b28f69c2 Z |
1032 | =over 4 |
1033 | ||
1034 | =item * | |
1035 | ||
98df743a Z |
1036 | Check your author directory under L<http://www.cpan.org/authors/id/> |
1037 | to ensure that the tarballs are available on the website. | |
b28f69c2 Z |
1038 | |
1039 | =item * | |
1040 | ||
98df743a Z |
1041 | Check C</src> on CPAN (on a fast mirror) to ensure that links to |
1042 | the new tarballs have appeared. There should be links in C</src/5.0> | |
1043 | (which is accumulating all new versions), links in C</src> (which shows | |
1044 | only the latest version on each branch), and an appropriate mention in | |
1045 | C</src/README.html> (which describes the latest versions). | |
1046 | ||
1047 | These links should appear automatically, some hours after upload. | |
1048 | If they don't, or the C<README.html> description is inadequate, | |
1049 | ask Ask <ask@perl.org>. | |
b28f69c2 Z |
1050 | |
1051 | =item * | |
1052 | ||
98df743a Z |
1053 | Check L<http://www.cpan.org/src/> to ensure that the C</src> updates |
1054 | have been correctly mirrored to the website. | |
1055 | If they haven't, ask Ask <ask@perl.org>. | |
1056 | ||
1057 | =item * | |
b28f69c2 | 1058 | |
98df743a Z |
1059 | Check L<http://search.cpan.org> to see if it has indexed the distribution. |
1060 | It should be visible at a URL like C<http://search.cpan.org/dist/perl-5.10.1/>. | |
b28f69c2 | 1061 | |
dc0a4df9 | 1062 | =back |
b28f69c2 | 1063 | |
dc0a4df9 DM |
1064 | |
1065 | =head3 update dev.perl.org | |
1066 | ||
1067 | I<This step ONLY for BLEAD-POINT and MAINT> | |
98df743a | 1068 | |
e294df83 | 1069 | Ask Leo Lapworth to update L<http://dev.perl.org/perl5/>. |
b28f69c2 | 1070 | |
b28f69c2 | 1071 | |
7277a900 GS |
1072 | =head1 SOURCE |
1073 | ||
f6af4394 DM |
1074 | Based on |
1075 | http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2009-05/msg00608.html, | |
1076 | plus a whole bunch of other sources, including private correspondence. | |
7277a900 GS |
1077 | |
1078 | =cut | |
1079 |