capistrano-gity 0.5.1 → 1.0.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    N2I2ZTA0OTg3NWRiYzMxYjNhYmE2ZTRhNDhmODhiMzY5YTFlYjg1Zg==
+    YWZhZWNlMDNjMjhhODJjZjZiNGIzN2Q1OGM3MWIzNzAyMzUyY2Y2ZQ==
   data.tar.gz: !binary |-
-    ZmJmN2I0YjVkYTcyNGYyNjY5NTEzN2RlZGI2MDlhNmZlMzBlYzk5Yg==
+    YTVmNTExMDEyYTllMDcxNDg1MDVkZWZkOTI5OWU3MDcxY2EyYzNmYg==
 SHA512:
   metadata.gz: !binary |-
-    ZDczNDYxY2UzNGUwNzhmZTRmMGIxYjJhZDUzYTY5OTI1NjhkZmIxMWQxMTU0
-    NGEwM2UzYjBiZTA3Zjc5NGUyZDkyOTcyMDMxNGI4MGY3MTNmMTVhMWQxMzRh
-    MWU5YmE4OWQxNmExNzQ0MjMzZjA5OGYxY2Q0MzQwNDBmZTQzNjQ=
+    YjFkOWZkNmFjYjUzNmQxOWU2ZGU2ODQwMDA0NzY4MzgxN2VkMTU5ZTFmMWNk
+    Mzc2OWY3ZmZkNTJiZjBjY2M4OGMzYTQ0ODY5ZjIzOTE5NDgyM2E0MDI4OTZl
+    Njg4MzgwODcwYjQwYmVkM2Q3NjhjNTE0Y2ZiZDJkMThjMjJhMWU=
   data.tar.gz: !binary |-
-    MmExZTA1NWY1ZTgwOTZkY2Q2NThhNGNiNWZiN2I2OGZhZGZiYTQwZDBmOWRi
-    YmQ2Y2UwYWE2M2Q1MjIzNDM5N2VlZDUxYTU4MzZmYWY3YmI1Nzg2NmY5YTE0
-    Y2I3ZDZmZmQ2MjZmY2I3N2U3MDgzYWFlZGE3ZjViZmU2MThkOWM=
+    Mzg5MmM2OTM1MWVkOWYwYTU2NGE3ZjgwYjYzYTYxYzE2MGYxZjc0MzI0ZDAz
+    ZTJjMTNhZTU5N2FhMjNiZjMyY2Y4YmZiMjRmMzdiYjU2ZmQ3MjE4ZGM2NjBi
+    NTAyZWI1ZjMzODE3NDU5OWNmNjlhMTU5Yjk2MzU3MWZjZDM1ZDc=

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/README.md

@@ -0,0 +1,52 @@
+# Capistrano::Gity
+
+Git deployment helpers for Capistrano v3.
+
+#Installation
+
+Add this in your Gemfile:
+
+```ruby
+gem 'capistrano', '~> 3.1'
+gem 'capistrano-gity', '~> 0.6.0'
+```
+
+# Usage
+
+Require in `Capfile` to use gity as a wrapper of capistrano:deploy task:
+
+```ruby
+require 'capistrano/gity'
+```
+
+The task `gity:prepare_deploy` runs before `deploy:starting` and creates a remote temp branch under `remote/deploy/`.
+
+Use the following to delete the temporary branch after successfull deployment,
+i.e. after `deploy:finished`:
+
+```ruby
+set :auto_cleanup, true
+```
+
+You can also change the default temporary branch prefix, i.e. `deploy/` with:
+
+```ruby
+set :branch_prefix, 'deploy/production/'
+```
+
+# Useful tasks
+
+```sh
+bundle exec cap production gity:help
+bundle exec cap production gity:check
+bundle exec cap production gity:uptip
+bundle exec cap production gity:cleanup_temp_branches
+```
+
+Check the module for details :)
+
+## Contributing
+
+1. Fork the project
+2. Make your feature addition or bug fix
+3. Create new Pull Request

data/capistrano-gity.gemspec

@@ -1,35 +1,20 @@
 # -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |s|
-  s.name = "capistrano-gity"
-  s.version = "0.5.1"
+  s.name             = 'capistrano-gity'
+  s.version          = '1.0.0'
+  s.authors          = ['Skroutz.gr Team']
+  s.date             = '2012-05-21'
+  s.email            = 'yatiohi@ideopolis.gr'
+  s.extra_rdoc_files = ['LICENSE', 'README.md']
+  s.files            = `git ls-files`.split($/)
+  s.homepage         = 'http://github.com/ctrochalakis/capistrano-gity'
+  s.require_paths    = ['lib']
+  s.rubygems_version = '1.8.11'
+  s.summary          = 'Git helpers for Capistrano v3 deployments'
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Skroutz.gr Team"]
-  s.date = "2012-05-21"
-  s.email = "yatiohi@ideopolis.gr"
-  s.extra_rdoc_files = [
-    "LICENSE",
-    "README.rdoc"
-  ]
-  s.files = [
-    "LICENSE",
-    "README.rdoc",
-    "capistrano-gity.gemspec",
-    "lib/capistrano-gity.rb"
-  ]
-  s.homepage = "http://github.com/ctrochalakis/capistrano-gity"
-  s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.11"
-  s.summary = "Git helpers for capistrano deployments"
-
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-    else
-    end
-  else
-  end
+  s.add_dependency 'capistrano', '~> 3.1'
+  s.add_dependency 'sshkit', '~> 1.2'
 end
-

data/lib/capistrano/gity.rb

@@ -0,0 +1 @@
+load File.expand_path('../tasks/gity.cap', __FILE__)

data/lib/capistrano/tasks/gity.cap

@@ -0,0 +1,161 @@
+namespace :gity do
+  desc 'Show revision and upstream '
+  task :check do
+    invoke 'gity:uprev'
+    invoke 'gity:uptip'
+  end
+
+  desc 'Delete temp branch if auto_cleanup is set to true'
+  task :cleanup_deploy do
+    if fetch(:auto_cleanup)
+      run_locally do
+        system "git push #{fetch(:remote)} --delete --quiet #{fetch(:branch)}"
+      end
+    end
+  end
+
+  desc 'Delete all remote temporary branches, i.e. under deploy/'
+  task :cleanup_temp_branches do
+    run_locally do
+      system "git ls-remote --heads #{fetch(:remote)} '#{fetch(:branch_prefix)}*' | awk '{print $2}' | xargs git push #{fetch(:remote)} --quiet --delete"
+    end
+  end
+
+  desc 'Create temporary branch on remote'
+  task :create_temp_branch do
+    run_locally do
+      system "git push --force --quiet #{fetch(:remote)} HEAD:#{fetch(:branch)}"
+    end
+  end
+
+  desc 'A small overview of the deployment procedure'
+  task :help do
+    puts <<-HELP
+
+      Overview:
+        * Deploying the #{fetch(:branch)} branch of #{fetch(:repo_url)}
+        * The #{fetch(:branch)} branch can be moved *anywhere*.
+
+      Quick help:
+        * Checkout the branch you want to mark as #{fetch(:live_branch)}
+          (ex. master) and run:cap deploy
+
+      Under the hood:
+        * git push --force #{fetch(:remote)} HEAD:#{fetch(:branch)} (or cap gity:create_temp_branch)
+        * git push --force #{fetch(:remote)} HEAD:#{fetch(:live_branch)} (or cap gity:push_to_live)
+        * cap deploy
+
+      Troubleshooting:
+        cap gity:uptip # Show the #{fetch(:live_branch)} branch of the central repo
+        cap gity:status # A log-like view showing important commits
+
+        cap gity:check # check consistency between the applied revision and the one on the #{fetch(:live_branch)} branch
+    HELP
+  end
+
+  desc 'Do necessary steps before deployment'
+  task :prepare_deploy do
+    invoke 'gity:sync'
+    exit 127 if quit?
+    invoke 'gity:create_temp_branch'
+  end
+
+  desc 'Push HEAD to the central repo'
+  task :push do
+    run_locally do
+      system "git push --force --quiet #{fetch(:remote)} HEAD:#{fetch(:live_branch)}"
+    end
+  end
+
+  desc 'Push temporary branch to live branch'
+  task :push_to_live do
+    invoke 'gity:push'
+    invoke 'gity:uptip'
+  end
+
+  desc 'View a graph log of the commits usually involved in a deployment'
+  task :status do
+    run_locally do
+      puts "\nOverview (we are deploying origin/#{fetch(:live_branch)})"
+
+      invoke 'gity:sync'
+
+      system "git --no-pager log --decorate --graph --oneline #{fetch(:remote)}/#{fetch(:live_branch)} #{fetch(:remote)}/master --not #{fetch(:remote)}/#{fetch(:live_branch)}^@ --"
+    end
+  end
+
+  desc 'Fetch remote'
+  task :sync do
+    run_locally do
+      system "git fetch #{fetch(:remote)}"
+    end
+  end
+
+  desc 'Diplay current revision'
+  task :uprev do
+    on release_roles(:app) do
+      within "#{current_path}" do
+        execute "cd #{current_path} && cat REVISION"
+      end
+    end
+  end
+
+  desc 'Display where the central live branch is pointing'
+  task :uptip do
+    run_locally do
+      system %(git --no-pager log --decorate -1 --format="#{fetch(:remote)}'s #{fetch(:live_branch)} tip is set to: [%h] %s (%an, %ar)"  #{fetch(:remote)}/#{fetch(:live_branch)})
+    end
+  end
+
+  def quit?
+    return false if !fetch(:check_master)
+
+    upstream_master = `git rev-parse #{fetch(:remote)}/master`
+    commit_id = fetch(:commit_id)
+    if commit_id != upstream_master
+      puts <<-MSG
+        The commit(#{commit_id}) you are pushing is different from #{fetch(:remote)} master.
+        This means that a subsequent deploy might not include your work.
+        Consider pushing to master now or later.
+      MSG
+      set :answer, ask('Do you want to continue? (y/n)', 'n')
+      return !fetch(:answer).downcase.start_with?('y')
+    end
+    return false
+  end
+
+  before 'deploy:starting', 'gity:prepare_deploy'
+  after 'deploy:finished', 'gity:push_to_live'
+  after 'deploy:finished', 'gity:cleanup_deploy'
+end
+
+namespace :load do
+  task :defaults do
+    set :auto_cleanup, false
+    set :branch_prefix, 'deploy/'
+    set :commit_id, -> { `git rev-parse --short HEAD`.chomp }
+    set :branch, -> {
+      "#{fetch(:branch_prefix)}#{Time.now.strftime('%Y%m%d_%H%M%S')}_#{fetch(:commit_id)}"
+    }
+
+    # Most people use origin here
+    unless any?(:remote)
+      git_remote = `git config deploy.remote`.strip
+
+      set :remote, git_remote.empty? ? 'origin' : git_remote
+    end
+
+    unless any?(:check_master)
+      check_master = case `git config deploy.check-master`.strip
+                     when 'false', 'f', '0'
+                       false
+                     when 'true', 't', '1'
+                       true
+                     else
+                       true
+                     end
+
+      set :check_master, check_master
+    end
+  end
+end

data/lib/capistrano-gity.rb

@@ -1,105 +0,0 @@
-Capistrano::Configuration.instance.load do
-  namespace :gity do
-
-    # Most people use origin here
-    unless exists?(:remote)
-      git_remote = `git config deploy.remote`.strip
-      set :remote,  git_remote.empty? ? 'origin' : git_remote
-    end
-
-    unless exists?(:check_master)
-      check_master = case `git config deploy.check-master`.strip
-      when 'false', 'f', '0'
-        false
-      when 'true', 't', '1'
-        true
-      else
-        true
-      end
-
-      set :check_master,  check_master
-    end
-
-    desc "Push HEAD to the central repo"
-    task :push do
-      system "git push --force #{remote} HEAD:#{branch}"
-    end
-
-    task :sync do
-      system "git fetch #{remote}"
-    end
-
-    desc "View a graph log of the commits usually involved in a deployment"
-    task :status do
-      puts "\nOverview (we are deploying origin/#{branch})"
-      sync
-      system "git --no-pager log --decorate --graph --oneline #{remote}/#{branch} #{remote}/master --not #{remote}/#{branch}^@ --"
-    end
-
-    desc "Display where the central live branch is pointing"
-    task :uptip do
-      sync
-      system %(git --no-pager log --decorate -1 --format="#{remote}'s #{branch} tip is set to: [%h] %s (%an, %ar)"  #{remote}/#{branch})
-    end
-
-    desc "A small overview of the deployment procedure"
-    task :help do
-      puts <<-HELP
-
-      Overview:
-      * Deploying the #{branch} branch of #{repository}
-      * The #{branch} branch can be moved *anywhere*.
-
-      Quick help:
-      Go the branch you want to mark as #{branch} (ex. master) and run:
-      cap deploy
-
-      Under the hood:
-        * git push --force #{remote} HEAD:#{branch} (or cap gity:push)
-        * cap deploy
-
-      Troubleshooting:
-      cap gity:uptip # Show the #{branch} branch of the central repo
-      cap gity:status # A log-like view showing important commits
-
-      cap gity:check # check consistency between the applied revision and the one on the #{branch} branch
-      HELP
-    end
-
-    task :uprev do
-      run "cd #{current_path} && cat REVISION"
-    end
-
-    task :check do
-      uprev
-      uptip
-    end
-
-    def quit?
-      return false if !check_master
-
-      upstream_master = `git rev-parse #{remote}/master` 
-      here = `git rev-parse HEAD`
-      if here != upstream_master
-        puts <<-MSG
-        The commit you are pushing is different from #{remote} master.
-        This means that a subsequent deploy might not include your work.
-        Consider pushing to master now or later.
-        MSG
-        answer = Capistrano::CLI.ui.ask("Do you want to continue? (y/n)")
-        return !answer.downcase.start_with?('y')
-      end
-      return false
-    end
-
-    task :prepare_deploy do
-      sync
-      exit 127 if quit?
-      push
-      uptip
-    end
-
-    before 'deploy:update_code', 'gity:prepare_deploy'
-
-  end
-end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-gity
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Skroutz.gr Team
@@ -9,19 +9,50 @@ autorequire:
 bindir: bin
 cert_chain: []
 date: 2012-05-21 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  name: capistrano
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  name: sshkit
+  type: :runtime
 description: 
 email: yatiohi@ideopolis.gr
 executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE
-- README.rdoc
+- README.md
 files:
+- .gitignore
 - LICENSE
-- README.rdoc
+- README.md
 - capistrano-gity.gemspec
 - lib/capistrano-gity.rb
+- lib/capistrano/gity.rb
+- lib/capistrano/tasks/gity.cap
 homepage: http://github.com/ctrochalakis/capistrano-gity
 licenses: []
 metadata: {}
@@ -43,7 +74,7 @@ requirements: []
 rubyforge_project: 
 rubygems_version: 2.1.11
 signing_key: 
-specification_version: 3
-summary: Git helpers for capistrano deployments
+specification_version: 4
+summary: Git helpers for Capistrano v3 deployments
 test_files: []
 has_rdoc: 

data/README.rdoc

@@ -1,9 +0,0 @@
-= capistrano-gity
-
-Git deployment helpers for capistrano. Check the module for details :)
-
-== Note on Patches/Pull Requests
- 
-* Fork the project.
-* Make your feature addition or bug fix.
-* Send a pull request.