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