108

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

我的应用程序包含一个自定义 rake 任务（lib/tasks 目录中的 .rake 文件）。

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

4

16 回答 16

60

更明确一点，在您的\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
于 2010-02-03T13:12:35.697 回答
47

Capistrano 3 通用版本（运行任何 rake 任务）

构建 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

于 2014-03-06T19:29:28.123 回答
44

……几年后……

看看 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
于 2013-12-10T21:59:34.560 回答
41 
run("cd #{deploy_to}/current && /usr/bin/env rake `<task_name>` RAILS_ENV=production")

用谷歌找到它——http: //ananelson.com/said/on/2007/12/30/remote-rake-tasks-with-capistrano/

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

于 2008-11-23T06:46:08.080 回答
20

使用 Capistrano 风格的 rake 调用

有一种通用的方式可以“正常工作”require 'bundler/capistrano'以及修改 rake 的其他扩展。如果您使用多阶段，这也适用于预生产环境。要旨？如果可以，请使用配置变量。

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
于 2012-05-08T01:37:32.910 回答
17

使用capistrano-rake宝石

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

cap production invoke:rake TASK=my:rake_task

全面披露：我写的

于 2016-03-31T10:58:18.700 回答
7

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

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

这允许运行类似于使用运行（命令）方法的 rake 任务。

注意：这类似于杜克提出的建议，但我：

  • 使用 latest_release 而不是 current_release - 根据我的经验，运行 rake 命令时它更符合您的期望；
  • 遵循 Rake 和 Capistrano 的命名约定（而不是：cmd -> task 和 rake -> run_rake）
  • 不要设置 RAILS_ENV=#{​​rails_env} 因为设置它的正确位置是 default_run_options 变量。例如 default_run_options[:env] = {'RAILS_ENV' => 'production'} # -> DRY！
于 2011-08-29T11:52:05.223 回答
5

有一个有趣的 gem cape可以让你的 rake 任务作为 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文件中：

# 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'
于 2012-01-30T02:04:17.590 回答
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
于 2012-12-06T14:13:29.617 回答
3

这对我有用：

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]"

于 2015-12-23T07:18:00.377 回答
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'
于 2011-06-14T23:31:34.070 回答
1

这也有效：

run("cd #{release_path}/current && /usr/bin/rake <rake_task_name>", :env => {'RAILS_ENV' => rails_env})

更多信息：Capistrano Run

于 2010-07-26T17:22:38.710 回答
1

其中大部分来自上面的答案，并略微增强了从 capistrano 运行任何 rake 任务

从 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
于 2013-07-04T06:33:03.760 回答
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"]

于 2014-09-24T01:21:34.127 回答
1

以前的答案对我没有帮助，我发现了这个：来自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

也许它对某人有用

于 2019-09-13T14:37:33.753 回答
0

所以我一直在努力。它看起来运作良好。但是，您需要一个格式化程序才能真正利用代码。

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

SSHKit.config.output_verbosity = Logger::DEBUG

帽子的东西

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。我这样说是因为主分支更改了可用的 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
于 2015-05-12T00:44:34.980 回答