cap-git-deploy 0.0.2 → 0.0.3

data/README.md

@@ -1,2 +1,64 @@
-capistrano-git-deploy
-=====================
+# Installation
+
+```bash
+    gem install cap-git-deploy
+```
+
+or inside your Gemfile:
+
+```ruby
+    group :development do
+      gem 'cap-git-deploy'
+    end
+```
+
+# How to use
+
+cap-git-deploy disables the use of the symlinks for version control in favor of a tag-style mechanism with git: every deploy is marked with a git tag. A rollback is a checkout to a tag.
+
+The following is a sample recipe that uses git-deploy as deployment procedure:
+
+```ruby
+    require 'cap-git-deploy'
+
+    set :repository, 'git@my-host.com:my-app.git'
+    set :deploy_to, '/var/apps/my-app'
+    role :app, 'my-host.com'
+    role :web, 'my-host.com'
+    role :db, 'my-host.com'
+```
+
+In addition, cap-git-deploy stores some deploy info inside a revision file (called REVISION by default) on the remote host.
+After each deploy the commit sha, the branch name, the user name and the current date are stored inside this file.
+To show the deploy infos you can launch the revision:get task:
+
+```bash
+    cap revision:get
+```
+
+## Note: Current Branch
+
+By default, your current branch will be deployed.
+However, when working with staging environments, usually you want to deploy a particular branch unless specified. In this case insert the following in your deploy.rb file:
+
+```ruby
+    set :branch, ENV['branch'] || 'master'
+```
+
+In this way, 'cap deploy' will deploy the 'master' branch, instead 'cap deploy branch=foo' will deploy the branch 'foo'.
+
+For production environments **you should** use something like the following code:
+
+```ruby
+    set :branch, 'master'
+```
+
+## Note: Setup
+
+To setup your environment, when your recipes are ready, type the following command from your rails app:
+
+```bash
+    cap deploy:setup
+```
+
+This will setup your git repository on the remote host.

data/lib/cap-git-deploy.rb

@@ -9,6 +9,7 @@ module Cap
     module Deploy
       # utility functions
 
+      # The name of the branch we are deploying
       def self.current_branch
         repo = Grit::Repo.new '.'
         branch = repo.head
@@ -16,6 +17,7 @@ module Cap
         branch && branch.name || 'master'
       end
 
+      # The name of the current logged user
       def self.current_user
         "#{Etc.getlogin}@#{Socket.gethostname}"
       end

data/lib/cap-git-deploy/version.rb

@@ -1,7 +1,7 @@
 module Cap
   module Git
     module Deploy
-      VERSION = "0.0.2"
+      VERSION = "0.0.3"
     end
   end
 end

data/lib/recipes/fast-git-deploy.rb

@@ -1,15 +1,13 @@
 set :rolling_back, false
 set :scm, :git
 set :logged_user, Cap::Git::Deploy.current_user
-set :branch, ENV['branch'] || Cap::Git::Deploy.current_branch unless exists? :branch
+unless exists? :branch
+  set :branch, ENV['branch'] || Cap::Git::Deploy.current_branch
+end
+set(:latest_release) { fetch :current_path }
+set(:current_release) { fetch :current_path }
 
 namespace :deploy do
-  task :default do
-    update
-    update_revision
-    restart
-  end
-
   desc "Setup a GitHub-style deployment"
   task :setup, :except => { :no_release => true } do
     dirs = [deploy_to, shared_path]
@@ -22,17 +20,11 @@ namespace :deploy do
     # This is where the log files will go
     run "mkdir -p #{current_path}/log" rescue 'no problem if log already exist'
 
-    # This is to make sure we are on the correct branch
-    run "cd #{current_path}; git checkout -b #{branch} --track origin/#{branch}" if branch != 'master'
-  end
-
-  desc "Update the deployed code"
-  task :update_code, :except => { :no_release => true } do
-    # If we are rolling back branch is a commit
-    branch_name = rolling_back && branch || "origin/#{branch}"
-
-    run "cd #{current_path} && git fetch" unless rolling_back
-    run "cd #{current_path} && git reset --hard #{branch_name}"
+    branch = fetch :branch, 'master'
+    if branch != 'master'
+      # This is to make sure we are on the correct branch
+      run "cd #{current_path} && git checkout -b #{branch} --track origin/#{branch}"
+    end
   end
 
   namespace :rollback do
@@ -53,63 +45,33 @@ namespace :deploy do
     end
   end
 
-  task :create_symlink, :except => { :no_release => true } do
-    # This empty task is needed to override the default :create_symlink task
-  end
-
-  task :create_symlink, :except => { :no_release => true } do
-    # This empty task is needed to override the default :symlink task
-  end
-
-  task :migrate, :roles => :db, :only => { :primary => true } do
-    rake = fetch :rake, "rake"
-    bundler = fetch :bundler, "bundler"
-    rails_env = fetch :rails_env, "production"
-    migrate_env = fetch :migrate_env, ""
-
-    run "cd #{current_path}; RAILS_ENV=#{rails_env} #{bundler} exec #{rake} db:migrate #{migrate_env}"
-  end
-
-  desc "Create a REVISION file containing the SHA of the deployed commit"
-  task :update_revision, :except => { :no_release => true } do
-    # If for some reason we cannot find the commit sha, then we'll use the branch name
-    sha = "origin/#{branch}"
-    run "cd #{current_path}; git rev-parse origin/#{branch}" do |channel, stream, data|
-      sha = data.strip
+  task :update, :except => { :no_release => true } do
+    transaction do
+      update_code
+      insert_tag
     end
-
-    commands = []
-    commands << "cd #{current_path}"
-    commands << "echo '#{sha}' > REVISION"
-    commands << "echo '#{branch}' >> REVISION"
-    commands << "echo '#{logged_user}' >> REVISION"
-    commands << "echo '#{Time.now}' >> REVISION"
-    run commands.join ' && '
   end
 
-  task :start do ; end
-  task :stop do ; end
-  task :restart, :roles => :app, :except => { :no_release => true } do
-    # Restart in Passenger way
-    run "touch #{File.join(current_path,'tmp','restart.txt')}"
-  end
+  desc "Update the deployed code"
+  task :update_code, :except => { :no_release => true } do
+    # If we are rolling back branch, then this is a commit
+    if rolling_back
+      branch_name = branch
+    else
+      branch_name = "origin/#{fetch :branch, 'master'}"
+    end
 
-  desc "Runs bundle for production environments"
-  task :bundle do
-    bundler = fetch :bundler, "bundler"
-    run "cd #{current_path}; #{bundler} install --deployment --without mac development test"
+    run "cd #{current_path} && git fetch" unless rolling_back
+    run "cd #{current_path} && git reset --hard #{branch_name}"
   end
-end
 
-desc "Get info about last deploy"
-task :get_revision do
-  keys = %w(SHA Branch Author Date).reverse
-  run "cat #{current_path}/REVISION" do |c, s, data|
-    data.strip.lines.each do |line|
-      puts "#{keys.pop}: #{line.strip}" if keys.any?
-    end
+  task :insert_tag, :except => { :no_release => true } do
+    timestamp = Time.now.strftime '%Y%m%d%H%M%S'
+    run "cd #{current_path}; git tag deploy_#{timestamp}" unless rolling_back
   end
 end
 
-after "deploy:restart", "deploy:migrate"
-after "deploy:update_code", "deploy:bundle"
+# launch bundle:install after update task if it's detected
+# because it will not run with his standard behavior (before deploy:finalize_update)
+# as we are using this custom git-style deployment procedure
+after 'deploy:update', 'bundle:install' if find_task 'bundle:install'

data/lib/recipes/git-revisioning.rb

@@ -0,0 +1,32 @@
+set :revision_file, 'REVISION'
+
+namespace :revision do
+  desc "Create a REVISION file containing the SHA of the deployed commit"
+  task :set, :except => { :no_release => true } do
+    # If for some reason we cannot find the commit sha, then we'll use the branch name
+    sha = "origin/#{branch}"
+    run "cd #{current_path}; git rev-parse origin/#{branch}" do |channel, stream, data|
+      sha = data.strip
+    end
+
+    commands = []
+    commands << "cd #{current_path}"
+    commands << "echo '#{sha}' > #{revision_file}"
+    commands << "echo '#{branch}' >> #{revision_file}"
+    commands << "echo '#{logged_user}' >> #{revision_file}"
+    commands << "echo '#{Time.now}' >> #{revision_file}"
+    run commands.join ' && '
+  end
+
+  desc "Get info about last deploy"
+  task :get do
+    keys = %w(SHA Branch Author Date).reverse
+    run "cat #{current_path}/#{revision_file}" do |c, s, data|
+      data.strip.lines.each do |line|
+        puts "#{keys.pop}: #{line.strip}" if keys.any?
+      end
+    end
+  end
+end
+
+after 'deploy:update_code', 'revision:set'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cap-git-deploy
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-29 00:00:00.000000000Z
+date: 2012-05-31 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
-  requirement: &70255335369120 !ruby/object:Gem::Requirement
+  requirement: &70216834563020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70255335369120
+  version_requirements: *70216834563020
 - !ruby/object:Gem::Dependency
   name: grit
-  requirement: &70255335368700 !ruby/object:Gem::Requirement
+  requirement: &70216834562600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70255335368700
+  version_requirements: *70216834562600
 description: Mikamai-style deploy strategy
 email:
 - projects@mikamai.com
@@ -47,6 +47,7 @@ files:
 - lib/cap-git-deploy.rb
 - lib/cap-git-deploy/version.rb
 - lib/recipes/fast-git-deploy.rb
+- lib/recipes/git-revisioning.rb
 homepage: http://www.mikamai.com
 licenses: []
 post_install_message: