capistrano-sozo_magento2 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9b8a814cab188b12f4a0655ca98bc2d79bba093feec15cef58e6615a4e1b163
-  data.tar.gz: b20a3134e0ed2e7830fad511af9437778b5d49cf76cd379f228b8bf54fa4d31e
+  metadata.gz: 067f69be7940139b39853f161c2cdccfaf59bc3efe7c889a3c4282b7a6c91191
+  data.tar.gz: b235fcf83c747dcdb843e64bdddd44df30366bdc84a363a90e0425571b8a04f4
 SHA512:
-  metadata.gz: f5217263ed2b39368320994816f8100e0a0a61ff5880997c3b53744f8f21be1b5b7315ffea492568e34acbbf17c6260556fd5b8bd17a23d99c1cac2e24b6109a
-  data.tar.gz: 7d5846414673c6bb0174ac80fa8a7b45b1ebabd4e6cee4f058ffef7d7fbf3cb0f380b724ac4eea468f25c495da7347e2d8bbe46bb424e7760eeac85675caa70e
+  metadata.gz: 4015c5c7f9cf4be49d35cda7732803d4e7bd240c7d4b5f85470c8a05587c452fcb48452509561b9d55ef3fa0330ce41582c63f965e427addc5590001c64f9360
+  data.tar.gz: 60fc48f2e8a1b5437749978e887eec9d7ff28601a27742199826ba9a60101931ace0b6bed9ed44d91858561b79c6bd90c1fe52eb7e0989efbcc47668ae984f35

data/BUILD.md

@@ -0,0 +1,19 @@
+# Build Instructions
+
+To build the gem simply update the version number in `lib/capistrano/sozo_magento2/version.rb`.
+Then you'll need to commit to vcs as the build process uses the git ls command to grab the files.
+Following the commit, run the following:
+```
+gem build capistrano-sozo_magento.gemspec
+```
+The gem file generated will include the version number. To stop the file from being commited to the git repository move it into the pkg folder which is git ignored.
+
+To test locally you can run the following to install the gem locally:
+```
+gem install capistrano-sozo_magento2
+```
+
+To push the gem to ruby-gems.org run the following:
+```
+gem push capistrano-sozo_magento2-{version}.gem
+```

data/CHANGELOG.md

@@ -19,9 +19,25 @@ Given a version number MAJOR.MINOR.PATCH, increment the:
 * [Fixed] for any bug fixes.
 * [Security] in case of vulnerabilities.
 
-### [Unreleased]
+## [Unreleased]
 
-### [v1.0.1] - 2020-02-20
+## [v1.1.0] - 2020-02-24
+### Added
+- Added defaults for the :wp_backup, :keep_backups and :slack_channel instead of using ENV's
+- Added BUILD.md for reminders on how to build and publish the gem.
+
+### Changed
+- Magento and WordPress backup's now in their own commands and invoked from the main call.
+- Staging role now doesn't install composer dev requirements.
+
+### Removed
+- ENV references cleaned out and updated in the Companion Composer plugin.
+
+### Fixed
+- Confirm command now using correct symbols to display against roles.
+
+
+## [v1.0.1] - 2020-02-20
 ### Added
 - CHANGELOG.md
 - License text

data/README.md

@@ -7,7 +7,7 @@ It is advised to use bundler.
 
 1. Add the following to your projects `Gemfile`
 ```
-gem "capistrano-sozo_magento2", "~> 1.0"
+gem "capistrano-sozo_magento2", "~> 1.1"
 ```
 2. Install
 ```
@@ -35,15 +35,42 @@ require "capistrano/scm/git"
 install_plugin Capistrano::SCM::Git
 ```
 
+### Built Ins
+We have the following built ins setup for default projects.
+```
+set :linked_files, []
+
+set :linked_dirs, [
+    'magento/pub/media',
+    'magento/pub/sitemap',
+    'magento/var/amasty/geoip',
+    'magento/var/backups',
+    'magento/var/composer_home',
+    'magento/var/importexport',
+    'magento/var/import_history',
+    'magento/var/export',
+    'magento/var/log',
+    'magento/var/nginx',
+    'magento/var/report',
+    'magento/var/session', 
+    'magento/var/tmp',
+    'magento/wp/wp-content/uploads'
+]
+```
+If you would like to customize the linked files or directories for your project, you can copy either one or both of the above arrays into the `deployment/deploy.rb` or `deployment/deploy/*.rb` files and tweak them to fit your project's needs. Alternatively, you can add a single linked dir (or file) using `append` like this:
+```
+append :linked_dirs, 'path/to/link'
+```
+
 ## Versioning
-We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/sozodesign/capistrano-sozo-magento2/tags) or [CHANGELOG.md](./CHANGELOG.md). 
+We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/sozo-design/capistrano-sozo-magento2/tags) or [CHANGELOG.md](./CHANGELOG.md). 
 
 
 ## Authors
 * **Clive Walkden** - *Initial work* - [SOZO Design Ltd](https://github.com/sozo-design)
 
-See also the list of [contributors](https://github.com/sozodesign/capistrano-sozo-magento2/contributors) who participated in this project.
+See also the list of [contributors](https://github.com/sozo-design/capistrano-sozo-magento2/contributors) who participated in this project.
 
 
 ## License
-This project is licensed under the Proprietary License - see the [LICENSE](LICENSE) file for details
+This project is licensed under the Proprietary License - see the [LICENSE](./LICENSE) file for details

data/capistrano-sozo_magento.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
     spec.email      = ["clive@sozodesign.co.uk"]
     spec.description    = %q{Magento 2 support for Capistrano 3.x in SOZO hosted environments}
     spec.summary        = %q{Magento 2 support for Capistrano 3.x in SOZO hosted environments}
-    spec.homepage       = "https://github.com/sozodesign/capistrano-sozo-magento2"
+    spec.homepage       = "https://github.com/sozo-design/capistrano-sozo-magento2"
     spec.license        = "Proprietary"
     
     spec.files          = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(build|test|spec|features)/}) }

data/lib/capistrano/sozo_magento2.rb

@@ -44,7 +44,8 @@ after 'deploy:finished', "slack:deployed"
 after 'slack:deployed', "db:cleanup"
 
 after 'deploy:failed', "slack:failed"
-after 'slack:failed', 'magento:maintenance:disable'
+after 'slack:failed', "sozo:fix_current"
+after 'sozo:fix_current', 'magento:maintenance:disable'
 
 namespace :load do
     task :defaults do

data/lib/capistrano/sozo_magento2/defaults.rb

@@ -27,13 +27,12 @@ set :composer_require_dev_flags,    '--optimize-autoloader --prefer-dist'
 set :date_path,                     Time.now.strftime("%Y%m%d%H%M%S")
 set :backupdir,                     ->{ "#{fetch(:deploy_root)}/backups" }
 set :backupdirdate,                 ->{ "#{fetch(:backupdir)}/#{fetch(:date_path)}" }
-set :wp_db,                         ->{ ENV['WPDB_DATABASE'] }
-set :wp_backup,                     ->{ ENV['WPDB_BACKUP'] }
-set :keep_backups,                  ->{ ENV['CAP_KEEP_BACKUPS'] }
+set :wp_backup,                     fetch(:wp_backup, true)
+set :keep_backups,                  fetch(:keep_backups, 10)
 
 # Slack defaults
-set :slack_channel,                 ENV['SLACK_CHANNEL']
+set :slack_channel,                 fetch(:slack_channel, '#deployments')
 set :slack_webhook,                 'https://hooks.slack.com/services/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'
 
 # Deployment defaults
-set :confirm_deploy,                fetch(:magento_deploy_confirm, [])
+set :magento_deploy_confirm_roles,  fetch(:magento_deploy_confirm_roles, [])

data/lib/capistrano/sozo_magento2/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
     module SozoMagento2
-        VERSION = "1.0.1"
+        VERSION = "1.1.0"
     end
 end

data/lib/capistrano/tasks/composer.rake

@@ -1,13 +1,13 @@
 namespace :composer do
     desc "Install the Composer dependencies"
     task :install do
-        on roles :testing, :staging do
+        on roles(:all, filter: :composer_dev) do
             within release_path + 'magento/' do
                 execute :composer, "install", fetch(:composer_dev_flags)
             end
         end
 
-        on roles(:production) do
+        on roles(:all, exclude: :composer_dev) do
             within release_path + 'magento/' do
                 execute :composer, "install", fetch(:composer_flags)
             end
@@ -16,13 +16,13 @@ namespace :composer do
 
     desc "Update the Composer dependencies"
     task :update do
-        on roles :testing, :staging do
+        on roles(:all, filter: :composer_dev) do
             within release_path + 'magento/' do
                 execute :composer, "update", fetch(:composer_dev_flags)
             end
         end
 
-        on roles(:production) do
+        on roles(:all, exclude: :composer_dev) do
             within release_path + 'magento/' do
                 execute :composer, "update", fetch(:composer_flags)
             end

data/lib/capistrano/tasks/db.rake

@@ -8,20 +8,31 @@ namespace :db do
                 execute :mkdir, "-p", fetch(:backupdir)
             end
 
-            # Backup using n98-magerun but don't include the logs or sessions data
+            invoke 'db:mag_backup'
+            invoke 'db:wp_backup' if fetch(:wp_backup)
+        end
+    end
+
+    desc "Backup Magento database"
+    task :mag_backup do
+        on roles :all do
             info "Backing up Magento database."
             execute :n98magerun, 'db:dump', "--root-dir='#{fetch(:mage_root)}'",
                                             '--compression="gzip"',
                                             '--strip="@log @sessions"',
                                             '--force', "#{fetch(:backupdir)}/#{fetch(:date_path)}_m2.sql.gz"
+        end
+    end
 
-            if ENV['WPDB_BACKUP'] == "true"
-                info "Backing up WordPress database."
-                execute :n98magerun, 'db:dump', "--root-dir='#{fetch(:mage_root)}'",
-                                            '--compression="gzip"',
-                                            '--connection="wordpress"',
-                                            '--force', "#{fetch(:backupdir)}/#{fetch(:date_path)}_wp.sql.gz"
-            end
+    desc "Backup WordPress database"
+    task :wp_backup do
+        # Backup the database with a timestamp
+        on roles :all do
+            info "Backing up WordPress database."
+            execute :n98magerun, 'db:dump', "--root-dir='#{fetch(:mage_root)}'",
+                                        '--compression="gzip"',
+                                        '--connection="wordpress"',
+                                        '--force', "#{fetch(:backupdir)}/#{fetch(:date_path)}_wp.sql.gz"
         end
     end
 

data/lib/capistrano/tasks/deploy.rake

@@ -1,6 +1,6 @@
 namespace :deploy do
     before :starting, :confirm_action do
-        if fetch(:magento_deploy_confirm).include? fetch(:stage).to_s
+        if fetch(:magento_deploy_confirm_roles).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"
             proceed = STDIN.gets[0..0] rescue nil
             exit unless proceed == 'y' || proceed == 'Y'

data/lib/capistrano/tasks/sozo.rake

@@ -78,6 +78,8 @@ namespace :sozo do
                     execute :cp, "#{release_path}/environments/#{fetch(:environment)}/.htpasswd", "#{release_path}/magento/.htpasswd"
                 end
             end
+
+            invoke! "sozo:fix_current"
         end
 
         desc "Git Check"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-sozo_magento2
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Clive Walkden
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-20 00:00:00.000000000 Z
+date: 2021-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -46,6 +46,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- BUILD.md
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -65,7 +66,7 @@ files:
 - lib/capistrano/tasks/sozo.rake
 - lib/capistrano/tasks/sozo_magento2.rake
 - lib/capistrano/tasks/wordpress.rake
-homepage: https://github.com/sozodesign/capistrano-sozo-magento2
+homepage: https://github.com/sozo-design/capistrano-sozo-magento2
 licenses:
 - Proprietary
 metadata: {}