Skip to content

Commit 8f63201

Browse files
thibaultduponchellekhwilliamson
authored andcommitted
RMG: Make it linear for Bump the version number taking advantage of make-rmg-checklist
1 parent 42a09c0 commit 8f63201

File tree

1 file changed

+55
-11
lines changed

1 file changed

+55
-11
lines changed

Porting/release_managers_guide.pod

Lines changed: 55 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -483,10 +483,9 @@ You won't be able to automatically fill in the "Updated Modules" section until
483483
after L<Module::CoreList> is updated (as described below in
484484
L</"Update Module::CoreList">).
485485

486-
=head3 Bump the version number
486+
=for checklist skip BLEAD-POINT
487487

488-
Do not do this yet for a BLEAD-POINT release! You will do this at the end of
489-
the release process (after building the final tarball, tagging etc).
488+
=head3 Bump the version number
490489

491490
Increase the version number (e.g. from 5.12.0 to 5.12.1).
492491

@@ -1377,9 +1376,9 @@ At this point you may want to compare the commit with a previous bump to
13771376
see if they look similar. See commit ba03bc34a4 for an example of a
13781377
previous version bump.
13791378

1380-
=for checklist skip MAINT RC
1379+
=for checklist skip BLEAD-POINT RC MAINT
13811380

1382-
=head3 Bump version
1381+
=head3 Bump the feature bundles
13831382

13841383
I<You MUST SKIP this step for RC and MAINT>
13851384

@@ -1396,12 +1395,6 @@ marker); e.g.
13961395

13971396
Run F<regen/feature.pl> to propagate the changes to F<lib/feature.pm>.
13981397

1399-
Then follow the section L</"Bump the version number"> to bump the version
1400-
in the remaining files and test and commit.
1401-
1402-
If this was a BLEAD-POINT release, then just follow the section
1403-
L</"Bump the version number">.
1404-
14051398
After bumping the version, follow the section L</"Update INSTALL"> to
14061399
ensure all version number references are correct.
14071400

@@ -1417,6 +1410,57 @@ reports to arise. (The opposite problem -- trying to figure out why there
14171410
introduced later -- shouldn't arise for MAINT releases since they should,
14181411
in theory, only contain bug fixes but never regressions.))
14191412

1413+
=for checklist skip RC MAINT
1414+
1415+
=head3 Bump the version number
1416+
1417+
Increase the version number (e.g. from 5.12.0 to 5.12.1).
1418+
1419+
There is a tool to semi-automate this process:
1420+
1421+
$ ./perl -Ilib Porting/bump-perl-version -i 5.10.0 5.10.1
1422+
1423+
Remember that this tool is largely just grepping for '5.10.0' or whatever,
1424+
so it will generate false positives. Be careful not change text like
1425+
"this was fixed in 5.10.0"!
1426+
1427+
Use git status and git diff to select changes you want to keep.
1428+
1429+
Be particularly careful with F<INSTALL>, which contains a mixture of
1430+
C<5.10.0>-type strings, some of which need bumping on every release, and
1431+
some of which need to be left unchanged.
1432+
See below in L</"Update INSTALL"> for more details.
1433+
1434+
After editing, you may need to regen opcodes:
1435+
1436+
$ ./perl -Ilib regen/opcode.pl
1437+
1438+
Test your changes:
1439+
1440+
$ git clean -xdf # careful if you don't have local files to keep!
1441+
$ ./Configure -des -Dusedevel
1442+
$ make
1443+
$ make test
1444+
1445+
Do note that at this stage, porting tests will fail. They will continue
1446+
to fail until you've updated Module::CoreList, as described below.
1447+
1448+
Commit your changes:
1449+
1450+
$ git status
1451+
$ git diff
1452+
B<review the delta carefully>
1453+
1454+
$ git commit -a -m 'Bump the perl version in various places for 5.X.Y'
1455+
1456+
At this point you may want to compare the commit with a previous bump to
1457+
see if they look similar. See commit f7cf42bb69 for an example of a
1458+
previous version bump.
1459+
1460+
When the version number is bumped, you should also update Module::CoreList
1461+
(as described in L</"Update Module::CoreList">) to reflect the new
1462+
version number.
1463+
14201464
=head3 Clean build and test
14211465

14221466
Run a clean build and test to make sure nothing obvious is broken. This is

0 commit comments

Comments
 (0)