在Capistrano中部署Git子目录

时间:2008-08-26 23:15:42

标签: ruby-on-rails git deployment capistrano

我的主分支布局是这样的:

/ < - 顶级

/ client < - 桌面客户端源文件

/ server < - Rails app

我想做的只是下拉deploy.rb中的/ server目录,但我似乎无法找到任何方法。 / client目录很大,因此设置一个钩子来复制/服务器到/将不能很好地工作,它只需要拉下Rails应用程序。

11 个答案:

答案 0 :(得分:77)

没有任何脏的分叉动作,但更脏![/ p>

在我的config / deploy.rb中:

set :deploy_subdir, "project/subdir"

然后我将这个新策略添加到我的Capfile中:

require 'capistrano/recipes/deploy/strategy/remote_cache'

class RemoteCacheSubdir < Capistrano::Deploy::Strategy::RemoteCache

  private

  def repository_cache_subdir
    if configuration[:deploy_subdir] then
      File.join(repository_cache, configuration[:deploy_subdir])
    else
      repository_cache
    end
  end

  def copy_repository_cache
    logger.trace "copying the cached version to #{configuration[:release_path]}"
    if copy_exclude.empty? 
      run "cp -RPp #{repository_cache_subdir} #{configuration[:release_path]} && #{mark}"
    else
      exclusions = copy_exclude.map { |e| "--exclude=\"#{e}\"" }.join(' ')
      run "rsync -lrpt #{exclusions} #{repository_cache_subdir}/* #{configuration[:release_path]} && #{mark}"
    end
  end

end


set :strategy, RemoteCacheSubdir.new(self)

答案 1 :(得分:42)

对于Capistrano 3.0,我使用以下内容:

在我的Capfile

# Define a new SCM strategy, so we can deploy only a subdirectory of our repo.
module RemoteCacheWithProjectRootStrategy
  def test
    test! " [ -f #{repo_path}/HEAD ] "
  end

  def check
    test! :git, :'ls-remote', repo_url
  end

  def clone
    git :clone, '--mirror', repo_url, repo_path
  end

  def update
    git :remote, :update
  end

  def release
    git :archive, fetch(:branch), fetch(:project_root), '| tar -x -C', release_path, "--strip=#{fetch(:project_root).count('/')+1}"
  end
end

在我的deploy.rb

# Set up a strategy to deploy only a project directory (not the whole repo)
set :git_strategy, RemoteCacheWithProjectRootStrategy
set :project_root, 'relative/path/from/your/repo'

所有重要的代码都在策略release方法中,该方法使用git archive仅存档repo的子目录,然后使用--strip参数tar来在适当的级别提取档案。

<强>更新

从Capistrano 3.3.3开始,您现在可以使用:repo_tree配置变量,这使得此答案已过时。例如:

set :repo_url, 'https://example.com/your_repo.git'
set :repo_tree, 'relative/path/from/your/repo' # relative path to project root in repo

请参阅http://capistranorb.com/documentation/getting-started/configuration

答案 2 :(得分:10)

我们也是通过克隆整个存储库,删除未使用的文件和文件夹并在层次结构中向上移动所需的文件夹来与Capistrano一起做的。

deploy.rb

set :repository,  "git@github.com:name/project.git"
set :branch, "master"
set :subdir, "server"

after "deploy:update_code", "deploy:checkout_subdir"

namespace :deploy do

    desc "Checkout subdirectory and delete all the other stuff"
    task :checkout_subdir do
        run "mv #{current_release}/#{subdir}/ /tmp && rm -rf #{current_release}/* && mv /tmp/#{subdir}/* #{current_release}"
    end

end

只要项目不会太大,这对我们来说非常有用,但如果可以的话,为每个组件创建一个自己的存储库,并将它们与git子模块组合在一起。

答案 3 :(得分:3)

您可以拥有两个git存储库(客户端和服务器)并将它们添加到“超级项目”(app)中。在这个“超级项目”中,您可以将两个存储库添加为子模块(选中this tutorial)。

另一种可能的解决方案(更脏一点)是为客户端和服务器分别设置分支,然后您可以从“服务器”分支中提取。

答案 4 :(得分:2)

有一个解决方案。从github获取crdlo的patch for capistranocapistrano source。删除现有的capistrano gem,应用补丁,setup.rb install,然后您可以使用他非常简单的配置行set :project, "mysubdirectory"来设置子目录。

唯一的问题是,显然github并不“支持归档命令”......至少在他写这篇文章时。我正在使用我自己的私人git repo而不是svn并且它工作正常,我没有尝试过使用github,但我想如果有足够的人抱怨他们会添加该功能。

另请参阅是否可以让capistrano作者将此功能添加到上限at the relevant bug

答案 5 :(得分:2)

对于Capistrano 3,基于@Thomas Fankhauser回答:

set :repository,  "git@github.com:name/project.git"
set :branch, "master"
set :subdir, "relative_path_to_my/subdir"


namespace :deploy do

  desc "Checkout subdirectory and delete all the other stuff"
  task :checkout_subdir do

    subdir = fetch(:subdir)
    subdir_last_folder  = File.basename(subdir)
    release_subdir_path = File.join(release_path, subdir)

    tmp_base_folder = File.join("/tmp", "capistrano_subdir_hack")
    tmp_destination = File.join(tmp_base_folder, subdir_last_folder)

    cmd = []
    # Settings for my-zsh
    # cmd << "unsetopt nomatch && setopt rmstarsilent" 
    # create temporary folder
    cmd << "mkdir -p #{tmp_base_folder}"  
    # delete previous temporary files                
    cmd << "rm -rf #{tmp_base_folder}/*"  
    # move subdir contents to tmp           
    cmd << "mv #{release_subdir_path}/ #{tmp_destination}"   
    # delete contents inside release      
    cmd << "rm -rf #{release_path}/*"   
    # move subdir contents to release             
    cmd << "mv #{tmp_destination}/* #{release_path}" 
    cmd = cmd.join(" && ")

    on roles(:app) do
      within release_path do
        execute cmd
      end
    end
  end

end

after "deploy:updating", "deploy:checkout_subdir"

答案 6 :(得分:1)

不幸的是,git无法做到这一点。相反,'git way'是拥有两个存储库 - 客户端和服务器,并克隆你需要的存储库。

答案 7 :(得分:1)

我根据之前的答案和github中的其他信息创建了一个与Capistrano 3.x一起使用的剪辑:

# Usage: 
# 1. Drop this file into lib/capistrano/remote_cache_with_project_root_strategy.rb
# 2. Add the following to your Capfile:
#   require 'capistrano/git'
#   require './lib/capistrano/remote_cache_with_project_root_strategy'
# 3. Add the following to your config/deploy.rb
#    set :git_strategy, RemoteCacheWithProjectRootStrategy
#    set :project_root, 'subdir/path'

# Define a new SCM strategy, so we can deploy only a subdirectory of our repo.
module RemoteCacheWithProjectRootStrategy
  include Capistrano::Git::DefaultStrategy
  def test
    test! " [ -f #{repo_path}/HEAD ] "
  end

  def check
    test! :git, :'ls-remote -h', repo_url
  end

  def clone
    git :clone, '--mirror', repo_url, repo_path
  end

  def update
    git :remote, :update
  end

  def release
    git :archive, fetch(:branch), fetch(:project_root), '| tar -x -C', release_path, "--strip=#{fetch(:project_root).count('/')+1}"
  end
end

还可以作为Github上的要点。

答案 8 :(得分:0)

看起来它也没有与codebasehq.com合作所以我最终制作了清除乱七八糟的capistrano任务:-)也许通过覆盖一些capistrano任务实际上有一种不太常见的方式...

答案 9 :(得分:0)

这对我来说已经有几个小时了。

# Capistrano assumes that the repository root is Rails.root
namespace :uploads do
  # We have the Rails application in a subdirectory rails_app
  # Capistrano doesn't provide an elegant way to deal with that
  # for the git case. (For subversion it is straightforward.)
  task :mv_rails_app_dir, :roles => :app do
    run "mv #{release_path}/rails_app/* #{release_path}/ "
  end
end

before 'deploy:finalize_update', 'uploads:mv_rails_app_dir'

您可以为目录声明一个变量(此处为rails_app)。

让我们看看它有多强大。使用“之前”非常弱。

答案 10 :(得分:0)

不知道是否有人对此感兴趣。但是如果有人正在寻找答案,就让你们。 现在我们可以使用::repo_tree

https://capistranorb.com/documentation/getting-started/configuration/