capistrano-shared-helpers

Provides a set of helper tasks related to the shared directory.

Install

gem install 'capistrano-shared-helpers'

For bundler, add it into your Gemfile

gem 'capistrano-shared-helpers'

Usage

You can include all helpers in config/deploy.rb:

require 'capistrnao-shared-helpers' # includes all helper tasks

Or only include a specific helper:

require 'capistrano-ssh-helpers/privates'

Helpers

shared

  • Add checks to deploy:check to ensure file paths defined in :shared var exist on remote server.

  • Create parent dirs for file paths defined in :shared, after deploy:setup.

  • Provide a rake task to upload files/dirs defined in :shared. To use it, call:

    cap deploy:shared:upload
    

privates

  • Add checks to deploy:check to ensure file paths defined in :privates var exist on remote server.

  • Create parent dirs for file paths defined in :privates, after deploy:setup.

  • Provide a rake task to upload files/dirs defined in :privates to the private shared path. To use it, call:

    cap deploy:privates:upload
    

Contributing to capistrano-shared-helpers

  • Check out the latest master to make sure the feature hasn’t been implemented or the bug hasn’t been fixed yet.

  • Check out the issue tracker to make sure someone already hasn’t requested it and/or contributed it.

  • Fork the project.

  • Start a feature/bugfix branch.

  • Commit and push until you are happy with your contribution.

  • Make sure to add tests for it. This is important so I don’t break it in a future version unintentionally.

  • Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

Copyright © 2012 Huiming Teo. See LICENSE.txt for further details.