README.md in capistrano-rails-1.1.3 vs README.md in capistrano-rails-1.1.4

- old
+ new

@@ -3,56 +3,72 @@ Rails specific tasks for Capistrano v3: - `cap deploy:migrate` - `cap deploy:compile_assets` -Some rails specific options. +## Installation +Add this line to your application's Gemfile: + ```ruby -set :rails_env, 'staging' # If the environment differs from the stage name -set :migration_role, 'migrator' # Defaults to 'db' -set :conditionally_migrate, true # Defaults to false. If true, it's skip migration if files in db/migrate not modified -set :assets_roles, [:web, :app] # Defaults to [:web] -set :assets_prefix, 'prepackaged-assets' # Defaults to 'assets' this should match config.assets.prefix in your rails config/application.rb +gem 'capistrano', '~> 3.1' +gem 'capistrano-rails', '~> 1.1' ``` -If you need to touch `public/images`, `public/javascripts` and `public/stylesheets` on each deploy: +## Usage +Require everything (`bundler`, `rails/assets` and `rails/migrations`): + ```ruby -set :normalize_asset_timestamps, %{public/images public/javascripts public/stylesheets} +# Capfile +require 'capistrano/rails' ``` -## Installation +Or require just what you need manually: -Add this line to your application's Gemfile: +```ruby +# Capfile +require 'capistrano/bundler' # Rails needs Bundler, right? +require 'capistrano/rails/assets' +require 'capistrano/rails/migrations' +``` - gem 'capistrano', '~> 3.1' - gem 'capistrano-rails', '~> 1.1' +Please note that any `require`s should be placed in `Capfile`, not in `config/deploy.rb`. -## Usage +You can tweak some Rails-specific options in `config/deploy.rb`: -Require everything (bundler, rails/assets and rails/migrations) +```ruby +# If the environment differs from the stage name +set :rails_env, 'staging' - # Capfile - require 'capistrano/rails' +# Defaults to 'db' +set :migration_role, 'migrator' -Or require just what you need manually: +# Defaults to false +# Skip migration if files in db/migrate were not modified +set :conditionally_migrate, true - # Capfile - require 'capistrano/bundler' # Rails needs Bundler, right? - require 'capistrano/rails/assets' - require 'capistrano/rails/migrations' +# Defaults to [:web] +set :assets_roles, [:web, :app] -Please note that any `require` should be placed in `Capfile`, not `config/deploy.rb`. +# Defaults to 'assets' +# This should match config.assets.prefix in your rails config/application.rb +set :assets_prefix, 'prepackaged-assets' +# If you need to touch public/images, public/javascripts, and public/stylesheets on each deploy +set :normalize_asset_timestamps, %{public/images public/javascripts public/stylesheets} +``` + ### Symlinks You'll probably want to symlink Rails shared files and directories like `log`, `tmp` and `public/uploads`. Make sure you enable it by setting `linked_dirs` and `linked_files` options: - # deploy.rb - set :linked_dirs, fetch(:linked_dirs, []).push('log', 'tmp/pids', 'tmp/cache', 'tmp/sockets', 'vendor/bundle', 'public/system', 'public/uploads') - set :linked_files, fetch(:linked_files, []).push('config/database.yml', 'config/secrets.yml') +```ruby +# deploy.rb +set :linked_dirs, fetch(:linked_dirs, []).push('log', 'tmp/pids', 'tmp/cache', 'tmp/sockets', 'vendor/bundle', 'public/system', 'public/uploads') +set :linked_files, fetch(:linked_files, []).push('config/database.yml', 'config/secrets.yml') +``` ## Contributing 1. Fork it 2. Create your feature branch (`git checkout -b my-new-feature`)