Skip to content

Magento 2 Recipe: Fix import needed after deployment failure during upgrade #4180 #4181

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
antonmedv merged 17 commits into from
May 16, 2026
Merged

Magento 2 Recipe: Fix import needed after deployment failure during upgrade #4180 #4181

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
7b20fa6
Fix config import needed on revert. #4180
carlos-reynosa Mar 7, 2026
0c06c62
Run docgen
carlos-reynosa Mar 7, 2026
d1f0fde
Fix code quality and style
carlos-reynosa Mar 7, 2026
d9252b4
Update docs
carlos-reynosa Mar 7, 2026
bdb600b
Update recipe/magento2.php
carlos-reynosa May 15, 2026
1e99850
Ensure bin/magento commands run on last secussfull release on failed …
carlos-reynosa May 15, 2026
bf6efb1
Update recipe/magento2.php
carlos-reynosa May 15, 2026
9354d97
Generate docs
carlos-reynosa May 15, 2026
2df76ce
Magento failure subtasks should fail gracefully in case of new or bla…
carlos-reynosa May 15, 2026
8825a06
update docs
carlos-reynosa May 15, 2026
e732851
Fix style
carlos-reynosa May 15, 2026
410ccc6
Generalize app config import log
carlos-reynosa May 15, 2026
0493a50
Handle run command Timeout exceptions.
carlos-reynosa May 15, 2026
53b8cdb
Generate docs
carlos-reynosa May 15, 2026
da9bc25
Fix styling
carlos-reynosa May 15, 2026
9f8ee64
generate docs
carlos-reynosa May 15, 2026
08466e7
Fix styles
carlos-reynosa May 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 36 additions & 23 deletions docs/recipe/magento2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -380,7 +380,7 @@ true


### artifact_file
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L378)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L385)

Artifact deployment section
The file the artifact is saved to
Expand All @@ -391,7 +391,7 @@ The file the artifact is saved to


### artifact_dir
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L381)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L388)

The directory the artifact is saved in

Expand All @@ -401,7 +401,7 @@ The directory the artifact is saved in


### artifact_excludes_file
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L385)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L392)

Points to a file with a list of files to exclude from packaging.
The format is as with the `tar --exclude-from=[file]` option
Expand All @@ -412,7 +412,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#L388)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L395)

If set to true, the artifact is built from a clean copy of the project repository instead of the current working directory

Expand All @@ -422,7 +422,7 @@ false


### repository
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L391)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L398)

Overrides [repository](/docs/recipe/common.md#repository) from `recipe/common.php`.

Expand All @@ -434,7 +434,7 @@ null


### artifact_path
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L394)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L401)

The relative path to the artifact file. If the directory does not exist, it will be created

Expand All @@ -447,7 +447,7 @@ return get('artifact_dir') . '/' . get('artifact_file');


### bin/tar
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L402)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L409)

The location of the tar command. On MacOS you should have installed gtar, as it supports the required settings
:::info Autogenerated
Expand All @@ -458,14 +458,14 @@ The value of this configuration is autogenerated on access.


### additional_shared_files
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L474)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L481)

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#L476)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L483)

Array of shared directories that will be added to the default shared_dirs without overriding

Expand Down Expand Up @@ -639,48 +639,61 @@ This task is group task which contains next tasks:
* [deploy:publish](/docs/recipe/common.md#deploy-publish)


### deploy\:magento\:failed {#deploy-magento-failed}
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L377)

Run magento post deployment failure tasks.

Run Magento Deployment Failure Tasks


This task is group task which contains next tasks:
* [magento:config:import](/docs/recipe/magento2.md#magento-config-import)
* [magento:maintenance:disable](/docs/recipe/magento2.md#magento-maintenance-disable)


### artifact\:package {#artifact-package}
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L413)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L420)

Packages all relevant files in an artifact.

tasks section


### artifact\:upload {#artifact-upload}
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L423)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L430)

Uploads artifact in release folder for extraction.




### artifact\:extract {#artifact-extract}
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L428)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L435)

Extracts artifact in release path.




### build\:remove-generated {#build-remove-generated}
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L434)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L441)

Clears generated files prior to building.




### build\:prepare {#build-prepare}
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L439)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L446)

Prepare local artifact build.




### artifact\:build {#artifact-build}
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L464)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L471)

Builds an artifact.

Expand All @@ -697,15 +710,15 @@ This task is group task which contains next tasks:


### deploy\:additional-shared {#deploy-additional-shared}
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L480)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L487)

Adds additional files and dirs to the list of shared files and dirs.




### magento\:set_cache_prefix {#magento-set_cache_prefix}
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L495)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L502)

Update cache id_prefix.

Expand All @@ -719,15 +732,15 @@ after('deploy:magento', 'magento:cleanup_cache_prefix');


### magento\:cleanup_cache_prefix {#magento-cleanup_cache_prefix}
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L535)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L542)

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 {#magento-cron-stop}
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L551)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L558)

Remove cron from crontab and kill running cron jobs.

Expand All @@ -739,7 +752,7 @@ To use this feature, add the following to your deployer scripts:


### magento\:cron\:install {#magento-cron-install}
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L567)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L574)

Install cron in crontab.

Expand All @@ -751,7 +764,7 @@ To use this feature, add the following to your deployer scripts:


### artifact\:prepare {#artifact-prepare}
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L573)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L580)

Prepares an artifact on the target server.

Expand All @@ -771,7 +784,7 @@ This task is group task which contains next tasks:


### artifact\:finish {#artifact-finish}
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L586)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L593)

Executes the tasks after artifact is released.

Expand All @@ -787,7 +800,7 @@ This task is group task which contains next tasks:


### artifact\:deploy {#artifact-deploy}
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L595)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L602)

Actually releases the artifact deployment.

Expand Down
9 changes: 8 additions & 1 deletion recipe/magento2.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -370,7 +370,14 @@ function magentoDeployAssetsSplit(string $area)

after('deploy:symlink', 'magento:cache:flush');

after('deploy:failed', 'magento:maintenance:disable');
after('deploy:failed', 'deploy:magento:failed');

//Run Magento Deployment Failure Tasks
Comment thread
carlos-reynosa marked this conversation as resolved.
Outdated
desc('Run magento post deployment failure tasks.');
Comment thread
carlos-reynosa marked this conversation as resolved.
Outdated
task('deploy:magento:failed', [
'magento:config:import',
'magento:maintenance:disable',
]);

Comment thread
carlos-reynosa marked this conversation as resolved.
Comment thread
carlos-reynosa marked this conversation as resolved.
// Artifact deployment section

Expand Down
Loading