capistrano-magento2 0.6.6 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4fbd7419a47dfb734ba5b5a550bb519e10d1ba6b
-  data.tar.gz: abcaa12f7685033761b17240015801db9c0a2f4f
+  metadata.gz: 90ba00a287b7ec92daa13ad5b80e5f9c64b2edd1
+  data.tar.gz: 0f80aa8c230a3892b8103cee6988609f2a6a02f7
 SHA512:
-  metadata.gz: b0bf37f855fa2afa6d96c7f75f107b9a000d9b719ee52819dbb3db458bb6cab17c13236472c05afa5d033d8a183d777f966431abc24d2c361afa778b5884bc88
-  data.tar.gz: 054f63601690bc9301fdbf9d5f6d247b0bfd738f39228f1018e98be55af1cddb6f6972746092156f2c9dd7851997c5f5b0845dc19d9c8f51a852cb75a8aa85f3
+  metadata.gz: 434c6479bba71183db18923cedd3547dbdbefcdc03ec77dba93a1934d0cdfb698b4f5d0f913cf0cf7b21da1941554b2518e7d45ba0cd27aad136ed7f58ef6182
+  data.tar.gz: 32804ed94a37041673ff0b54753e5f03f1334611945c5262f8b0710441219edae030dc3b101232de0926b28bf267689d026f564cfdd6d80458c0e405b34d7cbb

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Capistrano::Magento2 Change Log
 
+0.7.0
+==========
+
+* Added support for Magento 2.2.0 release candidates
+* Removed support for deployment of Magento versions older than 2.1.1
+* Updated and optimized static content deployment for upcoming Magento 2.2.0 release
+* Updated composer install routine; --no-dev is now used indiscriminately since Magento 2.1.1 and later support it; no more duplicate composer install commands (issue #76)
+* Updated multi-lingual site deployment workaround to apply only to versions 2.1.3 through 2.1.7 as per 2.1.8 release notes the underlying issue has been resolved (issue #72)
+* Added tasks to set production mode and show current mode (magento:deploy:mode:production and magento:deploy:mode:show)
+
 0.6.6
 ==========
 

data/README.md

@@ -4,6 +4,10 @@
 
 A Capistrano extension for Magento 2 deployments. Takes care of specific Magento 2 requirements and adds tasks specific to the Magento 2 application.
 
+## Supported Magento Versions
+
+**As of version 0.7.0 this gem only supports deployment of Magento 2.1.1 or later; please use an earlier version to deploy older releases of Magento 2**
+
 ## Installation
 
 ### Standalone Installation
@@ -119,8 +123,8 @@ Before you can use Capistrano to deploy, you must configure the `config/deploy.r
 | `:magento_deploy_setup_role`   | `:all`  | Role from which primary host is chosen to run things like setup:upgrade on
 | `:magento_deploy_cache_shared` | `true`  | If true, cache operations are restricted to the primary node in setup role
 | `:magento_deploy_languages`    | `['en_US']` | Array of languages passed to static content deploy routine
-| `:magento_deploy_themes`       | `[]`   | Array of themes passed to static content deploy (Magento 2.1.1 and later)
-| `:magento_deploy_jobs`         | `4`    | Number of threads to use for static content deploy (Magento 2.1.1 and later)
+| `:magento_deploy_themes`       | `[]`   | Array of themes passed to static content deploy
+| `:magento_deploy_jobs`         | `4`    | Number of threads to use for static content deploy
 | `:magento_deploy_composer`     | `true` | Enables composer install behaviour in the built-in deploy routine
 | `:magento_deploy_production`   | `true` | Enables production specific DI compilation and static content generation
 | `:magento_deploy_maintenance`  | `true` | Enables use of maintenance mode while magento:setup:upgrade runs
@@ -212,6 +216,8 @@ All Magento 2 tasks used by the built-in `deploy.rake` file as well as some addi
 | magento:cache:status                  | Check Magento cache enabled status                 |
 | magento:cache:varnish:ban             | Add ban to Varnish for url(s)                      |
 | magento:composer:install              | Run composer install                               |
+| magento:deploy:mode:production        | Enables production mode                            |
+| magento:deploy:mode:show              | Displays current application mode                  |
 | magento:indexer:info                  | Shows allowed indexers                             |
 | magento:indexer:reindex               | Reindex data by all indexers                       |
 | magento:indexer:set-mode[mode,index]  | Sets mode of all indexers                          |

data/lib/capistrano/magento2.rb

@@ -29,40 +29,25 @@ module Capistrano
       def cache_hosts
         return fetch(:magento_deploy_cache_shared) ? (primary fetch :magento_deploy_setup_role) : (release_roles :all)
       end
-
-      # Set pipefail allowing console exit codes in Magento 2.1.1 and later to halt execution when using pipes
-      def Helpers.set_pipefail
-        if not SSHKit.config.command_map[:magento].include? 'set -o pipefail' # avoids trouble on multi-host deploys
-          @@pipefail_less = SSHKit.config.command_map[:magento].dup
-          SSHKit.config.command_map[:magento] = "set -o pipefail; #{@@pipefail_less}"
-        end
-      end
-
-      # Reset the command map without prefix, removing pipefail option so it won't affect other commands
-      def Helpers.unset_pipefail
-        SSHKit.config.command_map[:magento] = @@pipefail_less
-      end
     end
 
     module Setup
       def static_content_deploy params
-        Helpers.set_pipefail
-        output = capture :magento,
-          "setup:static-content:deploy --no-ansi #{params} | stdbuf -o0 tr -d .",
-          verbosity: Logger::INFO
-        Helpers.unset_pipefail
+        if magento_version >= Gem::Version.new('2.2.0-rc')
+          # Using -f here just in case MAGE_MODE environment variable in shell is set to something other than production
+          execute :magento, "setup:static-content:deploy -f #{params}"
+        else
+          # Sets pipefail option in shell allowing command exit codes to halt execution when piping command output
+          if not SSHKit.config.command_map[:magento].include? 'set -o pipefail' # avoids trouble on multi-host deploys
+            @@pipefail_less = SSHKit.config.command_map[:magento].dup
+            SSHKit.config.command_map[:magento] = "set -o pipefail; #{@@pipefail_less}"
+          end
 
-        # String based error checking is here to catch errors in Magento 2.1.0 and earlier; later versions will exit
-        # immediately when a console exit code is retruned, never evaluating this code.
-        if not output.to_s.include? 'New version of deployed files'
-          raise Exception, "\e[0;31mFailed to compile static assets. No new version found in command output!\e[0m"
-        end
+          execute :magento, "setup:static-content:deploy #{params} | stdbuf -o0 tr -d ."
 
-        output.to_s.each_line { |line|
-          if line.split('errors: ', 2).pop.to_i > 0
-            raise Exception, "\e[0;31mFailed to compile static assets. Errors found in command output: #{line}\e[0m"
-          end
-        }
+          # Unsets pipefail option in shell so it won't affect future command executions
+          SSHKit.config.command_map[:magento] = @@pipefail_less
+        end
       end
 
       def deployed_version

data/lib/capistrano/magento2/version.rb

@@ -9,6 +9,6 @@
 
 module Capistrano
   module Magento2
-    VERSION = '0.6.6'
+    VERSION = '0.7.0'
   end
 end

data/lib/capistrano/tasks/deploy.rake

@@ -24,7 +24,9 @@ namespace :deploy do
   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'
+    invoke 'magento:deploy:mode:production'
     if fetch(:magento_deploy_production)
       invoke 'magento:setup:static-content:deploy'
       invoke 'magento:setup:di:compile'

data/lib/capistrano/tasks/magento.rake

@@ -85,7 +85,7 @@ namespace :magento do
 
       on release_roles :all do
         within release_path do
-          composer_flags = '--prefer-dist --no-interaction'
+          composer_flags = '--no-dev --prefer-dist --no-interaction'
 
           if fetch(:magento_deploy_production)
             composer_flags += ' --optimize-autoloader'
@@ -93,11 +93,6 @@ namespace :magento do
 
           execute :composer, "install #{composer_flags} 2>&1"
 
-          if fetch(:magento_deploy_production) and magento_version >= Gem::Version.new('2.1')
-            composer_flags += ' --no-dev'
-            execute :composer, "install #{composer_flags} 2>&1" # removes require-dev components from prev command
-          end
-
           if test "[ -f #{release_path}/update/composer.json ]"   # can't count on this, but emit warning if not present
             execute :composer, "install #{composer_flags} -d ./update 2>&1"
           else
@@ -123,6 +118,39 @@ namespace :magento do
   end
 
   namespace :deploy do
+    namespace :mode do
+      desc "Enables production mode"
+      task :production do
+        on release_roles :all do
+          within release_path do
+            execute :magento, "deploy:mode:set production --skip-compilation"
+          end
+        end
+      end
+      
+      desc "Displays current application mode"
+      task :show do
+        on release_roles :all do
+          within release_path do
+            execute :magento, "deploy:mode:show"
+          end
+        end
+      end
+    end
+
+    task :version_check do
+      on release_roles :all do
+        within release_path do
+          _magento_version = magento_version
+          unless _magento_version >= Gem::Version.new('2.1.1')
+            error "\e[0;31mVersion 0.7.0 and later of this gem only support deployment of Magento 2.1.1 or newer; " +
+              "attempted to deploy v" + _magento_version.to_s + ". Please try again using an earlier version of this gem!\e[0m"
+            exit 1  # only need to check a single server, exit immediately
+          end
+        end
+      end
+    end
+
     task :check do
       on release_roles :all do
         next unless any? :linked_files_touch
@@ -243,16 +271,8 @@ namespace :magento do
       task :compile do
         on release_roles :all do
           within release_path do
-            # Due to a bug in the single-tenant compiler released in 2.0 (see here for details: http://bit.ly/21eMPtt)
-            # we have to use multi-tenant currently. However, the multi-tenant is being dropped in 2.1 and is no longer
-            # present in the develop mainline, so we are testing for multi-tenant presence for long-term portability.
-            if test :magento, 'setup:di:compile-multi-tenant --help >/dev/null 2>&1'
-              output = capture :magento, 'setup:di:compile-multi-tenant --no-ansi', verbosity: Logger::INFO
-            else
-              output = capture :magento, 'setup:di:compile --no-ansi', verbosity: Logger::INFO
-            end
-            
-            # 2.0.x never returns a non-zero exit code for errors, so manually check string
+            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'
@@ -271,60 +291,49 @@ namespace :magento do
           deploy_themes = fetch(:magento_deploy_themes)
           deploy_jobs = fetch(:magento_deploy_jobs)
 
-          if deploy_themes.count() > 0 and _magento_version >= Gem::Version.new('2.1.1')
+          if deploy_themes.count() > 0
             deploy_themes = deploy_themes.join(' -t ').prepend(' -t ')
-          elsif deploy_themes.count() > 0
-            warn "\e[0;31mWarning: the :magento_deploy_themes setting is only supported in Magento 2.1.1 and later\e[0m"
-            deploy_themes = nil
           else
             deploy_themes = nil
           end
 
-          if deploy_jobs and _magento_version >= Gem::Version.new('2.1.1')
+          if deploy_jobs
             deploy_jobs = "--jobs #{deploy_jobs} "
-          elsif deploy_jobs
-            warn "\e[0;31mWarning: the :magento_deploy_jobs setting is only supported in Magento 2.1.1 and later\e[0m"
-            deploy_jobs = nil
           else
             deploy_jobs = nil
           end
 
-          # Workaround core-bug with multi-lingual deployments on Magento 2.1.3 and newer. In 2.1.3 and later each
-          # languages must be iterated individuall. See issue #72 for details
-          if _magento_version >= Gem::Version.new('2.1.3')
+          # Workaround core-bug with multi-lingual deployments on Magento 2.1.3 through 2.1.7. In these versions each
+          # language must be iterated individuall. See issue #72 for details. Fixed in 2.1.8: http://bit.ly/2fSF8w5
+          if _magento_version >= Gem::Version.new('2.1.3') and _magento_version <= Gem::Version.new('2.1.7')
             deploy_languages = fetch(:magento_deploy_languages)
           else
             deploy_languages = [fetch(:magento_deploy_languages).join(' ')]
           end
 
-          # Output is being checked for a success message because this command may easily fail due to customizations
-          # and 2.0.x CLI commands do not return error exit codes on failure. See magento/magento2#3060 for details.
           within release_path do
-
-            # Workaround for 2.1 specific issue: https://github.com/magento/magento2/pull/6437
+            # 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"
 
-            # Generates all but the secure versions of RequireJS configs
-            deploy_languages.each {|lang| static_content_deploy "#{deploy_jobs}#{lang}#{deploy_themes}"}
+            # This loop exists to support deploy on 2.1.3 thru 2.1.7 where each language must be deployed seperately
+            deploy_languages.each do |lang|
+              static_content_deploy "#{deploy_jobs}#{lang}#{deploy_themes}"
+            end
           end
 
           # Run again with HTTPS env var set to 'on' to pre-generate secure versions of RequireJS configs
-          deploy_flags = ['css', 'less', 'images', 'fonts', 'html', 'misc', 'html-minify']
-          
-          # As of Magento 2.1.3, it became necessary to exclude "--no-javacript" in order for secure versions of 
-          # RequireJs configs to be generated
-          if _magento_version < Gem::Version.new('2.1.3')
-            deploy_flags.push('javascript')
+          # A single run on Magento 2.1 will fail to generate the secure requirejs-config.js file; 2.2 there is no diff
+          if _magento_version < Gem::Version.new('2.2.0-rc')
+            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 2.1.3 thru 2.1.7 where each language must be deployed seperately
+              deploy_languages.each do |lang|
+                static_content_deploy "#{deploy_jobs}#{lang}#{deploy_themes}#{deploy_flags}"
+              end
+            } end
           end
-          
-          deploy_flags = deploy_flags.join(' --no-').prepend(' --no-');
-
-          # Magento 2.1.0 and earlier lack support for these flags, so generation of secure files requires full re-run
-          deploy_flags = nil if _magento_version <= Gem::Version.new('2.1.0')
-
-          within release_path do with(https: 'on') {
-            deploy_languages.each {|lang| static_content_deploy "#{deploy_jobs}#{lang}#{deploy_themes}#{deploy_flags}"}
-          } 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")

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-magento2
 version: !ruby/object:Gem::Version
-  version: 0.6.6
+  version: 0.7.0
 platform: ruby
 authors:
 - David Alger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-23 00:00:00.000000000 Z
+date: 2017-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
 description: A Capistrano extension for Magento 2 deployments. Takes care of specific
@@ -60,8 +60,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.md
@@ -89,17 +89,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: A Capistrano extension for Magento 2 deployments.