sheharyarn / capistrano-rake

Execute rake tasks on remote servers (Only Capistrano 3+)

capistrano-rake

Invoke any rake task on a remote server using capistrano. Installing this gem adds a new capistrano task invoke:rake that will allow you to execute rake tasks remotely. Only supports Capistrano 3 and above.

Installation

Add the gem to your Gemfile after setting up Capistrano, preferably in the :development group:

group :development do
  gem 'capistrano',      require: false
  gem 'capistrano-rake', require: false
end

Then bundle and add it to your Capfile:

# Capfile

require 'capistrano/rake'

Usage

To execute a rake task on a remote server, you need to pass that task's name to the invoke:rake capistrano task like this:

$ cap stage invoke:rake TASK=some:rake_task

# Examples
$ cap staging    invoke:rake TASK=db:seed
$ cap production invoke:rake TASK=paperclip:refresh

Configuration

You can optionally specify the capistrano roles for the rake task (Defaults to :app):

# Defaults to [:app]
set :rake_roles, [:db, :app]

Contributing

1. Fork it ( https://github.com/sheharyarn/capistrano-rake/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

License

The gem is available as open source under the terms of the MIT License.

capistrano-rake's Issues

add env variable to the command

I would like to add an env variable to the command, is there a way to do it?

Task status output?

I just ran this for the first time. The task is updating 100,000+ records. Its supposed to be outputting something after each one. But I'm not getting any output when using this. Is this to be expected? Hopefully its not just hanging...

Logging using puts not working

Hi, I use a lot of puts in my task but nothing is logged into terminal while invoking this on server, when I run this task on my local machine everything is correct.

Task declaration:

namespace :db do
  task backup: :environment do
    puts "Starting database backup " 

This is how I run this task:
cap staging invoke:rake TASK=db:backup

How to invoke it in config?

How to invoke this for e.g. with an after?

namespace :deploy do
    after :publishing, 'invoke:rake TASK=some:task'
end

... does not work. How to do it correctly?

ound

Feature request: ROLES option

Thanks a lot for creating this. Here's one possible improvement that might be useful: limit the execution of the rake task to certain roles. Like so:

cap production invoke:rake TASK=queues:relaunch ROLES=cron,background

This should execute the tasks only in the server where the roles "cron" and/or "background" are active. For example if the servers are configured like this in deploy/production.rb:

server 'server1', user: 'deploy', roles: %w(web app db importer cron background)
server 'server2', user: 'deploy', roles: %w(web app db importer cron)
server 'server3', user: 'deploy', roles: %w(web app db importer)

Then the invocation mentioned above would execute rake queues:relaunch on server1 and server2, but not on server 3.