Add option to run bump after update #11942

carlos-granados · 2024-04-22T11:48:44Z

Adds a new bump-after-update config parameter
Adds a new bump-after-update option to the update command

If the bump-after-update config parameter is set or the bump-after-update option is passed to the update command, it will run the bump command after finishing the update. This command will only be run if the update finishes successfully

If the config parameter or the option are set to dev or no-dev then only the corresponding dependencies will be bumped.

The dry-run option passed to the update command will also be used for the bump command

If any packages are listed in the update command, this same package list will be used by the bump command.

Includes updates to the documentation and new tests

Fixes #11906

carlos-granados · 2024-04-22T12:30:03Z

I can see that the PHP 8.4 tests are failing but the failures seem unrelated to these changes and they also seem to happen in the main branch

carlos-granados · 2024-04-22T14:05:21Z

tests/Composer/Test/Command/UpdateCommandTest.php

    {
        $this->initTempComposer($composerJson);

+        if ($createLock) {


The bump command needs that a lock file exists, so when testing the bump-after-update version we need to create one

Seldaek

Thanks for the PR, after a quick review just one comment but I'll need to take a closer look when I'm back at my desk :)

Seldaek · 2024-04-23T11:42:18Z

doc/06-config.md

@@ -476,4 +476,9 @@ throw, but you can set this config option to `["example.org"]` to allow using sv
 URLs on that hostname. This is a better/safer alternative to disabling `secure-http`
 altogether.

+## bump-after-update
+
+Defaults to false. If set to true, Composer will run the Bump command after running


I think this could be a string|bool that also accepts "no-dev" and "dev" as values to configure the *-only flags.

This suggestion sounds good. I'll wait until you come back and are able to take a deeper look. If you still feel this is the way to go, I'll modify the PR

Yes please :) Definitely feel like this would be an improvement.

Seldaek · 2024-04-28T15:30:33Z

src/Composer/Command/BumpCommand.php

+        bool $noDevOnly,
+        bool $dryRun,
+        array $packagesFilter,
+        bool $calledFromUpdate = false


Seems unused and unnecessary?

Seldaek · 2024-04-28T15:31:45Z

src/Composer/Command/UpdateCommand.php

+
+        if ($bumpAfterUpdate) {
+            if ($result === 0) {
+                $io->writeError('<info>Running Bump after Update.</info>');


Suggested change

$io->writeError('<info>Running Bump after Update.</info>');

$io->writeError('<info>Bumping dependencies</info>');

Seldaek · 2024-04-28T15:32:11Z

src/Composer/Command/UpdateCommand.php

+            } else {
+                $io->writeError('<warning>Not running Bump after Update because the update command did not finish successfully.</warning>');


I don't think this is needed.

Suggested change

} else {

$io->writeError('<warning>Not running Bump after Update because the update command did not finish successfully.</warning>');

… of texts

cafferata · 2024-08-30T11:31:10Z

Hi @Seldaek, is there a reason why this GitHub pull request was not receive a (re)review the past four months? Has this perhaps been lost sight of? No rush, I saw other GitHub pull requests being reviewed/merged. So I was wondering how this works within your available time. Of course an answer of no time/priority is also completely valid. ☺️

Seldaek · 2024-09-02T08:54:21Z

It's just targetting 2.8 and I was focused on shipping patch releases for 2.7 so far.. kinda buffering 2.8 PRs until I'm ready to work on those because once I branch it out then I need to merge 2.7 into 2.8 which is more work for me.

lyrixx · 2024-09-02T15:45:18Z

Oh, thanks for this PR. I had spare time, and decided to try to fix my issue. And I totally miss your PR :/
For the record, I had another approach, were I factorized the code in a new service: lyrixx@df8a25b

Seldaek

Mostly found some minor wording style issues, and one minor edge case in the code, overall pretty solid PR thanks! And sorry for the delay :)

doc/03-cli.md

doc/06-config.md

res/composer-schema.json

src/Composer/Command/BumpCommand.php

src/Composer/Command/UpdateCommand.php

tests/Composer/Test/Command/UpdateCommandTest.php

stof · 2024-11-04T14:07:45Z

res/composer-schema.json

@@ -663,6 +663,10 @@
                    "type": ["boolean", "string"],
                    "description": "Defaults to \"php-only\" which checks only the PHP version. Setting to true will also check the presence of required PHP extensions. If set to false, Composer will not create and require a platform_check.php file as part of the autoloader bootstrap."
                },
+                "bump-after-update": {
+                    "type": ["string", "boolean"],


this should use enum to restrict the supported strings

stof · 2024-11-04T14:09:04Z

tests/Composer/Test/Command/UpdateCommandTest.php

+Bumping dependencies
+<warning>Warning: Bumping dependency constraints is not recommended for libraries as it will narrow down your dependencies and may cause problems for your users.</warning>
+<warning>If your package is not a library, you can explicitly specify the "type" by using "composer config type project".</warning>
+<warning>Alternatively you can use --dev-only to only bump dependencies within "require-dev".</warning>


this --dev-only option is confusing when running this as part of composer update instead of composer bump

stof · 2024-11-04T14:10:31Z

src/Composer/Command/UpdateCommand.php

@@ -85,6 +85,7 @@ protected function configure()
                new InputOption('minimal-changes', 'm', InputOption::VALUE_NONE, 'During a partial update with -w/-W, only perform absolutely necessary changes to transitive dependencies (can also be set via the COMPOSER_MINIMAL_CHANGES=1 env var).'),
                new InputOption('interactive', 'i', InputOption::VALUE_NONE, 'Interactive interface with autocompletion to select the packages to update.'),
                new InputOption('root-reqs', null, InputOption::VALUE_NONE, 'Restricts the update to your first degree dependencies.'),
+                new InputOption('bump-after-update', null, InputOption::VALUE_OPTIONAL, 'Runs bump after performing the update.', false, ['dev', 'no-dev', 'all']),


using InputOption::VALUE_OPTIONAL is confusing here, because it makes composer update --bump-after-update valid during argument validation, but this would still make it use the default value (i.e. false). This should probably be using VALUE_REQUIRED instead.

carlos-granados force-pushed the add-bump-after-update-option branch 2 times, most recently from 6903fb0 to cc20ff5 Compare April 22, 2024 12:11

carlos-granados force-pushed the add-bump-after-update-option branch 2 times, most recently from 0d8312d to 0d9f1b9 Compare April 22, 2024 14:03

carlos-granados commented Apr 22, 2024

View reviewed changes

Seldaek requested changes Apr 23, 2024

View reviewed changes

Seldaek reviewed Apr 28, 2024

View reviewed changes

Seldaek added this to the 2.8 milestone Apr 28, 2024

Seldaek added the Feature label Apr 28, 2024

carlos-granados added 2 commits April 29, 2024 13:10

Add option to run bump after update

7328dec

Convert the option into a bool | string parameter and change a couple…

1d13727

… of texts

carlos-granados force-pushed the add-bump-after-update-option branch from 0d9f1b9 to 1d13727 Compare April 29, 2024 11:48

carlos-granados requested a review from Seldaek April 29, 2024 11:48

Seldaek approved these changes Sep 18, 2024

View reviewed changes

Seldaek added 2 commits September 18, 2024 15:21

Apply suggestions from code review

8f6427d

Merge branch 'main' into add-bump-after-update-option

298e1d4

Seldaek reviewed Sep 18, 2024

View reviewed changes

tests/Composer/Test/Command/UpdateCommandTest.php Outdated Show resolved Hide resolved

Fix tests

4467ba5

Seldaek merged commit c8838f1 into composer:main Sep 18, 2024
20 checks passed

IndraGunawan mentioned this pull request Oct 6, 2024

leverage bump-after-update config on Composer 2.8 dependabot/dependabot-core#10733

Open

1 task

stof reviewed Nov 4, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add option to run bump after update #11942

Add option to run bump after update #11942

carlos-granados commented Apr 22, 2024 •

edited

Loading

carlos-granados commented Apr 22, 2024

carlos-granados Apr 22, 2024 •

edited

Loading

Seldaek left a comment

Seldaek Apr 23, 2024

carlos-granados Apr 23, 2024

Seldaek Apr 28, 2024

Seldaek Apr 28, 2024

Seldaek Apr 28, 2024

Seldaek Apr 28, 2024

cafferata commented Aug 30, 2024

Seldaek commented Sep 2, 2024

lyrixx commented Sep 2, 2024

Seldaek left a comment

stof Nov 4, 2024

stof Nov 4, 2024

stof Nov 4, 2024

	$io->writeError('<info>Running Bump after Update.</info>');
	$io->writeError('<info>Bumping dependencies</info>');

		} else {
		$io->writeError('<warning>Not running Bump after Update because the update command did not finish successfully.</warning>');

Add option to run bump after update #11942

Add option to run bump after update #11942

Conversation

carlos-granados commented Apr 22, 2024 • edited Loading

carlos-granados commented Apr 22, 2024

carlos-granados Apr 22, 2024 • edited Loading

Choose a reason for hiding this comment

Seldaek left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cafferata commented Aug 30, 2024

Seldaek commented Sep 2, 2024

lyrixx commented Sep 2, 2024

Seldaek left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

carlos-granados commented Apr 22, 2024 •

edited

Loading

carlos-granados Apr 22, 2024 •

edited

Loading