Magento 2: Changed upgrading database (#3812)

* Changed step to upgrade the DB only instead of Magento and execute it once if multiple servers are selected for the deployment

* Bugfix: Added once() to task instead of run commando. Regenerated docs.

* Improvement: Changed documentation to reflect that the database step is only executed once.

Author: dverkade

docs/recipe/magento2.md

@@ -353,7 +353,7 @@ true
 
 
 ### artifact_file
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L343)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L344)
 
 The file the artifact is saved to
 
@@ -363,7 +363,7 @@ The file the artifact is saved to
 
 
 ### artifact_dir
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L346)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L347)
 
 The directory the artifact is saved in
 
@@ -373,7 +373,7 @@ The directory the artifact is saved in
 
 
 ### artifact_excludes_file
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L350)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L351)
 
 Points to a file with a list of files to exclude from packaging.
 The format is as with the `tar --exclude-from=[file]` option
@@ -384,7 +384,7 @@ The format is as with the `tar --exclude-from=[file]` option
 
 
 ### build_from_repo
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L353)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L354)
 
 If set to true, the artifact is built from a clean copy of the project repository instead of the current working directory
 
@@ -394,7 +394,7 @@ false
 
 
 ### repository
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L356)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L357)
 
 Overrides [repository](/docs/recipe/common.md#repository) from `recipe/common.php`.
 
@@ -406,7 +406,7 @@ null
 
 
 ### artifact_path
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L359)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L360)
 
 The relative path to the artifact file. If the directory does not exist, it will be created
 
@@ -419,7 +419,7 @@ return get('artifact_dir') . '/' . get('artifact_file');
 
 
 ### bin/tar
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L367)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L368)
 
 The location of the tar command. On MacOS you should have installed gtar, as it supports the required settings
 :::info Autogenerated
@@ -430,14 +430,14 @@ The value of this configuration is autogenerated on access.
 
 
 ### additional_shared_files
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L439)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L440)
 
 Array of shared files that will be added to the default shared_files without overriding
 
 
 
 ### additional_shared_dirs
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L441)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L442)
 
 Array of shared directories that will be added to the default shared_dirs without overriding
 
@@ -544,21 +544,21 @@ Config Import.
 ### magento:upgrade:db
 [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L300)
 
-Upgrades magento database.
+Upgrades magento database. This task is only excuted once when multiple hosts have been selected for deployment.
 
 
 
 
 ### magento:cache:flush
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L309)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L310)
 
 Flushes Magento Cache.
 
 
 
 
 ### deploy:magento
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L314)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L315)
 
 Magento2 deployment operations.
 
@@ -575,7 +575,7 @@ This task is group task which contains next tasks:
 
 
 ### magento:build
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L324)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L325)
 
 Magento2 build operations.
 
@@ -588,7 +588,7 @@ This task is group task which contains next tasks:
 
 
 ### deploy
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L330)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L331)
 
 Deploys your project.
 
@@ -604,47 +604,47 @@ This task is group task which contains next tasks:
 
 
 ### artifact:package
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L378)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L379)
 
 Packages all relevant files in an artifact.
 
 
 
 
 ### artifact:upload
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L388)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L389)
 
 Uploads artifact in release folder for extraction.
 
 
 
 
 ### artifact:extract
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L393)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L394)
 
 Extracts artifact in release path.
 
 
 
 
 ### build:remove-generated
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L399)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L400)
 
 Clears generated files prior to building.
 
 
 
 
 ### build:prepare
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L404)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L405)
 
 Prepare local artifact build.
 
 
 
 
 ### artifact:build
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L429)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L430)
 
 Builds an artifact.
 
@@ -661,15 +661,15 @@ This task is group task which contains next tasks:
 
 
 ### deploy:additional-shared
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L445)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L446)
 
 Adds additional files and dirs to the list of shared files and dirs.
 
 
 
 
 ### magento:set_cache_prefix
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L460)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L461)
 
 Update cache id_prefix.
 
@@ -683,15 +683,15 @@ after('deploy:magento', 'magento:cleanup_cache_prefix');
 
 
 ### magento:cleanup_cache_prefix
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L500)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L501)
 
 Cleanup cache id_prefix env files.
 
 After successful deployment, move the tmp_env.php file to env.php ready for next deployment
 
 
 ### magento:cron:stop
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L516)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L517)
 
 Remove cron from crontab and kill running cron jobs.
 
@@ -703,7 +703,7 @@ To use this feature, add the following to your deployer scripts:
 
 
 ### magento:cron:install
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L532)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L533)
 
 Install cron in crontab.
 
@@ -715,7 +715,7 @@ To use this feature, add the following to your deployer scripts:
 
 
 ### artifact:prepare
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L538)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L539)
 
 Prepares an artifact on the target server.
 
@@ -735,7 +735,7 @@ This task is group task which contains next tasks:
 
 
 ### artifact:finish
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L551)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L552)
 
 Executes the tasks after artifact is released.
 
@@ -750,7 +750,7 @@ This task is group task which contains next tasks:
 
 
 ### artifact:deploy
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L560)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L561)
 
 Actually releases the artifact deployment.
 

recipe/magento2.php

@@ -299,11 +299,12 @@ function magentoDeployAssetsSplit(string $area)
 desc('Upgrades magento database');
 task('magento:upgrade:db', function () {
     if (get('database_upgrade_needed')) {
-        run("{{bin/php}} {{bin/magento}} setup:upgrade --keep-generated --no-interaction");
+        run("{{bin/php}} {{bin/magento}} setup:db-schema:upgrade --no-interaction");
+        run("{{bin/php}} {{bin/magento}} setup:db-data:upgrade --no-interaction");
     } else {
         writeln('Database schema is up to date => upgrade skipped');
     }
-});
+})->once();
 
 desc('Flushes Magento Cache');
 task('magento:cache:flush', function () {