capistrano-symfony 1.0.0 → 2.0.0.pre.alfa1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2cb7c4d2d6f470071d32ecccb5586136084bbc39cf28ed72640f33915f291aab
-  data.tar.gz: 466dd7042e92436e7065bac8d6e3524d098bcce618775901cdc69cde00ce6f95
+  metadata.gz: a5eb750c01cbf21ad2515224a33dc05218075fa5704baa5ba4812923c88664ff
+  data.tar.gz: b2f05e7f388fc7e7478587ecafe9b3b3338f787a755d2ac835f9667da5d5d55b
 SHA512:
-  metadata.gz: aba40c1dc55cecac24d8d71de87fd185beb72a883d904218e6bd6fbf1d573f7049edfa881ff74925cdd453fdc665e5f04ee8d8da3af0d9f212698b225b5c8a56
-  data.tar.gz: 4c315f431124e5564c9c7aa85c37f0535f0d70cae27ae7ebad5b20a5c1913a774314d19a1e595d57491ae1c8103636bb23040fae5f3f08126dac4923fddd346a
+  metadata.gz: c9f0f6edbfff97b405d1171cf1979c7dc37cb8ac782c492da9f46b09603e08f57e409c7cd1186da1fd2b29ea575ad3ae70b20c107fd3e3652830ed7227318933
+  data.tar.gz: bd4c74fd174d1491aeb73c64bff92d10c7e0e68f63af998a9979ae7c3efa7f25b0ecffc7f4f176db88e6a0fb3fccdb37d2aac9e5ad3f84f900dd4b5039c05e5c

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 # Capistrano Symfony 1.x Changelog
 
 
+## `2.0.0-alfa1`
+
+Support for only Symfony4.
+
 ## `1.0.0`
 
 No changes since RC3

data/README.md

@@ -1,71 +1,102 @@
 # Capistrano::Symfony
 
-Symfony 2 (standard edition) specific tasks for Capistrano v3 (inspired by [capifony][2]).
+Symfony 4 specific tasks for Capistrano v3 (inspired by [capifony][2]).
 
 It leverages the following capistrano tasks to deploy a Symfony app
 
 * https://github.com/capistrano/composer
 * https://github.com/capistrano/file-permissions
 
+## Version information
+
+#### Version 1.x
+
+This version is built for **Symfony 2 and 3**. 
+
+Go to [Version 1 documentation](/../../tree/1.x). 
+
+#### Version 2.x
+
+This version is built for **Symfony 4**. 
+
+You are currently on the Version 2 branch. 
+
 ## Installation
 
+Specify your dependencies: 
 ```
 # Gemfile
-gem 'capistrano',  '~> 3.4'
-gem 'capistrano-symfony', '~> 1.0.0'
+source 'https://rubygems.org'
+gem 'capistrano',  '~> 3.11'
+gem 'capistrano-symfony', '~> 2.0.0-alfa1'
 ```
 
-## Usage
+Install your dependencies: 
+```
+bundle install
+```
+
+When `capistrano` and `capistrano-symfony` is installed. Run the following command
+to set up your local files:
 
-Require capistrano-symfony in your cap file
+```
+cap install
+```
+
+Make Capistrano aware of `'capistrano/symfony' by require capistrano-symfony in your
+new Capfile
 
 ```
 # Capfile
 require 'capistrano/symfony'
+
+# If you use composer you might want this:
+require 'capistrano/composer'
 ```
 
+## Usage
+
+```
+cap staging deploy
+cap production deploy
+```
 
 ### Settings
 
-If you are using an un-modified symfony-standard edition, version 3 then you do not need to change/add anything to your `deploy.rb` other than what is required from Capistrano.
+If you are using a standard Symfony Flex application that follows the best practises 
+then you do not need to change/add anything to your `deploy.rb` other than what is 
+required from Capistrano.
 
-We do however expose the following settings (shown with default evaluated values) that can be modified to suit your project. Please refer to `lib/capistrano/symfony/defaults.rb` to see exactly how the defaults are set up.
+We do however expose the following settings (shown with default evaluated values) 
+that can be modified to suit your project. Please refer to `lib/capistrano/symfony/defaults.rb` 
+to see exactly how the defaults are set up.
 
 
 ```ruby
-# Symfony console commands will use this environment for execution
-set :symfony_env,  "prod"
-
-# Set this to 2 for the old directory structure
-set :symfony_directory_structure, 3
-# Set this to 4 if using the older SensioDistributionBundle
-set :sensio_distribution_version, 5
 
 # symfony-standard edition directories
-set :app_path, "app"
-set :web_path, "web"
-set :var_path, "var"
 set :bin_path, "bin"
+set :config_path, "config"
+set :var_path, "var"
+set :web_path, "public"
 
-# The next 3 settings are lazily evaluated from the above values, so take care
+# The next settings are lazily evaluated from the above values, so take care
 # when modifying them
-set :app_config_path, "app/config"
-set :log_path, "var/logs"
+set :log_path, "var/log"
 set :cache_path, "var/cache"
 
 set :symfony_console_path, "bin/console"
 set :symfony_console_flags, "--no-debug"
 
-# Remove app_dev.php during deployment, other files in web/ can be specified here
-set :controllers_to_clear, ["app_*.php", "config.php"]
-
 # asset management
-set :assets_install_path, "web"
+set :assets_install_path, "public"
 set :assets_install_flags,  '--symlink'
 
 # Share files/directories between releases
-set :linked_files, []
 set :linked_dirs, ["var/logs"]
+set :linked_files, []
+# To use a .env file:
+#set :linked_files, [".env"]
 
 # Set correct permissions between releases, this is turned off by default
 set :file_permissions_paths, ["var"]
@@ -73,19 +104,14 @@ set :permission_method, false
 
 # Role filtering
 set :symfony_roles, :all
-```
-
-#### Using this plugin with the old Symfony 2 directory structure and SensioDistributionBundle <= 4
-
-Add the following to `deploy.rb` to use the old directory structure
+set :symfony_deploy_roles, :all
 
+# Add extra environment variables: 
+set :default_env, {
+ 'APP_ENV' => 'prod'
+ 'SECRET' => 'foobar'
+}
 ```
-# deploy.rb
-set :symfony_directory_structure, 2
-set :sensio_distribution_version, 4
-```
-
-If you are upgrading this gem and have modified `linked_dirs` or "advanced" variables such as `log_path` then you will need to update those accordingly
 
 ### Flow
 
@@ -109,6 +135,7 @@ deploy
 |   |__ deploy:symlink:shared
 |   |__ symfony:create_cache_dir
 |   |__ symfony:set_permissions
+|   |__ symfony:make_console_executable
 |__ deploy:updated
 |   |__ symfony:cache:warmup
 |   |__ symfony:clear_controllers
@@ -124,9 +151,12 @@ deploy
 
 ### File permissions
 
-Set the `permission_method` variable to one of `:chmod`, `:acl`, or `:chgrp` in your `deploy.rb` to handle the common scenario of a web user and the deploy user being different.
+Set the `permission_method` variable to one of `:chmod`, `:acl`, or `:chgrp` in
+your `deploy.rb` to handle the common scenario of a web user and the deploy user
+being different.
 
-Both will need access to the files/directories such as `var/cache` and `web/uploads` (if you handle uploads). Set `file_permissions_users` to your webserver user
+Both will need access to the files/directories such as `var/cache` and `public/uploads`
+(if you handle uploads). Set `file_permissions_users` to your webserver user
 
 Example:
 
@@ -135,19 +165,24 @@ Example:
 
 set :permission_method, :acl
 set :file_permissions_users, ["nginx"]
-set :file_permissions_paths, ["var", "web/uploads"]
+set :file_permissions_paths, ["var", "public/uploads"]
 ```
 
-Please note that `:acl` requires that `setfacl` be available on your deployment target
+**Note:** Using `:acl` requires that `setfacl` be available on your deployment target.
+**Note:** If you are getting an error like `setfacl: Option -m: Invalid argument near character 3`,  
+it means that the users in `file_permissions_users` do not exist on your deployment
+target.
+
+
 
-See [the symfony documentation](http://symfony.com/doc/current/book/installation.html#checking-symfony-application-configuration-and-setup) and [the file permission capistrano plugin](https://github.com/capistrano/file-permissions) for reference
+See [the symfony documentation](http://symfony.com/doc/current/book/installation.html#checking-symfony-application-configuration-and-setup)
+and [the file permission capistrano plugin](https://github.com/capistrano/file-permissions) for reference.
 
 ### Integrated common tasks
 
 The following common tasks are available:
 
 * `symfony:assets:install`
-* `symfony:build_bootstrap` - useful if you disable composer
 
 So you can use them with hooks in your project's `deploy.rb` like this:
 
@@ -172,7 +207,8 @@ namespace :deploy do
 end
 ```
 
-If you want to execute a command on a host with a given role you can use the Capistrano `on` DSL, additionally using `within` from Capistrano will change the directory
+If you want to execute a command on a host with a given role you can use the Capistrano
+`on` DSL, additionally using `within` from Capistrano will change the directory
 
 ```ruby
 namespace :deploy do
@@ -184,6 +220,24 @@ namespace :deploy do
 end
 ```
 
+### Using composer
+
+If you use composer, make sure your Capfile includes: 
+
+```
+require 'capistrano/composer'
+```
+
+To download the composer executable add the following to your `deploy.rb`:
+
+```
+# First define deploy target: 
+set :deploy_to, "/home/sites/com.example"
+
+# Install composer if it does not exist
+SSHKit.config.command_map[:composer] = "php #{shared_path.join("composer.phar")}"
+```
+
 [1]: http://capistranorb.com/documentation/getting-started/flow/
 [2]: http://capifony.org/
 [3]: http://symfony.com/doc/current/bundles/DoctrineMigrationsBundle/index.html

data/UPGRADING-1.0.md

@@ -0,0 +1,9 @@
+UPGRADING FROM 0.x to 1.0
+=========================
+
+* Add the following to your `deploy.rb`:
+```ruby
+# Role filtering
+set :symfony_roles, :all
+set :symfony_deploy_roles, :all
+```

data/capistrano-symfony.gemspec

@@ -4,11 +4,11 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |gem|
   gem.name          = "capistrano-symfony"
-  gem.version       = '1.0.0'
+  gem.version       = '2.0.0-alfa1'
   gem.authors       = ["Peter Mitchell"]
   gem.email         = ["pete@peterjmit.com"]
   gem.description   = %q{Symfony specific Capistrano tasks}
-  gem.summary       = %q{Capistrano Symfony - Easy deployment of Symfony 2 & 3 apps with Ruby over SSH}
+  gem.summary       = %q{Capistrano Symfony - Easy deployment of Symfony 4 apps with Ruby over SSH}
   gem.homepage      = "http://github.com/capistrano/capistrano-symfony"
 
   gem.files         = `git ls-files`.split($/)

data/docs/maintainers.md

@@ -0,0 +1,17 @@
+# Documentation for maintainers
+
+Since this is a Ruby tool used by PHP programmers it might be a good idea to document
+some things. 
+
+
+## Making a release
+
+Checklist for making a release: 
+
+- Write changelog 
+- Update version number in `capistrano-symfony.gemspec`
+- Make a new release with GitHub 
+- Build the gem with `gem build capistrano-symfony.gemspec`
+- Push the gem to rubygems.org: `gem push capistrano-symfony-X.X.X.gem` 
+- Add the `capistrano-symfony-X.X.X.gem` to the GitHub release 
+

data/lib/capistrano/dsl/symfony.rb

@@ -38,16 +38,6 @@ module Capistrano
         release_path.join('vendor')
       end
 
-      def build_bootstrap_path
-        bootstrap_path = symfony_vendor_path.join("sensio/distribution-bundle")
-
-        if fetch(:sensio_distribution_version).to_i <= 4
-          bootstrap_path = bootstrap_path.join("Sensio/Bundle/DistributionBundle")
-        end
-
-        bootstrap_path.join("Resources/bin/build_bootstrap.php")
-      end
-
       def symfony_console(command, params = '')
         execute :php, symfony_console_path, command, params, fetch(:symfony_console_flags)
       end

data/lib/capistrano/symfony/defaults.rb

@@ -3,27 +3,21 @@
 #
 set :symfony_env,  "prod"
 
-set :symfony_directory_structure, 3
-set :sensio_distribution_version, 5
-
 # symfony-standard edition top-level directories
-set :app_path, "app"
-set :web_path, "web"
-set :var_path, "var"
 set :bin_path, "bin"
+set :config_path, "config"
+set :var_path, "var"
+set :web_path, "public"
 
 # Use closures for directories nested under the top level dirs, so that
 # any changes to web/app etc do not require these to be changed also
-set :app_config_path, -> { fetch(:app_path) + "/config" }
-set :log_path, -> { fetch(:symfony_directory_structure) == 2 ? fetch(:app_path) + "/logs" : fetch(:var_path) + "/logs" }
-set :cache_path, -> { fetch(:symfony_directory_structure) == 2 ? fetch(:app_path) + "/cache" : fetch(:var_path) + "/cache" }
+set :log_path, -> { fetch(:var_path) + "/log" }
+set :cache_path, -> { fetch(:var_path) + "/cache" }
 
 # console
-set :symfony_console_path, -> { fetch(:symfony_directory_structure) == 2 ?  fetch(:app_path) + '/console' : fetch(:bin_path) + "/console" }
+set :symfony_console_path, -> { fetch(:bin_path) + "/console" }
 set :symfony_console_flags, "--no-debug"
 
-set :controllers_to_clear, ["app_*.php", "config.php"]
-
 # assets
 set :assets_install_path, fetch(:web_path)
 set :assets_install_flags,  '--symlink'
@@ -31,15 +25,16 @@ set :assets_install_flags,  '--symlink'
 #
 # Capistrano defaults
 #
-set :linked_files, -> { [fetch(:app_config_path) + "/parameters.yml"] }
+set :linked_files, -> { [".env"] }
 set :linked_dirs, -> { [fetch(:log_path)] }
 
 #
 # Configure capistrano/file-permissions defaults
 #
-set :file_permissions_paths, -> { fetch(:symfony_directory_structure) == 2 ? [fetch(:log_path), fetch(:cache_path)] : [fetch(:var_path)] }
+set :file_permissions_paths, -> { [fetch(:var_path)] }
 # Method used to set permissions (:chmod, :acl, or :chown)
 set :permission_method, false
 
 # Role filtering
 set :symfony_roles, :all
+set :symfony_deploy_roles, :all

data/lib/capistrano/tasks/deploy.rake

@@ -8,6 +8,7 @@ namespace :deploy do
   task :updating do
     invoke "symfony:create_cache_dir"
     invoke "symfony:set_permissions"
+    invoke "symfony:make_console_executable"
   end
 
   task :updated do

data/lib/capistrano/tasks/symfony.rake

@@ -64,29 +64,14 @@ namespace :symfony do
     end
   end
 
-  desc "Clear non production controllers"
-  task :clear_controllers do
-    next unless any? :controllers_to_clear
+  desc "Make symfony_console_path executable"
+  task :make_console_executable do
     on release_roles(fetch(:symfony_deploy_roles)) do
-      within symfony_web_path do
-        execute :rm, "-f", *fetch(:controllers_to_clear)
-      end
-    end
-  end
-
-  desc "Build the bootstrap file"
-  task :build_bootstrap do
-    on release_roles(fetch(:symfony_deploy_roles)) do
-      within release_path do
-        if fetch(:symfony_directory_structure) == 2
-          execute :php, build_bootstrap_path, fetch(:app_path)
-        else
-          execute :php, build_bootstrap_path, fetch(:var_path)
+        within release_path do
+          execute :chmod, "755", fetch(:symfony_console_path)
         end
       end
-    end
   end
-
 end
 
 task :symfony => ["symfony:console"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-symfony
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0.pre.alfa1
 platform: ruby
 authors:
 - Peter Mitchell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-06 00:00:00.000000000 Z
+date: 2018-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -63,7 +63,9 @@ files:
 - CHANGELOG.md
 - LICENCE.txt
 - README.md
+- UPGRADING-1.0.md
 - capistrano-symfony.gemspec
+- docs/maintainers.md
 - lib/capistrano-symfony.rb
 - lib/capistrano/dsl/symfony.rb
 - lib/capistrano/symfony.rb
@@ -96,14 +98,13 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: Capistrano Symfony - Easy deployment of Symfony 2 & 3 apps with Ruby over
-  SSH
+summary: Capistrano Symfony - Easy deployment of Symfony 4 apps with Ruby over SSH
 test_files: []