Capistrano::Symfony

Provide some Symfony task for to use them in your Capistrano project. For more flexibility it comes just whit tasks and it's nothing doing automatically on the Capistrano flow. If you need something from Symfony, so hook into the Capistrano flow by your self.

Installation

Add this line to your application's Gemfile:

# Gemfile
gem 'capistrano', '~> 3.1.0'
gem 'capistrano-symfony-light',

And then execute:

$ bundle

Or install it yourself as:

$ gem install capistrano-symfony-light

Usage

Require capistrano-symfony-light in your cap file

# Capfile
require 'capistrano/symfony'

Settings

The following settings (displayed with defaults) are provided:

# If you have a other name for your php, maybe like "php54 or php55" change it.
set :symfony_php,                       "php"

# If you use a diffrent php.ini change it and set the path.
set :symfony_php_ini,                   ""

# Set the roles for all tasks.
set :symfony_roles,                     :all

# Set the path in that is run all the tasks.
set :symfony_working_path,     ->       { fetch(:release_path) }

# Symfony application path
set :symfony_app_path,                  "app"

# Symfony web path
set :symfony_web_path,                  "web"

# Symfony log path
set :symfony_log_path,                  "#{fetch(:symfony_app_path)}/logs"

# Symfony cache path
set :symfony_cache_path,                "#{fetch(:symfony_app_path)}/cache"

# Symfony config file path
set :symfony_app_config_path,           "#{fetch(:symfony_app_path)}/config"

# Symfony console path
set :symfony_console_path,              "#{fetch(:symfony_app_path)}/console"

# Files to clear relative from :symfony_working_path
set :symfony_clear_files,               ["#{fetch(:symfony_web_path)}/app_*.php"]

# Folders that have be created relative from :symfony_working_path
set :symfony_create_folders,            ["#{fetch(:symfony_app_path)}/cache"]

# Symfony build_bootstrap.php path depend on the composer setting
set :symfony_build_bootstrap_path,      "./vendor/sensio/distribution-bundle/Resources/bin/build_bootstrap.php"

Integrated common tasks

The folowing common tasks are already integrated and every task is reenabled, that means you can call them many times if you need.

symfony:assets:install
symfony:assetic:dump
symfony:cache:clear
symfony:cache:warmup
symfony:clear_files
symfony:create_folders
symfony:build_bootstrap

So you can use them with hooks like this:

  after 'deploy:updated',   'symfony:assets:install'
  after 'deploy:updated',   'symfony:cache:clear'

Or if you need to pass some options:

namespace :deploy do

  task :assetic_dump_prod do
    invoke "symfony:assetic:dump", "--env=prod"
  end

  task :cache_clear_prod do
    invoke "symfony:cache:clear", "--env=prod --no-debug"
  end

  after "deploy:updated", "symfony:build_bootstrap"
  after "deploy:updated", "deploy:cache_clear_prod"
  after "deploy:updated", "deploy:assetic_dump_prod"
end

Your tasks can you also define in a separate .rake and load it in you Capfile:

# Load custom tasks from `lib/capistrano/tasks' if you have any defined
#Dir.glob('lib/capistrano/tasks/*.rake').each { |r| import r }

If you need a not already provided task you can use "symfony:console"

invoke "symfony:console", "doctrine:schema:update", "--force"

Contributing

Fork it
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Create new Pull Request