capistrano-gitflow 1.3.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/README.rdoc

@@ -0,0 +1,75 @@
+= gitflow: a Capistrano recipe for git deployment using tags in a multistage environment.
+
+The best thing about this recipe is that there is almost nothing to learn -- your cap deploy process barely changes.
+Gitflow simply adds some tagging/logging/workflow magic.
+
+    # BEFORE
+    $ cap deploy              # 'master' goes to staging
+    $ cap production deploy   # 'master' goes to production
+
+    # AFTER
+    $ cap deploy                                                          
+    # 'master' goes to staging; tag staging-YYYY-MM-DD.X created
+    $ cap production deploy -s tag=staging-YYYY-MM-DD-X-user-description
+    # tag 'staging-YYYY-MM-DD-X' goes to production
+    # tag 'production-YYYY-MM-DD-X' created; points to staging-YYYY-MM-DD-X
+
+    # BONUS
+    cap gitflow:commit_log              
+    # displays a commit log pushed to staging
+    # ... alternatively, if you're using GitHub, will open a page using branch compare
+    cap production gitflow:log_log   
+    # displays a commit log of what will be pushed to production
+
+== INSTALLATION
+
+First, install the gem:
+
+    gem install capistrano-gitflow
+
+Then update config/deploy.rb
+
+    require 'capistrano/ext/multistage'
+    require 'capistrano/gitflow' # needs to come after multistage
+
+== DETAILS
+
+After experimenting with several workflows for deployment in git, I've finally found one I really like.
+
+* You can push to staging at any time; every staging push is automatically tagged with a unique tag.
+* You can only push a staging tag to production. This helps to enforce QA of all pushes to production.
+
+=== PUSH TO STAGING
+
+Whenever you want to push the currently checked-out code to staging, just do:
+
+    cap staging deploy
+
+gitflow will automatically:
+
+* create a unique tag in the format of 'staging-YYYY-MM-DD.X'
+* configure multistage to use that tag for the deploy
+* push the code and tags to the remote "origin"
+* and run the normal deploy task for the staging stage.
+
+=== PUSH TO PRODUCTION:
+
+Whenever you want to push code to production, you must specify the staging tag you wish to promote to production:
+
+    cap production deploy -s tag=staging-2009-09-08.2
+
+gitflow will automatically:
+
+* alias the staging tag to a production tag like: production-2008-09-08.2
+* configure multistage to use that tag for the deploy
+* push the code and tags to the remote "origin"
+* and run the normal deploy task for the production stage.
+
+=== NOTES:
+
+* you may need to wipe out the cached-copy on the remote server that cap uses when switching to this workflow; I have seen situations where the cached copy cannot cleanly checkout to the new branch/tag. it's safe to try without wiping it out first, it will fail gracefully.
+* if your stages already have a "set :branch, 'my-staging-branch'" call in your configs, remove it. This workflow configures it automatically.
+
+== CREDIT
+
+Originally forked from Alan Pinstein's git_deployment repo. Gemified and hacked by Josh Nichols. There wasn't really a license originally, so...

data/Rakefile

@@ -0,0 +1,47 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "capistrano-gitflow"
+    gem.summary = %Q{Capistrano recipe for a deployment workflow based on git tags }
+    gem.description = %Q{Capistrano recipe for a deployment workflow based on git tags}
+    gem.email = "josh@technicalpickles.com"
+    gem.homepage = "http://github.com/technicalpickles/gitflow"
+    gem.authors = ["Joshua Nichols"]
+    gem.add_dependency "capistrano"
+    gem.add_dependency "stringex"
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "gitflow #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.3.0

data/capistrano-gitflow.gemspec

@@ -0,0 +1,61 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{capistrano-gitflow}
+  s.version = "1.3.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Joshua Nichols"]
+  s.date = %q{2010-06-15}
+  s.description = %q{Capistrano recipe for a deployment workflow based on git tags}
+  s.email = %q{josh@technicalpickles.com}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "capistrano-gitflow.gemspec",
+     "gitflow.gemspec",
+     "lib/capistrano/gitflow.rb",
+     "lib/capistrano/gitflow/natcmp.rb",
+     "recipes/gitflow_recipes.rb",
+     "spec/gitflow_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/technicalpickles/gitflow}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Capistrano recipe for a deployment workflow based on git tags}
+  s.test_files = [
+    "spec/gitflow_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<capistrano>, [">= 0"])
+      s.add_runtime_dependency(%q<stringex>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<capistrano>, [">= 0"])
+      s.add_dependency(%q<stringex>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<capistrano>, [">= 0"])
+    s.add_dependency(%q<stringex>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

data/gitflow.gemspec

@@ -0,0 +1,60 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{gitflow}
+  s.version = "1.3.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Joshua Nichols"]
+  s.date = %q{2010-06-15}
+  s.description = %q{Capistrano recipe for a deployment workflow based on git tags}
+  s.email = %q{josh@technicalpickles.com}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "gitflow.gemspec",
+     "lib/capistrano/gitflow.rb",
+     "lib/capistrano/gitflow/natcmp.rb",
+     "recipes/gitflow_recipes.rb",
+     "spec/gitflow_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/technicalpickles/gitflow}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Capistrano recipe for a deployment workflow based on git tags}
+  s.test_files = [
+    "spec/gitflow_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<capistrano>, [">= 0"])
+      s.add_runtime_dependency(%q<stringex>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<capistrano>, [">= 0"])
+      s.add_dependency(%q<stringex>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<capistrano>, [">= 0"])
+    s.add_dependency(%q<stringex>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

data/lib/capistrano/gitflow.rb

@@ -0,0 +1,172 @@
+require 'capistrano'
+require 'capistrano/gitflow/natcmp'
+require 'stringex'
+
+module Capistrano
+  class Gitflow
+    def self.load_into(capistrano_configuration)
+      capistrano_configuration.load do
+        before "deploy:update_code", "gitflow:calculate_tag"
+        before "gitflow:calculate_tag", "gitflow:verify_up_to_date"
+
+        namespace :gitflow do
+          def last_tag_matching(pattern)
+            matching_tags = `git tag -l '#{pattern}'`.split
+            matching_tags.sort! do |a,b|
+              String.natcmp(b, a, true)
+            end
+
+            last_tag = if matching_tags.length > 0
+                         matching_tags[0]
+                       else
+                         nil
+                       end
+          end
+
+          def last_staging_tag()
+            last_tag_matching('staging-*')
+          end
+
+          def last_production_tag()
+            last_tag_matching('production-*')
+          end
+
+          task :verify_up_to_date do
+            set :local_branch, `git branch --no-color 2> /dev/null | sed -e '/^[^*]/d'`.gsub(/\* /, '').chomp
+            set :local_sha, `git log --pretty=format:%H HEAD -1`.chomp
+            set :origin_sha, `git log --pretty=format:%H origin/#{local_branch} -1`
+            unless local_sha == origin_sha
+              abort """
+Your #{local_branch} branch is not up to date with origin/#{local_branch}.
+Please make sure you have pulled and pushed all code before deploying:
+
+    git pull origin #{local_branch}
+    #run tests, etc
+    git push origin #{local_branch}
+
+    """
+            end
+          end
+
+          desc "Calculate the tag to deploy"
+          task :calculate_tag do
+            # make sure we have any other deployment tags that have been pushed by others so our auto-increment code doesn't create conflicting tags
+            `git fetch`
+
+            send "tag_#{stage}"
+
+            system "git push --tags origin #{local_branch}"
+            if $? != 0
+              abort "git push failed"
+            end
+          end
+
+          desc "Show log between most recent staging tag (or given tag=XXX) and last production release."
+          task :commit_log do
+            from_tag = if stage == :production
+                         last_production_tag
+                       elsif stage == :staging
+                         last_staging_tag
+                       else
+                         abort "Unsupported stage #{stage}"
+                       end
+
+            # no idea how to properly test for an optional cap argument a la '-s tag=x'
+            to_tag = capistrano_configuration[:tag]
+            to_tag ||= begin 
+                         puts "Calculating 'end' tag for :commit_log for '#{stage}'"
+                         to_tag = if stage == :production
+                                    last_staging_tag
+                                  elsif stage == :staging
+                                    'head'
+                                  else
+                                    abort "Unsupported stage #{stage}"
+                                  end
+                       end
+
+
+            command = if `git config remote.origin.url` =~ /git@github.com:(.*)\/(.*).git/
+                        "open https://github.com/#{$1}/#{$2}/compare/#{from_tag}...#{to_tag || 'master'}"
+                      else
+                        log_subcommand = if ENV['git_log_command'] && ENV['git_log_command'].strip != ''
+                                           ENV['git_log_command']
+                                         else
+                                           'log'
+                                         end
+                        "git #{log_subcommand} #{fromTag}..#{toTag}"
+                      end
+            puts command
+            system command
+          end
+
+          desc "Mark the current code as a staging/qa release"
+          task :tag_staging do
+            # find latest staging tag for today
+            new_tag_date   = Date.today.to_s
+            new_tag_serial = 1
+
+            who = `whoami`.chomp.to_url
+            what = Capistrano::CLI.ui.ask("What does this release introduce? (this will be normalized and used in the tag for this release) ").to_url
+
+            last_staging_tag = last_tag_matching("staging-#{new_tag_date}.*")
+            if last_staging_tag
+              # calculate largest serial and increment
+              last_staging_tag =~ /staging-[0-9]{4}-[0-9]{2}-[0-9]{2}\-([0-9]*)/
+                new_tag_serial = $1.to_i + 1
+            end
+
+            new_staging_tag = "#{stage}-#{new_tag_date}-#{new_tag_serial}-#{who}-#{what}"
+
+            current_sha = `git log --pretty=format:%H HEAD -1`
+            last_staging_tag_sha = if last_staging_tag
+                                     `git log --pretty=format:%H #{last_staging_tag} -1`
+                                   end
+
+            if last_staging_tag_sha == current_sha
+              puts "Not re-tagging staging because the most recent tag (#{last_staging_tag}) already points to current head"
+              new_staging_tag = last_staging_tag
+            else
+              puts "Tagging current branch for deployment to staging as '#{new_staging_tag}'"
+              system "git tag -a -m 'tagging current code for deployment to staging' #{new_staging_tag}"
+            end
+
+            set :branch, new_staging_tag
+          end
+
+          desc "Push the approved tag to production. Pass in tag to deploy with '-s tag=staging-YYYY-MM-DD-X-feature'."
+          task :tag_production do
+            promote_to_production_tag = capistrano_configuration[:tag]
+
+            unless promote_to_production_tag && promote_to_production_tag =~ /staging-.*/
+              abort "Staging tag required; use '-s tag=staging-YYYY-MM-DD.X'"
+            end
+            unless last_tag_matching(promote_to_production_tag)
+              abort "Staging tag #{promote_to_production_tag} does not exist."
+            end
+
+            promote_to_production_tag =~ /^staging-(.*)$/
+              new_production_tag = "production-#{$1}"
+            puts "promoting staging tag #{promote_to_production_tag} to production as '#{new_production_tag}'"
+            system "git tag -a -m 'tagging current code for deployment to production' #{new_production_tag} #{promote_to_production_tag}"
+
+            set :branch, new_production_tag
+          end
+        end
+
+        namespace :deploy do
+          namespace :pending do
+            task :compare do
+              gitflow.commit_log
+            end
+          end
+        end
+
+      end
+
+    end
+  end
+end
+
+if Capistrano::Configuration.instance
+  Capistrano::Gitflow.load_into(Capistrano::Configuration.instance)
+end

data/lib/capistrano/gitflow/natcmp.rb

@@ -0,0 +1,76 @@
+# natcmp.rb
+#
+# Natural order comparison of two strings
+# e.g. "my_prog_v1.1.0" < "my_prog_v1.2.0" < "my_prog_v1.10.0"
+# which does not follow alphabetically
+#
+# Based on Martin Pool's "Natural Order String Comparison" originally written in C
+# http://sourcefrog.net/projects/natsort/
+#
+# This implementation is Copyright (C) 2003 by Alan Davies
+# <cs96and_AT_yahoo_DOT_co_DOT_uk>
+#
+# This software is provided 'as-is', without any express or implied
+# warranty.  In no event will the authors be held liable for any damages
+# arising from the use of this software.
+#
+# Permission is granted to anyone to use this software for any purpose,
+# including commercial applications, and to alter it and redistribute it
+# freely, subject to the following restrictions:
+#
+# 1. The origin of this software must not be misrepresented; you must not
+#    claim that you wrote the original software. If you use this software
+#    in a product, an acknowledgment in the product documentation would be
+#    appreciated but is not required.
+# 2. Altered source versions must be plainly marked as such, and must not be
+#    misrepresented as being the original software.
+# 3. This notice may not be removed or altered from any source distribution.
+
+class String
+
+# 'Natural order' comparison of two strings
+def String.natcmp(str1, str2, caseInsensitive=false)
+	str1, str2 = str1.dup, str2.dup
+	compareExpression = /^(\D*)(\d*)(.*)$/
+
+	if caseInsensitive
+		str1.downcase!
+		str2.downcase!
+	end
+
+	# Remove all whitespace
+	str1.gsub!(/\s*/, '')
+	str2.gsub!(/\s*/, '')
+
+	while (str1.length > 0) or (str2.length > 0) do
+		# Extract non-digits, digits and rest of string
+		str1 =~ compareExpression
+		chars1, num1, str1 = $1.dup, $2.dup, $3.dup
+
+		str2 =~ compareExpression
+		chars2, num2, str2 = $1.dup, $2.dup, $3.dup
+
+		# Compare the non-digits
+		case (chars1 <=> chars2)
+			when 0 # Non-digits are the same, compare the digits...
+				# If either number begins with a zero, then compare alphabetically,
+				# otherwise compare numerically
+				if (num1[0] != 48) and (num2[0] != 48)
+					num1, num2 = num1.to_i, num2.to_i
+				end
+
+				case (num1 <=> num2)
+					when -1 then return -1
+					when 1 then return 1
+				end
+			when -1 then return -1
+			when 1 then return 1
+		end # case
+
+	end # while
+
+	# Strings are naturally equal
+	return 0
+end
+
+end # class String

data/recipes/gitflow_recipes.rb

@@ -0,0 +1,2 @@
+# Just need to add to LOAD_PATH, so we can require 'gitflow'
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')

data/spec/gitflow_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Gitflow" do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'gitflow'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification 
+name: capistrano-gitflow
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 3
+  - 0
+  version: 1.3.0
+platform: ruby
+authors: 
+- Joshua Nichols
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-15 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: capistrano
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: stringex
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id003
+description: Capistrano recipe for a deployment workflow based on git tags
+email: josh@technicalpickles.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .document
+- README.rdoc
+- Rakefile
+- VERSION
+- capistrano-gitflow.gemspec
+- gitflow.gemspec
+- lib/capistrano/gitflow.rb
+- lib/capistrano/gitflow/natcmp.rb
+- recipes/gitflow_recipes.rb
+- spec/gitflow_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/technicalpickles/gitflow
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Capistrano recipe for a deployment workflow based on git tags
+test_files: 
+- spec/gitflow_spec.rb
+- spec/spec_helper.rb