capistrano-craft 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '09f776fa507f01ebc0ba95804640d29136b275a1'
-  data.tar.gz: 5117c84753e343bbf86dacaf7730d61fe2daf2e4
+  metadata.gz: ccc517736e79408a6302f9d48c3d9fdf9add3283
+  data.tar.gz: ceeb2af2e5057d14dcfb24e781bd12d122c939e9
 SHA512:
-  metadata.gz: 0255aadbcfd907b73a5bed129038f64315dbab38b44f721002c9807f854960ac1a106b0553eebf3b7bbd612716a85c8c49b6aabc8214728c8bedf19c865e2277
-  data.tar.gz: feecf14faf1ca427911734b386f42c67ffbcc0158b1da3a1cad3b013e4ba41827af72d3dc0b0ced8cf7490958a344e1c8a6279b53297dbabacdc8620704c7190
+  metadata.gz: 1d441c129fe7c1dee24322f82bf01bc84ebd9b6b4ba481afd065d0041b941a0969de5452c17523bdff0fc7347b8c013a838e6edd2cdb5c8db3738ae9f7c06bd0
+  data.tar.gz: ef9a333c743f98f358f317a7f2eff081bceb246407d378b841f5cef2a6568bc359eb5752e21b36881ecd25be67adab5c56644225b00bb29b7a1ac475c9e2f6fd

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    capistrano-craft (0.1.0)
+    capistrano-craft (0.1.1)
       capistrano (~> 3.1)
       capistrano-composer (~> 0.0.6)
 

data/README.md

@@ -1,8 +1,8 @@
 # Capistrano::Craft
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/capistrano/craft`. To experiment with that code, run `bin/console` for an interactive prompt.
+As of October 2019 this is very still very much under development. Please make sure you have appropriate backups to avoid any potential data loss.
 
-TODO: Delete this and the text above, and describe your gem
+This gem automates the deployment of Craft CMS apps with Capistrano. It will automatically detect local and remote environment settings to make synchronizing of database and assets straightforward.
 
 ## Installation
 
@@ -12,32 +12,49 @@ Add this line to your application's Gemfile:
 gem 'capistrano-craft'
 ```
 
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
+Or install system wide:
 
     $ gem install capistrano-craft
 
 ## Usage
 
-TODO: Write usage instructions here
+    $ staging deploy
+    $ production deploy
+
+### Compiling Assets
 
-## Development
+Change `:craft_compile_assets` to be your production asset compilation command. By default, it is assumed your project has a `package.json` file and  `npm install` will be run first. The default asset compilcation command is `npm run production --production --silent`
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+### Synchronize Database
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
-## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/capistrano-craft. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+### Settings
 
-## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
-## Code of Conduct
 
-Everyone interacting in the Capistrano::Craft project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/capistrano-craft/blob/master/CODE_OF_CONDUCT.md).
+Full list of available settings:
+
+```
+set :config_path, "config"
+set :php, "php"
+
+set :craft_local_env, -> { "#{Dir.pwd}/.env" }
+set :craft_remote_env, -> { "#{fetch(:deploy_to)}/shared/.env" }
+
+set :craft_local_db_dump, "db.sql"
+set :craft_local_backups, "backups"
+set :craft_remote_backups, "shared/backups"
+
+# assets
+set :craft_compile_assets, "npm run production --production --silent"
+
+# console
+set :craft_console_path, -> { "craft" }
+set :craft_console_flags, ""
+
+# Role filtering
+set :craft_roles, :all
+set :craft_deploy_roles, :all
+```

data/lib/capistrano/craft/defaults.rb

@@ -2,9 +2,13 @@
 # Craft CMS defaults
 #
 
+append :linked_dirs, "vendor", "storage"
+
 set :config_path, "config"
 set :php, "php"
 
+set :assets_path, "web/uploads"
+
 set :craft_local_env, -> { "#{Dir.pwd}/.env" }
 set :craft_remote_env, -> { "#{fetch(:deploy_to)}/shared/.env" }
 
@@ -13,7 +17,7 @@ set :craft_local_backups, "backups"
 set :craft_remote_backups, "shared/backups"
 
 # assets
-set :craft_compile_assets, "npm run production --production --silent"
+set :craft_compile_assets, "production --quiet"
 
 # console
 set :craft_console_path, -> { "craft" }

data/lib/capistrano/craft/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module Craft
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

data/lib/capistrano/tasks/craft.rake

@@ -3,17 +3,16 @@ namespace :craft do
   desc "Ensure folder permissions are correct"
   task :set_permissions do
     on release_roles(fetch(:craft_deploy_roles)) do
-      within release_path do
-        # https://docs.craftcms.com/v3/installation.html#step-2-set-the-file-permissions
+      # https://docs.craftcms.com/v3/installation.html#step-2-set-the-file-permissions
 
-        execute "chmod 744 .env"
-        execute "chmod 744 composer.json"
-        execute "chmod 744 composer.lock"
-        execute "chmod 744 config/license.key"
-        execute "chmod -R 744 storage/*"
-        execute "chmod -R 744 vendor/*"
-        execute "chmod -R 744 web/cpresources/*"
-      end
+      # Attempt to chmod but don't fail if these aren't setup
+      execute "chmod -f 744 #{fetch(:craft_remote_env)} || true"
+      execute "chmod -f 744 #{release_path}/composer.json || true"
+      execute "chmod -f 744 #{release_path}/composer.lock || true"
+      execute "chmod -f 744 #{release_path}/config/license.key || true"
+      execute "chmod -fR 744 #{release_path}/storage/* || true"
+      execute "chmod -fR 744 #{release_path}/vendor/* || true"
+      execute "chmod -fR 744 #{release_path}/web/cpresources/* || true"
     end
   end
 
@@ -29,10 +28,10 @@ namespace :craft do
     desc "Synchronise assets between local and remote server"
     task :sync do
       run_locally do
-        on release_roles(fetch(:craft_deploy_roles)) do
+        release_roles(fetch(:craft_deploy_roles)).each do |role|
           puts "User -> " + role.user
-          execute :rsync, "-vzO #{role.user}@#{role.hostname}:#{shared_path}/web/assets/ web/assets"
-          execute :rsync, "-vzO web/assets/ #{role.user}@#{role.hostname}:#{shared_path}/web/assets"
+          execute :rsync, "-rvzO #{role.user}@#{role.hostname}:#{shared_path}/#{fetch(:assets_path)}/ #{fetch(:assets_path)}"
+          execute :rsync, "-rvzO #{fetch(:assets_path)}/ #{role.user}@#{role.hostname}:#{shared_path}/#{fetch(:assets_path)}"
         end
       end
     end

data/lib/capistrano/tasks/deploy.rake

@@ -7,8 +7,8 @@ namespace :deploy do
   task :compile_assets do
     on release_roles(fetch(:craft_deploy_roles)) do
       within release_path do
-        execute :npm, "install", "--production", "--silent"
-        execute fetch(:craft_compile_assets)
+        execute :npm, "install", "--silent"
+        execute :npm, "run", fetch(:craft_compile_assets)
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-craft
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Chris Dyer