Использование capistrano для развертывания из разных веток git

Я использую capistrano для развертывания приложения RoR. Кодовая база находится в репозитории git, и при разработке широко используется ветвление. Capistrano использует deploy.rbфайл для своих настроек, одна из которых является веткой для развертывания.

Моя проблема заключается в следующем: скажем, я создаю новую ветку A от мастера . Файл развертывания будет ссылаться на главную ветку. Я редактирую это, чтобы можно было развернуть A в тестовой среде. Я заканчиваю работу над функцией и объединяю ветку A в master . Так как deploy.rbфайл с A свежа, он получает объединен в и теперь deploy.rbв мастер ссылки ветви А . Время снова редактировать.

Это много, казалось бы, ненужного ручного редактирования - параметр всегда должен соответствовать имени текущей ветки. Вдобавок ко всему, легко забыть редактировать настройки каждый раз.

Как лучше всего автоматизировать этот процесс?

Изменить: оказывается, кто-то уже сделал именно то, что мне нужно :

Этим утром у меня была возможность развернуть ветку репозитория git на промежуточном сервере, но я не имел ни малейшего представления, как это сделать. Быстрый поиск в исходном коде capistrano показал, что я могу использовать set :branch "branch_name"в моем сценарии развертывания. Я попробовал, и это сработало. Затем я решил, что мне нужно будет внести аналогичные изменения во все мои ветки. Конечно, я ленивый дурачок и задавался вопросом, нет ли лучшего способа.

Если вы не знакомы с git, вывод команды git branch представляет собой список ветвей, отмеченных звездочкой, которая в настоящее время проверена на вашем локальном компьютере. Например:

> git branch
* drupal_authentication
fragment_caching
master

Итак, я подумал, что, если бы я просто проанализировал вывод и поискал ветку, помеченную как текущую:

set :branch, $1 if `git branch` =~ /\* (\S+)\s/m

Теперь я могу развернуть любую ветку, текущую на моем локальном компьютере, с помощью одного общего сценария развертывания.

Это работает с Capistrano> = 3.1:

добавьте эту строку в config/deploy.rb:

set :branch, ENV['BRANCH'] if ENV['BRANCH']

а затем вызовите capistrano с помощью:

cap production deploy BRANCH=master

Это решение работает с Capistrano <3.1:

# call with cap -s env="<env>" branch="<branchname>" deploy

set :branch, fetch(:branch, "master")
set :env, fetch(:env, "production")

Используя Capistrano 3.1.0+, ни один из них больше не работал у меня. Вместо этого, согласно их прокомментированным инструкциям:

   ask :branch, proc { `git rev-parse --abbrev-ref HEAD`.chomp }

Но вы не хотите использовать, askиначе он вам подскажет. Вместо этого вы должны использовать set. HEADсамая верхняя ветвь; «край», как это называется. Если вы хотите другую ветку, замените HEADс именем ветви, например: master, stagingи т.д.

В заключение с примерами в /config/deploy/production.rb, вы можете включить эту строку:

   set :branch, proc { `git rev-parse --abbrev-ref master`.chomp }

...или

   set :branch, proc { `git rev-parse --abbrev-ref HEAD`.chomp }

btw, HEADэто настройка по умолчанию, поэтому нет необходимости указывать это в файле. Может быть лучше использовать в /config/deploy/edge.rb.

В /config/deploy/staging.rb, вы можете включить эту строку:

   set :branch, proc { `git rev-parse --abbrev-ref staging`.chomp }

...или

   set :branch, proc { `git rev-parse --abbrev-ref test`.chomp }

Вы уловили идею!

Надеюсь, эти примеры помогут будущим пользователям capistrano (^_^)

С многоступенчатостью это на самом деле:

cap production deploy -s branch=my-branch

Синтаксис предыдущего сообщения не работает в моей среде

Я могу подтвердить, что нижеприведенное все еще работает в Cap 3.11.0 13/10/18, а также в Cap 2:

В deploy.rb / stage.rb:

set :branch, ENV['BRANCH'] || 'develop'

В командной строке:

cap deploy BRANCH=featurex

Это дает вам ветку по умолчанию (которая может быть разной для разных сред) и возможность изменять ветки, когда вы хотите.

В качестве альтернативы вы можете структурировать его из командной строки, где у вас есть ветка и среда по умолчанию, а также вы можете передавать параметры в вызов cap, которые могут включать среду и ветвь для использования. Это может быть явно переданная ветка, или у вас может быть параметр, который будет указывать текущую ветвь, как описано в указанной вами ссылке.

#call with cap -S env="<env>" branch="<branchname>" deploy
...

# Prevents error if not parameter passed, assumes that default 'cap deploy' command
# and should deploy the master branch to the production server
set(:env, ‘production’) unless exists?(:env)
set(:branch, ‘master’) unless exists?(:branch)

if !env.nil? && env == "production"
   role :web, "production_ip_address"
else   # add more as needed 
   role :web, "development_ip_address"
end

if !branch.nil? && branch == "current"
   set :branch, $1 if `git branch` =~ /\* (\S+)\s/m
elsif !branch.nil?
   set :branch, branch
else   # add more as needed 
   set :branch, "master"
end
...

Пример кода, сильно заимствованный отсюда

Если вы используете капистрано-многоступенчатый , вам нужно только запустить

cap -s branch=$MY_BRANCH deploy

или

cap -s branch=$MY_BRANCH production deploy

без дальнейшего редактирования вашего deploy.rb.

Эта команда больше не будет работать:

cap deploy -s branch=your_branch

Поддержка -sSфлагов была удалена в capistrano v3 +.
Здесь вы можете прочитать об этом подробнее: ссылка
Это было упомянуто в нескольких ответах, но в настоящее время неверно.

Что у меня работает:
в deploy.rbфайл добавить

set :branch, ENV['BRANCH'] || :master

затем запустите:

BRANCH=your_branch cap deploy

Также обратите внимание, что для успешного выполнения этой команды вам необходимо находиться в главной ветке.

Это решение должно работать со всеми версиями Capistrano.

def branch_name(default_branch)
  branch = ENV.fetch('BRANCH', default_branch)

  if branch == '.'
    # current branch
    `git rev-parse --abbrev-ref HEAD`.chomp
  else
    branch
  end
end

set :branch, branch_name('master')

Использование:

BRANCH=. cap [staging] deploy
# => deploy current branch

BRANCH=master cap [staging] deploy
# => deploy master branch

cap [staging] deploy
# => deploy default branch

Я использую версию 3.3.5, и у меня это работает:

set :branch, 'develop'

Общий ответ:

Если у вас есть файл настроек, содержимое которого изменяется от среды к среде, вы должны сделать эту строку «шаблоном» (со строкой, представляющей имя переменной, например @BRANCH_NAME@или@ENV_NAME@ ).

Тогда у вас будет (версионный) скрипт, способный читать ваш файл конфигурации и заменять @BRANCH_NAME@переменную " " на соответствующее значение, необходимое для вашего процесса развертывания.

Для пользователей capistrano 3:

desc "prompt for branch or tag"
task :git_branch_or_tag do
  on roles(:all) do |host|
    run_locally do
      execute :git, 'tag'
      tag_prompt = "Enter a branch or tag name to deploy"
      ask(:branch_or_tag, tag_prompt)
      tag_branch_target = fetch(:branch_or_tag, 'master')
      set(:branch, tag_branch_target)
    end
  end
end

before 'deploy:updated',  :git_branch_or_tag

Метод 1. Установите конкретную ветвь этапа (например, тестовую, производственную) для развертывания

Поместите branchконфигурацию в файлы этапа вместо deploy.rb и установите целевую ветвь для этого этапа, из которого будет выполняться развертывание.

Для двухэтапного приложения со связанным именем ветки testи productionконфигурация будет выглядеть следующим образом:

# app_root/config/deploy/test.rb
...
set :branch, "test"
...

# app_root/config/deploy/production.rb
...
set :branch, "production"
...

Этот метод позволяет выполнять развертывание из отдельных веток этапа. Таким образом, потребуется лишь дополнительный шаг - объединить или переустановить последний код из базовой ветки.

Метод 2: развертывание напрямую из любой ветки (с помощью тега)

Другой подход - развертывание с использованием тега. Чтобы развернуть с помощью тега, установите branchconfig. в deploy.rb следующим образом,

set :branch, `git describe --tags $(git rev-list --tags --max-count=1)`.chomp

И настройте CI для условного развертывания на разных этапах, если соответствующий шаблон тега совпадает (например /.*-test$/).

Теперь развертывание можно производить из любой ветки,

• Сначала создайте тег из любой ветки,

  git tag -a v0.1.0-test -m "Версия 0.1.0-test"

• И нажмите

  git push origin v0.1.0-тест

Примечание: описанные выше методы основаны на Capistrano 3.

git rev-parse --abbrev-ref HEAD

вернет текущую ветку, в которой вы находитесь.

Я всегда ставил gpshвместоgit push -u origin branch_name

$ which gpsh
gpsh: aliased to git push -u origin `git rev-parse --abbrev-ref HEAD`