如何从Capistrano运行rake任务?

时间:2008-11-23 06:28:56

标签: ruby rake capistrano

我已经有一个deploy.rb可以在我的生产服务器上部署我的应用程序。

我的应用包含自定义rake任务(lib / tasks目录中的.rake文件)。

我想创建一个能够远程运行该rake任务的上限任务。

16 个答案:

答案 0 :(得分:56)

更明确一点,在\config\deploy.rb中,在任何任务或命名空间之外添加:

namespace :rake do  
  desc "Run a task on a remote server."  
  # run like: cap staging rake:invoke task=a_certain_task  
  task :invoke do  
    run("cd #{deploy_to}/current; /usr/bin/env rake #{ENV['task']} RAILS_ENV=#{rails_env}")  
  end  
end

然后,从/rails_root/开始,您可以运行:

cap staging rake:invoke task=rebuild_table_abc

答案 1 :(得分:41)

run("cd #{deploy_to}/current && /usr/bin/env rake `<task_name>` RAILS_ENV=production")

通过Google找到它 - http://ananelson.com/said/on/2007/12/30/remote-rake-tasks-with-capistrano/

RAILS_ENV=production是一个陷阱 - 我一开始并没有想到它,也无法弄清楚为什么任务没有做任何事情。

答案 2 :(得分:41)

......几年后......

看看capistrano的rails插件,你可以在https://github.com/capistrano/rails/blob/master/lib/capistrano/tasks/migrations.rake#L5-L14看到它看起来像:

desc 'Runs rake db:migrate if migrations are set'
task :migrate => [:set_rails_env] do
  on primary fetch(:migration_role) do
    within release_path do
      with rails_env: fetch(:rails_env) do
        execute :rake, "db:migrate"
      end
    end
  end
end

答案 3 :(得分:41)

Capistrano 3 Generic Version (运行任何佣金任务)

构建Mirek Rusin的通用版本答案:

desc 'Invoke a rake command on the remote server'
task :invoke, [:command] => 'deploy:set_rails_env' do |task, args|
  on primary(:app) do
    within current_path do
      with :rails_env => fetch(:rails_env) do
        rake args[:command]
      end
    end
  end
end

使用示例:cap staging "invoke[db:migrate]"

请注意,deploy:set_rails_env要求来自capistrano-rails gem

答案 4 :(得分:20)

使用Capistrano风格的rake调用

有一种常见的方式'即可“与require 'bundler/capistrano'和其他修改rake的扩展一起工作。如果您使用多级,这也适用于预生产环境。要旨?如果可以,请使用config vars。

desc "Run the super-awesome rake task"
task :super_awesome do
  rake = fetch(:rake, 'rake')
  rails_env = fetch(:rails_env, 'production')

  run "cd '#{current_path}' && #{rake} super_awesome RAILS_ENV=#{rails_env}"
end

答案 5 :(得分:14)

使用capistrano-rake gem

只需安装gem而不会弄乱自定义capistrano配方,并在远程服务器上执行所需的rake任务,如下所示:

cap production invoke:rake TASK=my:rake_task

完全披露:我写了

答案 6 :(得分:7)

我个人在生产中使用这样的辅助方法:

def run_rake(task, options={}, &block)
  command = "cd #{latest_release} && /usr/bin/env bundle exec rake #{task}"
  run(command, options, &block)
end

允许运行类似于使用run(command)方法的rake任务。


注意:它类似于Duke提出的内容,但我:

  • 使用latest_release而不是current_release - 根据我的经验,这是你在运行rake命令时所期望的更多;
  • 遵循Rake和Capistrano的命名惯例(而不是:cmd - &gt; task和rake - &gt; run_rake)
  • 不要设置RAILS_ENV =#{rails_env},因为设置它的正确位置是default_run_options变量。例如,default_run_options [:env] = {'RAILS_ENV'=&gt; 'production'}# - &gt;干!

答案 7 :(得分:5)

有一个有趣的宝石cape可以让您的佣金任务作为Capistrano任务使用,因此您可以远程运行它们。 cape已有详细记录,但这里是关于如何设置i的简短概述。

安装gem之后,只需将其添加到config/deploy.rb文件中。

# config/deploy.rb
require 'cape'
Cape do
  # Create Capistrano recipes for all Rake tasks.
  mirror_rake_tasks
end

现在,您可以通过rake在本地或远程运行所有cap个任务。

作为额外的好处,cape可让您设置本地和远程运行rake任务的方式(不再需要bundle exec rake),只需将其添加到config/deploy.rb文件中:< / p>

# Configure Cape to execute Rake via Bundler, both locally and remotely.
Cape.local_rake_executable  = '/usr/bin/env bundle exec rake'
Cape.remote_rake_executable = '/usr/bin/env bundle exec rake'

答案 8 :(得分:3)

namespace :rake_task do
  task :invoke do
    if ENV['COMMAND'].to_s.strip == ''
      puts "USAGE: cap rake_task:invoke COMMAND='db:migrate'" 
    else
      run "cd #{current_path} && RAILS_ENV=production rake #{ENV['COMMAND']}"
    end
  end                           
end 

答案 9 :(得分:2)

这是我在deploy.rb中放置的简化运行rake任务的内容。这是一个围绕capistrano的run()方法的简单包装。

def rake(cmd, options={}, &block)
  command = "cd #{current_release} && /usr/bin/env bundle exec rake #{cmd} RAILS_ENV=#{rails_env}"
  run(command, options, &block)
end

然后我就像这样运行任何rake任务:

rake 'app:compile:jammit'

答案 10 :(得分:2)

这对我有用:

task :invoke, :command do |task, args|
  on roles(:app) do
    within current_path do
      with rails_env: fetch(:rails_env) do
        execute :rake, args[:command]
      end
    end
  end
end

然后只需运行cap production "invoke[task_name]"

答案 11 :(得分:1)

答案 12 :(得分:1)

大部分内容来自above answer,只需稍加强化即可从capistrano运行任何佣金任务

从capistrano

运行任何rake任务
$ cap rake -s rake_task=$rake_task

# Capfile     
task :rake do
  rake = fetch(:rake, 'rake')
  rails_env = fetch(:rails_env, 'production')

  run "cd '#{current_path}' && #{rake} #{rake_task} RAILS_ENV=#{rails_env}"
end

答案 13 :(得分:1)

如果你想传递多个参数,试试这个(根据marinosbern的回答):

task :invoke, [:command] => 'deploy:set_rails_env' do |task, args|
  on primary(:app) do
    within current_path do
      with :rails_env => fetch(:rails_env) do
        execute :rake, "#{args.command}[#{args.extras.join(",")}]"
      end
    end
  end
end

然后您可以像这样运行任务:cap production invoke["task","arg1","arg2"]

答案 14 :(得分:0)

所以我一直在努力。接缝运作良好。但是,您需要一个形成器才能真正利用代码。

如果您不想使用格式化程序,只需将日志级别设置为调试模式。这些semas到h

SSHKit.config.output_verbosity = Logger::DEBUG

Cap Stuff

namespace :invoke do
  desc 'Run a bash task on a remote server. cap environment invoke:bash[\'ls -la\'] '
  task :bash, :execute do |_task, args|
    on roles(:app), in: :sequence do
      SSHKit.config.format = :supersimple
      execute args[:execute]
    end
  end

  desc 'Run a rake task on a remote server. cap environment invoke:rake[\'db:migrate\'] '
  task :rake, :task do |_task, args|
    on primary :app do
      within current_path do
        with rails_env: fetch(:rails_env) do
          SSHKit.config.format = :supersimple
          rake args[:task]
        end
      end
    end
  end
end

这是我为使用上面的代码而构建的格式化程序。它基于:在sshkit中内置的textsimple,但它不是一种调用自定义任务的坏方法。哦,这很多不适用于最新版本的sshkit gem。我知道它适用于1.7.1。我这样说是因为master分支已经改变了可用的SSHKit :: Command方法。

module SSHKit
  module Formatter
    class SuperSimple < SSHKit::Formatter::Abstract
      def write(obj)
        case obj
        when SSHKit::Command    then write_command(obj)
        when SSHKit::LogMessage then write_log_message(obj)
        end
      end
      alias :<< :write

      private

      def write_command(command)
        unless command.started? && SSHKit.config.output_verbosity == Logger::DEBUG
          original_output << "Running #{String(command)} #{command.host.user ? "as #{command.host.user}@" : "on "}#{command.host}\n"
          if SSHKit.config.output_verbosity == Logger::DEBUG
            original_output << "Command: #{command.to_command}" + "\n"
          end
        end

        unless command.stdout.empty?
          command.stdout.lines.each do |line|
            original_output << line
            original_output << "\n" unless line[-1] == "\n"
          end
        end

        unless command.stderr.empty?
          command.stderr.lines.each do |line|
            original_output << line
            original_output << "\n" unless line[-1] == "\n"
          end
        end

      end

      def write_log_message(log_message)
        original_output << log_message.to_s + "\n"
      end
    end
  end
end

答案 15 :(得分:0)

以前的答案并没有帮助我,我发现了这一点: 来自http://kenglish.co/run-rake-tasks-on-the-server-with-capistrano-3-and-rbenv/

namespace :deploy do
  # ....
  # @example
  #   bundle exec cap uat deploy:invoke task=users:update_defaults
  desc 'Invoke rake task on the server'
  task :invoke do
    fail 'no task provided' unless ENV['task']

    on roles(:app) do
      within release_path do
        with rails_env: fetch(:rails_env) do
          execute :rake, ENV['task']
        end
      end
    end
  end

end

运行任务使用

bundle exec cap uat deploy:invoke task=users:update_defaults

也许对某人有用