generate docs

Author: carlos-reynosa

docs/recipe/magento2.md

@@ -349,7 +349,7 @@ The value of this configuration is autogenerated on access.
 
 
 ### database_upgrade_needed
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L159)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L158)
 
 
 :::info Autogenerated
@@ -360,7 +360,7 @@ The value of this configuration is autogenerated on access.
 
 
 ### full_upgrade_needed
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L174)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L173)
 
 
 
@@ -372,7 +372,7 @@ return false;
 
 
 ### upgrade_needed
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L180)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L179)
 
 
 :::info Autogenerated
@@ -383,7 +383,7 @@ The value of this configuration is autogenerated on access.
 
 
 ### enable_zerodowntime
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L190)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L189)
 
 Deploy without setting maintenance mode if possible
 
@@ -393,7 +393,7 @@ true
 
 
 ### artifact_file
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L425)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L424)
 
 Artifact deployment section
 The file the artifact is saved to
@@ -404,7 +404,7 @@ The file the artifact is saved to
 
 
 ### artifact_dir
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L428)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L427)
 
 The directory the artifact is saved in
 
@@ -414,7 +414,7 @@ The directory the artifact is saved in
 
 
 ### artifact_excludes_file
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L432)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L431)
 
 Points to a file with a list of files to exclude from packaging.
 The format is as with the `tar --exclude-from=[file]` option
@@ -425,7 +425,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#L435)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L434)
 
 If set to true, the artifact is built from a clean copy of the project repository instead of the current working directory
 
@@ -435,7 +435,7 @@ false
 
 
 ### repository
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L438)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L437)
 
 Overrides [repository](/docs/recipe/common.md#repository) from `recipe/common.php`.
 
@@ -447,7 +447,7 @@ null
 
 
 ### artifact_path
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L441)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L440)
 
 The relative path to the artifact file. If the directory does not exist, it will be created
 
@@ -460,7 +460,7 @@ return get('artifact_dir') . '/' . get('artifact_file');
 
 
 ### bin/tar
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L449)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L448)
 
 The location of the tar command. On MacOS you should have installed gtar, as it supports the required settings
 :::info Autogenerated
@@ -471,14 +471,14 @@ The value of this configuration is autogenerated on access.
 
 
 ### additional_shared_files
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L521)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L520)
 
 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#L523)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L522)
 
 Array of shared directories that will be added to the default shared_dirs without overriding
 
@@ -488,7 +488,7 @@ Array of shared directories that will be added to the default shared_dirs withou
 ## Tasks
 
 ### magento\:compile {#magento-compile}
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L200)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L199)
 
 Compiles magento di.
 
@@ -501,7 +501,7 @@ e.g.
 
 
 ### magento\:deploy\:assets {#magento-deploy-assets}
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L226)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L225)
 
 Deploys assets.
 
@@ -528,95 +528,95 @@ in `app/etc/config.php`, e.g.:
 
 
 ### magento\:deploy\:assets\:adminhtml {#magento-deploy-assets-adminhtml}
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L243)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L242)
 
 Deploys assets for backend only.
 
 
 
 
 ### magento\:deploy\:assets\:frontend {#magento-deploy-assets-frontend}
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L248)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L247)
 
 Deploys assets for frontend only.
 
 
 
 
 ### magento\:sync\:content_version {#magento-sync-content_version}
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L311)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L310)
 
 Syncs content version.
 
 
 
 
 ### magento\:maintenance\:enable {#magento-maintenance-enable}
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L321)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L320)
 
 Enables maintenance mode.
 
 
 
 
 ### magento\:maintenance\:disable {#magento-maintenance-disable}
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L327)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L326)
 
 Disables maintenance mode.
 
 
 
 
 ### magento\:maintenance\:enable-if-needed {#magento-maintenance-enable-if-needed}
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L333)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L332)
 
 Set maintenance mode if needed.
 
 
 
 
 ### magento\:config\:import {#magento-config-import}
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L340)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L339)
 
 Config Import.
 
 
 
 
 ### magento\:config\:import\:on-current {#magento-config-import-on-current}
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L349)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L348)
 
 Config Import on current release.
 
 
 
 
 ### magento\:upgrade\:db {#magento-upgrade-db}
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L363)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L362)
 
 Upgrades magento database.
 
 
 
 
 ### magento\:upgrade {#magento-upgrade}
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L375)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L374)
 
 Run upgrades if needed.
 
 
 
 
 ### magento\:cache\:flush {#magento-cache-flush}
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L384)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L383)
 
 Flushes Magento Cache.
 
 
 
 
 ### deploy\:magento {#deploy-magento}
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L389)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L388)
 
 Magento2 deployment operations.
 
@@ -632,7 +632,7 @@ This task is group task which contains next tasks:
 
 
 ### magento\:build {#magento-build}
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L398)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L397)
 
 Magento2 build operations.
 
@@ -645,7 +645,7 @@ This task is group task which contains next tasks:
 
 
 ### deploy {#deploy}
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L404)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L403)
 
 Deploys your project.
 
@@ -661,7 +661,7 @@ This task is group task which contains next tasks:
 
 
 ### deploy\:magento\:failed {#deploy-magento-failed}
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L417)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L416)
 
 Run Magento post-deployment failure tasks.
 
@@ -674,47 +674,47 @@ This task is group task which contains next tasks:
 
 
 ### artifact\:package {#artifact-package}
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L460)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L459)
 
 Packages all relevant files in an artifact.
 
 tasks section
 
 
 ### artifact\:upload {#artifact-upload}
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L470)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L469)
 
 Uploads artifact in release folder for extraction.
 
 
 
 
 ### artifact\:extract {#artifact-extract}
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L475)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L474)
 
 Extracts artifact in release path.
 
 
 
 
 ### build\:remove-generated {#build-remove-generated}
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L481)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L480)
 
 Clears generated files prior to building.
 
 
 
 
 ### build\:prepare {#build-prepare}
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L486)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L485)
 
 Prepare local artifact build.
 
 
 
 
 ### artifact\:build {#artifact-build}
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L511)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L510)
 
 Builds an artifact.
 
@@ -731,15 +731,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#L527)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L526)
 
 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#L542)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L541)
 
 Update cache id_prefix.
 
@@ -753,15 +753,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#L582)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L581)
 
 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#L598)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L597)
 
 Remove cron from crontab and kill running cron jobs.
 
@@ -773,7 +773,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#L614)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L613)
 
 Install cron in crontab.
 
@@ -785,7 +785,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#L620)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L619)
 
 Prepares an artifact on the target server.
 
@@ -805,7 +805,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#L633)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L632)
 
 Executes the tasks after artifact is released.
 
@@ -821,7 +821,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#L642)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L641)
 
 Actually releases the artifact deployment.