capistrano-magento2 0.8.7 → 0.8.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0873b9252da2bdba39fcc7f9b3360582696ec9d159ac1e28f3c74ee1823b4f86'
-  data.tar.gz: 6f3508a50bb1bcc01e7e7c139335da4912241b6779d7ce56f71aa36a7a8ab743
+  metadata.gz: f1ecc432d10021f836a35005807a6dc5127499d561a2081bd31168c2d1fc76a3
+  data.tar.gz: ba295633cb33ae700bb1b9ddf5c99d418469079b91ef2c87173c5425e72bd20f
 SHA512:
-  metadata.gz: a30733e4c4f5e48dfe03d6e064042e58a5451ef10963c04cf6e6cdead4839e23acfc98d1f38c203241dfb477a92283953141b03b500fc2583b6e28ccd11d20ea
-  data.tar.gz: ef98b2145f7526a1aac1b8217941bdf230e24e93ddc37a8331b4a054242acf0d5275d6bbccc6660799127e7d867cbc59e13bec42f611cde13f27d74993faab32
+  metadata.gz: 45e6e75fc726d56da63cbb53c46c17852e37472e5d6d34c53b8652417d4d3c35dac4fd6cb7ce5c5556f2cda7907b890415497cd6b57f0a5b9efa94cff02c9879
+  data.tar.gz: 6db56c44607d0e4258fcb5dd84a3ee0e2d148dd010765b64fca5db056f3a89610f27ce1e1d507499eeeb6d931ef13457dfd6b152b93b8b2d68e9da712f56c37b

data/.travis.yml

@@ -1,3 +1,7 @@
 language: ruby
 rvm:
-  2.2
+  2.4
+
+before_install:
+  - gem update --system
+  - gem install bundler

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Capistrano::Magento2 Change Log
 
+0.8.8
+==========
+
+* Added support for zero-side-effect pipeline deployments when scopes/themes have been dumped to config.php
+
 0.8.7
 ==========
 

data/README.md

@@ -2,7 +2,7 @@
 
 [![Gem Version](https://badge.fury.io/rb/capistrano-magento2.svg)](https://badge.fury.io/rb/capistrano-magento2)
 
-A Capistrano extension for Magento 2 deployments. Takes care of specific Magento 2 requirements and adds tasks specific to the Magento 2 application.
+A Capistrano extension for Magento 2 deployments. Takes care of specific Magento 2 requirements and adds tasks specific to the Magento 2 application. Supports zero-down deployments based on differences in deployed `config.php` and db status as reported by Magento's `setup:db:status` CLI command. When themes and scopes have been dumped to `config.php` via `bin/magento app:config:dump scopes themes i18n` then zero-side-effect pipeline will be utilized such that no database nor cache backend configuration are available during the build process.
 
 ## Supported Magento Versions
 

data/lib/capistrano/magento2/version.rb

@@ -9,6 +9,6 @@
 
 module Capistrano
   module Magento2
-    VERSION = '0.8.7'
+    VERSION = '0.8.8'
   end
 end

data/lib/capistrano/tasks/deploy.rake

@@ -13,6 +13,23 @@ namespace :deploy do
   before 'deploy:check:linked_files', 'magento:deploy:check'
   before 'deploy:symlink:linked_files', 'magento:deploy:local_config'
 
+  # If both 'scopes' and 'themes' are available in app/etc/config.php then the build should not require database or
+  # cache backend configuration to deploy. Removing the link to app/etc/env.php in this case prevents any possible
+  # side effects that may arise from the build running in parallel to the live production release (such as the cache
+  # being randomly disabled during the composer install step of the build, something which has been observed). This
+  # requires "bin/magento scopes themes i18n" be run to dump theme/store config and the result comitted to repository
+  before 'deploy:symlink:linked_files', :detect_scd_config do
+    on primary fetch(:magento_deploy_setup_role) do
+      unless test %Q[#{SSHKit.config.command_map[:php]} -r '
+            $cfg = include "#{release_path}/app/etc/config.php";
+            exit((int)(isset($cfg["scopes"]) && isset($cfg["themes"])));
+        ']
+        info "Removing app/etc/env.php from :linked_dirs for zero-side-effect pipeline deployment."
+        remove :linked_files, 'app/etc/env.php'
+      end
+    end
+  end
+
   before :starting, :confirm_action do
     if fetch(:magento_deploy_confirm).include? fetch(:stage).to_s
       print "\e[0;31m      Are you sure you want to deploy to #{fetch(:stage).to_s}? [y/n] \e[0m"
@@ -21,17 +38,33 @@ namespace :deploy do
     end
   end
 
+  # Links app/etc/env.php if previously dropped from :linked_dirs in :detect_scd_config
+  task 'symlink:link_env_php' do
+    on release_roles :all do
+      # Normally this would be wrapped in a conditional, but during SCD and/or DI compile Magento frequently writes
+      # to cache_types -> compiled_config resulting in an env.php file being present (albeit the wrong one)
+      execute :ln, "-fsn #{shared_path}/app/etc/env.php #{release_path}/app/etc/env.php"
+    end
+  end
+
   task :updated do
     invoke 'magento:deploy:verify'
     invoke 'magento:composer:install' if fetch(:magento_deploy_composer)
     invoke 'magento:deploy:version_check'
     invoke 'magento:setup:permissions'
+
     if fetch(:magento_deploy_production)
-      invoke 'magento:deploy:mode:production'
       invoke 'magento:setup:static-content:deploy'
       invoke 'magento:setup:di:compile'
       invoke 'magento:composer:dump-autoload' if fetch(:magento_deploy_composer)
     end
+
+    invoke 'deploy:symlink:link_env_php'
+
+    if fetch(:magento_deploy_production)
+      invoke 'magento:deploy:mode:production'
+    end
+
     invoke 'magento:setup:permissions'
     invoke 'magento:maintenance:check'
     invoke 'magento:maintenance:enable' if fetch(:magento_deploy_maintenance)

data/lib/capistrano/tasks/magento.rake

@@ -218,8 +218,10 @@ namespace :magento do
           exit 1  # only need to check the repo once, so we immediately exit
         end
 
+        # Checking app/etc/env.php in shared_path vs release_path to support the zero-side-effect
+        # builds as implemented in the :detect_scd_config hook of deploy.rake
         unless test %Q[#{SSHKit.config.command_map[:php]} -r '
-              $cfg = include "#{release_path}/app/etc/env.php";
+              $cfg = include "#{shared_path}/app/etc/env.php";
               exit((int)!isset($cfg["install"]["date"]));
           ']
           error "\e[0;31mError on #{host}:\e[0m No environment configuration could be found." +
@@ -317,11 +319,13 @@ namespace :magento do
       task :compile do
         on release_roles :all do
           within release_path do
-            output = capture :magento, 'setup:di:compile --no-ansi', verbosity: Logger::INFO
+            with mage_mode: :production do
+              output = capture :magento, 'setup:di:compile --no-ansi', verbosity: Logger::INFO
 
-            # 2.1.x doesn't return a non-zero exit code for certain errors (see davidalger/capistrano-magento2#41)
-            if output.to_s.include? 'Errors during compilation'
-              raise Exception, 'DI compilation command execution failed'
+              # 2.1.x doesn't return a non-zero exit code for certain errors (see davidalger/capistrano-magento2#41)
+              if output.to_s.include? 'Errors during compilation'
+                raise Exception, 'DI compilation command execution failed'
+              end
             end
           end
         end
@@ -332,66 +336,68 @@ namespace :magento do
       desc 'Deploys static view files'
       task :deploy do
         on release_roles :all do
-          _magento_version = magento_version
+          with mage_mode: :production do
+            _magento_version = magento_version
 
-          deploy_themes = fetch(:magento_deploy_themes)
-          deploy_jobs = fetch(:magento_deploy_jobs)
-
-          if deploy_themes.count() > 0
-            deploy_themes = deploy_themes.join(' -t ').prepend(' -t ')
-          else
-            deploy_themes = nil
-          end
-
-          if deploy_jobs
-            deploy_jobs = "--jobs #{deploy_jobs} "
-          else
-            deploy_jobs = nil
-          end
+            deploy_themes = fetch(:magento_deploy_themes)
+            deploy_jobs = fetch(:magento_deploy_jobs)
 
-          # Workaround core-bug with multi-lingual deployments on Magento 2.1.3 and greater. In these versions each
-          # language must be iterated individually. See issue #72 for details.
-          if _magento_version >= Gem::Version.new('2.1.3')
-            deploy_languages = fetch(:magento_deploy_languages)
-          else
-            deploy_languages = [fetch(:magento_deploy_languages).join(' ')]
-          end
+            if deploy_themes.count() > 0
+              deploy_themes = deploy_themes.join(' -t ').prepend(' -t ')
+            else
+              deploy_themes = nil
+            end
 
-          # Magento 2.2 introduced static content compilation strategies that can be one of the following:
-          # quick (default), standard (like previous versions) or compact
-          compilation_strategy = fetch(:magento_deploy_strategy)
-          if compilation_strategy and _magento_version >= Gem::Version.new('2.2.0')
-            compilation_strategy =  "-s #{compilation_strategy} "
-          else
-            compilation_strategy = nil
-          end
+            if deploy_jobs
+              deploy_jobs = "--jobs #{deploy_jobs} "
+            else
+              deploy_jobs = nil
+            end
 
-          within release_path do
-            # Magento 2.1 will fail to deploy if this file does not exist and static asset signing is enabled
-            execute :touch, "#{release_path}/pub/static/deployed_version.txt"
+            # Workaround core-bug with multi-lingual deployments on Magento 2.1.3 and greater. In these versions each
+            # language must be iterated individually. See issue #72 for details.
+            if _magento_version >= Gem::Version.new('2.1.3')
+              deploy_languages = fetch(:magento_deploy_languages)
+            else
+              deploy_languages = [fetch(:magento_deploy_languages).join(' ')]
+            end
 
-            # This loop exists to support deploy on versions where each language must be deployed seperately
-            deploy_languages.each do |lang|
-              static_content_deploy "#{compilation_strategy}#{deploy_jobs}#{lang}#{deploy_themes}"
+            # Magento 2.2 introduced static content compilation strategies that can be one of the following:
+            # quick (default), standard (like previous versions) or compact
+            compilation_strategy = fetch(:magento_deploy_strategy)
+            if compilation_strategy and _magento_version >= Gem::Version.new('2.2.0')
+              compilation_strategy =  "-s #{compilation_strategy} "
+            else
+              compilation_strategy = nil
             end
-          end
 
-          # Run again with HTTPS env var set to 'on' to pre-generate secure versions of RequireJS configs. A
-          # single run on these Magento versions will fail to generate the secure requirejs-config.js file.
-          if _magento_version < Gem::Version.new('2.1.8')
-            deploy_flags = ['css', 'less', 'images', 'fonts', 'html', 'misc', 'html-minify']
-              .join(' --no-').prepend(' --no-');
+            within release_path do
+              # Magento 2.1 will fail to deploy if this file does not exist and static asset signing is enabled
+              execute :touch, "#{release_path}/pub/static/deployed_version.txt"
 
-            within release_path do with(https: 'on') {
               # This loop exists to support deploy on versions where each language must be deployed seperately
               deploy_languages.each do |lang|
-                static_content_deploy "#{compilation_strategy}#{deploy_jobs}#{lang}#{deploy_themes}#{deploy_flags}"
+                static_content_deploy "#{compilation_strategy}#{deploy_jobs}#{lang}#{deploy_themes}"
               end
-            } end
-          end
+            end
 
-          # Set the deployed_version of static content to ensure it matches across all hosts
-          upload!(StringIO.new(deployed_version), "#{release_path}/pub/static/deployed_version.txt")
+            # Run again with HTTPS env var set to 'on' to pre-generate secure versions of RequireJS configs. A
+            # single run on these Magento versions will fail to generate the secure requirejs-config.js file.
+            if _magento_version < Gem::Version.new('2.1.8')
+              deploy_flags = ['css', 'less', 'images', 'fonts', 'html', 'misc', 'html-minify']
+                .join(' --no-').prepend(' --no-');
+
+              within release_path do with(https: 'on') {
+                # This loop exists to support deploy on versions where each language must be deployed seperately
+                deploy_languages.each do |lang|
+                  static_content_deploy "#{compilation_strategy}#{deploy_jobs}#{lang}#{deploy_themes}#{deploy_flags}"
+                end
+              } end
+            end
+
+            # Set the deployed_version of static content to ensure it matches across all hosts
+            upload!(StringIO.new(deployed_version), "#{release_path}/pub/static/deployed_version.txt")
+          end
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-magento2
 version: !ruby/object:Gem::Version
-  version: 0.8.7
+  version: 0.8.8
 platform: ruby
 authors:
 - David Alger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-01 00:00:00.000000000 Z
+date: 2019-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -100,7 +100,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A Capistrano extension for Magento 2 deployments.