Add and use new release_or_current_path (deployphp#2486)

* Add release_or_current_path option

* Use new path in platform-specific recipes

* Update CHANGELOG.md

Author: lorisleiva

Diff for: CHANGELOG.md

@@ -22,6 +22,7 @@
 - Added support for PHP8.
 - Added slack_channel option to Slack recipe.
 - Chatwork contrib recipe.
+- Added `release_or_current_path` option that fallbacks to the `current_path` when the `release_path` does not exist. [#2486]
 
 ### Changed
 - Refactored executor engine, up to 2x faster than before.
@@ -602,6 +603,7 @@
 - Fixed `DotArray` syntax in `Collection`.
 
 
+[#2486]: https://github.com/deployphp/deployer/pull/2486
 [#2425]: https://github.com/deployphp/deployer/pull/2425
 [#2423]: https://github.com/deployphp/deployer/issues/2423
 [#2393]: https://github.com/deployphp/deployer/pull/2393

Diff for: docs/recipe/deploy/release.md

@@ -13,6 +13,7 @@
   * [`releases_metainfo`](#releases_metainfo)
   * [`releases_list`](#releases_list)
   * [`release_path`](#release_path)
+  * [`release_or_current_path`](#release_or_current_path)
 * Tasks
   * [`deploy:release`](#deployrelease) — Prepare release. Clean up unfinished releases and prepare next release
 
@@ -37,6 +38,12 @@ Return list of releases on host.
 
 Return release path.
 
+### release_or_current_path
+[Source](https://github.com/deployphp/deployer/search?q=%22release_or_current_path%22+in%3Afile+language%3Aphp+path%3Arecipe%2Fdeploy+filename%3Arelease.php)
+
+Return the release path during a deployment
+but fallback to the current path otherwise.
+
 
 ## Tasks
 ### deploy:release

Diff for: recipe/cakephp.php

@@ -25,16 +25,16 @@
  * Create plugins' symlinks
  */
 task('deploy:init', function () {
-    run('{{release_path}}/bin/cake plugin assets symlink');
+    run('{{release_or_current_path}}/bin/cake plugin assets symlink');
 })->desc('Initialization');
 
 /**
  * Run migrations
  */
 task('deploy:run_migrations', function () {
-    run('{{release_path}}/bin/cake migrations migrate');
-    run('{{release_path}}/bin/cake schema_cache clear');
-    run('{{release_path}}/bin/cake schema_cachebuild');
+    run('{{release_or_current_path}}/bin/cake migrations migrate');
+    run('{{release_or_current_path}}/bin/cake schema_cache clear');
+    run('{{release_or_current_path}}/bin/cake schema_cachebuild');
 })->desc('Run migrations');
 
 /**

Diff for: recipe/deploy/release.php

@@ -89,6 +89,15 @@
     }
 });
 
+/**
+ * Return the release path during a deployment
+ * but fallback to the current path otherwise.
+ */
+set('release_or_current_path', function () {
+    $releaseExists = test('[ -h {{deploy_path}}/release ]');
+
+    return $releaseExists ? get('release_path') : get('current_path');
+});
 
 desc('Prepare release. Clean up unfinished releases and prepare next release');
 task('deploy:release', function () {

Diff for: recipe/deploy/vendors.php

@@ -29,5 +29,5 @@
     if (!commandExist('unzip')) {
         warning('To speed up composer installation setup "unzip" command with PHP zip extension.');
     }
-    run('cd {{release_path}} && {{bin/composer}} {{composer_action}} {{composer_options}} 2>&1');
+    run('cd {{release_or_current_path}} && {{bin/composer}} {{composer_action}} {{composer_options}} 2>&1');
 });

Diff for: recipe/flow_framework.php

@@ -23,15 +23,15 @@
  */
 desc('Apply database migrations');
 task('deploy:run_migrations', function () {
-    run('FLOW_CONTEXT={{flow_context}} {{bin/php}} {{release_path}}/{{flow_command}} doctrine:migrate');
+    run('FLOW_CONTEXT={{flow_context}} {{bin/php}} {{release_or_current_path}}/{{flow_command}} doctrine:migrate');
 });
 
 /**
  * Publish resources
  */
 desc('Publish resources');
 task('deploy:publish_resources', function () {
-    run('FLOW_CONTEXT={{flow_context}} {{bin/php}} {{release_path}}/{{flow_command}} resource:publish');
+    run('FLOW_CONTEXT={{flow_context}} {{bin/php}} {{release_or_current_path}}/{{flow_command}} resource:publish');
 });
 
 /**

Diff for: recipe/laravel.php

@@ -20,7 +20,7 @@
 ]);
 set('log_files', 'storage/logs/*.log');
 set('laravel_version', function () {
-    $result = run('{{bin/php}} {{release_path}}/artisan --version');
+    $result = run('{{bin/php}} {{release_or_current_path}}/artisan --version');
     preg_match_all('/(\d+\.?)+/', $result, $matches);
     return $matches[0][0] ?? 5.5;
 });
@@ -43,6 +43,8 @@
 function artisan($command, $options = [])
 {
     return function () use ($command, $options) {
+
+        // Ensure the artisan command is available on the current version.
         $versionTooEarly = array_key_exists('min', $options)
             && laravel_version_compare($options['min'], '<');
 
@@ -52,20 +54,26 @@ function artisan($command, $options = [])
         if ($versionTooEarly || $versionTooLate) {
             return;
         }
-        if (in_array('failIfNoEnv', $options) && !test('[ -s {{release_path}}/.env ]')) {
+
+        // Ensure we warn or fail when a command relies on the ".env" file.
+        if (in_array('failIfNoEnv', $options) && !test('[ -s {{release_or_current_path}}/.env ]')) {
             throw new \Exception('Your .env file is empty! Cannot proceed.');
         }
-        if (in_array('skipIfNoEnv', $options) && !test('[ -s {{release_path}}/.env ]')) {
+
+        if (in_array('skipIfNoEnv', $options) && !test('[ -s {{release_or_current_path}}/.env ]')) {
             warning("Your .env file is empty! Skipping...</>");
             return;
         }
 
+        // Use the release_path by default unless it does not exist or specified otherwise.
         $artisan = in_array('runInCurrent', $options)
             ? '{{current_path}}/artisan'
-            : '{{release_path}}/artisan';
+            : '{{release_or_current_path}}/artisan';
 
+        // Run the artisan command.
         $output = run("{{bin/php}} $artisan $command");
 
+        // Output the results when appropriate.
         if (in_array('showOutput', $options)) {
             writeln("<info>$output</info>");
         }
@@ -166,13 +174,13 @@ function laravel_version_compare($version, $comparator)
 desc('Make symlink for public disk');
 task('deploy:public_disk', function () {
     // Remove from source.
-    run('if [ -d $(echo {{release_path}}/public/storage) ]; then rm -rf {{release_path}}/public/storage; fi');
+    run('if [ -d $(echo {{release_or_current_path}}/public/storage) ]; then rm -rf {{release_or_current_path}}/public/storage; fi');
 
     // Create shared dir if it does not exist.
     run('mkdir -p {{deploy_path}}/shared/storage/app/public');
 
     // Symlink shared dir to release dir
-    run('{{bin/symlink}} {{deploy_path}}/shared/storage/app/public {{release_path}}/public/storage');
+    run('{{bin/symlink}} {{deploy_path}}/shared/storage/app/public {{release_or_current_path}}/public/storage');
 });
 
 /**

Diff for: recipe/magento.php

@@ -23,17 +23,17 @@
  */
 desc('Clear cache');
 task('deploy:cache:clear', function () {
-    run("cd {{release_path}} && php -r \"require_once 'app/Mage.php'; umask(0); Mage::app()->cleanCache();\"");
+    run("cd {{release_or_current_path}} && php -r \"require_once 'app/Mage.php'; umask(0); Mage::app()->cleanCache();\"");
 });
 
 /**
  * Remove files that can be used to compromise Magento
  */
 task('deploy:clear_version', function () {
-    run("rm -f {{release_path}}/LICENSE.html");
-    run("rm -f {{release_path}}/LICENSE.txt");
-    run("rm -f {{release_path}}/LICENSE_AFL.txt");
-    run("rm -f {{release_path}}/RELEASE_NOTES.txt");
+    run("rm -f {{release_or_current_path}}/LICENSE.html");
+    run("rm -f {{release_or_current_path}}/LICENSE.txt");
+    run("rm -f {{release_or_current_path}}/LICENSE_AFL.txt");
+    run("rm -f {{release_or_current_path}}/RELEASE_NOTES.txt");
 })->hidden();
 
 after('deploy:update_code', 'deploy:clear_version');

Diff for: recipe/magento2.php

@@ -58,7 +58,7 @@
 
 set('magento_version', function () {
     // detect version
-    $versionOutput = run('{{bin/php}} {{release_path}}/bin/magento --version');
+    $versionOutput = run('{{bin/php}} {{release_or_current_path}}/bin/magento --version');
     preg_match('/(\d+\.?)+$/', $versionOutput, $matches);
     return $matches[0] ?? "2.0";
 });
@@ -72,14 +72,14 @@
 // Tasks
 desc('Compile magento di');
 task('magento:compile', function () {
-    run('cd {{release_path}} && {{bin/composer}} dump-autoload -o');
-    run("{{bin/php}} {{release_path}}/bin/magento setup:di:compile");
-    run('cd {{release_path}} && {{bin/composer}} dump-autoload -o');
+    run('cd {{release_or_current_path}} && {{bin/composer}} dump-autoload -o');
+    run("{{bin/php}} {{release_or_current_path}}/bin/magento setup:di:compile");
+    run('cd {{release_or_current_path}} && {{bin/composer}} dump-autoload -o');
 });
 
 desc('Deploy assets');
 task('magento:deploy:assets', function () {
-    run("{{bin/php}} {{release_path}}/bin/magento setup:static-content:deploy --content-version={{content_version}} {{static_content_locales}}");
+    run("{{bin/php}} {{release_or_current_path}}/bin/magento setup:static-content:deploy --content-version={{content_version}} {{static_content_locales}}");
 });
 
 desc('Sync content version');
@@ -114,7 +114,7 @@
         $configImportNeeded = true;
     } else {
         try {
-            run('{{bin/php}} {{release_path}}/bin/magento app:config:status');
+            run('{{bin/php}} {{release_or_current_path}}/bin/magento app:config:status');
         } catch (RunException $e) {
             if ($e->getExitCode() == CONFIG_IMPORT_NEEDED_EXIT_CODE) {
                 $configImportNeeded = true;
@@ -129,7 +129,7 @@
             invoke('magento:maintenance:enable');
         }
 
-        run('{{bin/php}} {{release_path}}/bin/magento app:config:import --no-interaction');
+        run('{{bin/php}} {{release_or_current_path}}/bin/magento app:config:import --no-interaction');
 
         if (!get('maintenance_mode_status_active')) {
             invoke('magento:maintenance:disable');
@@ -142,7 +142,7 @@
     $databaseUpgradeNeeded = false;
 
     try {
-        run('{{bin/php}} {{release_path}}/bin/magento setup:db:status');
+        run('{{bin/php}} {{release_or_current_path}}/bin/magento setup:db:status');
     } catch (RunException $e) {
         if ($e->getExitCode() == DB_UPDATE_NEEDED_EXIT_CODE) {
             $databaseUpgradeNeeded = true;
@@ -156,7 +156,7 @@
             invoke('magento:maintenance:enable');
         }
 
-        run("{{bin/php}} {{release_path}}/bin/magento setup:upgrade --keep-generated");
+        run("{{bin/php}} {{release_or_current_path}}/bin/magento setup:upgrade --keep-generated");
 
         if (!get('maintenance_mode_status_active')) {
             invoke('magento:maintenance:disable');
@@ -166,7 +166,7 @@
 
 desc('Flush Magento Cache');
 task('magento:cache:flush', function () {
-    run("{{bin/php}} {{release_path}}/bin/magento cache:flush");
+    run("{{bin/php}} {{release_or_current_path}}/bin/magento cache:flush");
 });
 
 desc('Magento2 deployment operations');

Diff for: recipe/shopware.php

@@ -37,32 +37,32 @@
 set('static_folders', []);
 
 task('sw:update_code', static function () {
-    run('git clone {{repository}} {{release_path}}');
+    run('git clone {{repository}} {{release_or_current_path}}');
 });
 task('sw:system:install', static function () {
-    run('cd {{release_path}} && bin/console system:install');
+    run('cd {{release_or_current_path}} && bin/console system:install');
 });
 task('sw:build', static function () {
-    run('cd {{release_path}}/bin && bash build.sh');
+    run('cd {{release_or_current_path}}/bin && bash build.sh');
 });
 task('sw:system:setup', static function () {
-    run('cd {{release_path}} && bin/console system:setup');
+    run('cd {{release_or_current_path}} && bin/console system:setup');
 });
 task('sw:theme:compile', static function () {
-    run('cd {{release_path}} && bin/console theme:compile');
+    run('cd {{release_or_current_path}} && bin/console theme:compile');
 });
 task('sw:cache:clear', static function () {
-    run('cd {{release_path}} && bin/console cache:clear');
+    run('cd {{release_or_current_path}} && bin/console cache:clear');
 });
 task('sw:cache:warmup', static function () {
-    run('cd {{release_path}} && bin/console cache:warmup');
-    run('cd {{release_path}} && bin/console http:cache:warm:up');
+    run('cd {{release_or_current_path}} && bin/console cache:warmup');
+    run('cd {{release_or_current_path}} && bin/console http:cache:warm:up');
 });
 task('sw:database:migrate', static function () {
-    run('cd {{release_path}} && bin/console database:migrate --all');
+    run('cd {{release_or_current_path}} && bin/console database:migrate --all');
 });
 task('sw:plugin:refresh', function () {
-    run('cd {{release_path}} && bin/console plugin:refresh');
+    run('cd {{release_or_current_path}} && bin/console plugin:refresh');
 });
 /**
  * @return array
@@ -71,7 +71,7 @@
  */
 function getSortedPlugins(): array
 {
-    cd('{{release_path}}');
+    cd('{{release_or_current_path}}');
     $plugins = explode("\n", run('bin/console plugin:list'));
 
     // take line over headlines and count "-" to get the size of the cells
@@ -146,7 +146,7 @@ static function ($composerName) use ($pluginMapping) {
         ] = $pluginInfo;
 
         if ($installed === 'No' || $active === 'No') {
-            run("cd {{release_path}} && bin/console plugin:install --activate $plugin");
+            run("cd {{release_or_current_path}} && bin/console plugin:install --activate $plugin");
         }
     }
 });
@@ -166,7 +166,7 @@ static function ($composerName) use ($pluginMapping) {
         ] = $pluginInfo;
 
         if ($installed === 'Yes' || $active === 'Yes') {
-            run("cd {{release_path}} && bin/console database:migrate --all $plugin || true");
+            run("cd {{release_or_current_path}} && bin/console database:migrate --all $plugin || true");
         }
     }
 });

Diff for: recipe/silverstripe.php

@@ -10,7 +10,7 @@
  */
 
 set('shared_assets', function () {
-    if (test('[ -d {{release_path}}/public ]') || test('[ -d {{deploy_path}}/shared/public ]')) {
+    if (test('[ -d {{release_or_current_path}}/public ]') || test('[ -d {{deploy_path}}/shared/public ]')) {
         return 'public/assets';
     }
     return 'assets';
@@ -34,7 +34,7 @@
         'vendor/silverstripe/framework/cli-script.php'
     ];
     foreach ($paths as $path) {
-        if (test('[ -f {{release_path}}/'.$path.' ]')) {
+        if (test('[ -f {{release_or_current_path}}/'.$path.' ]')) {
             return $path;
         }
     }
@@ -45,12 +45,12 @@
  */
 desc('Run /dev/build');
 task('silverstripe:build', function () {
-    return run('{{bin/php}} {{release_path}}/{{silverstripe_cli_script}} /dev/build');
+    return run('{{bin/php}} {{release_or_current_path}}/{{silverstripe_cli_script}} /dev/build');
 });
 
 desc('Run /dev/build?flush=all');
 task('silverstripe:buildflush', function () {
-    return run('{{bin/php}} {{release_path}}/{{silverstripe_cli_script}} /dev/build flush=all');
+    return run('{{bin/php}} {{release_or_current_path}}/{{silverstripe_cli_script}} /dev/build flush=all');
 });
 
 /**

Diff for: recipe/sulu.php

@@ -11,7 +11,7 @@
 add('writable_dirs', ['public/uploads']);
 
 set('bin/websiteconsole', function () {
-    return parse('{{bin/php}} {{release_path}}/bin/websiteconsole --no-interaction');
+    return parse('{{bin/php}} {{release_or_current_path}}/bin/websiteconsole --no-interaction');
 });
 
 desc('Migrate PHPCR');

Diff for: recipe/symfony.php

@@ -27,7 +27,7 @@
 
 set('migrations_config', '');
 
-set('bin/console', '{{bin/php}} {{release_path}}/bin/console');
+set('bin/console', '{{bin/php}} {{release_or_current_path}}/bin/console');
 
 set('console_options', function () {
     return '--no-interaction';
@@ -37,10 +37,10 @@
 task('database:migrate', function () {
     $options = '--allow-no-migration';
     if (get('migrations_config') !== '') {
-        $options = "$options --configuration={{release_path}}/{{migrations_config}}";
+        $options = "$options --configuration={{release_or_current_path}}/{{migrations_config}}";
     }
 
-    run("cd {{release_path}} && {{bin/console}} doctrine:migrations:migrate $options {{console_options}}");
+    run("cd {{release_or_current_path}} && {{bin/console}} doctrine:migrations:migrate $options {{console_options}}");
 });
 
 desc('Clear cache');