capistrano-gitflow_version 0.0.1

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/*
+*.gem
+.bundle

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in capistrano-gitflow_version.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,32 @@
+PATH
+  remote: .
+  specs:
+    capistrano-gitflow_version (0.0.1)
+      capistrano-ext (>= 1.2.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    capistrano (2.5.19)
+      highline
+      net-scp (>= 1.0.0)
+      net-sftp (>= 2.0.0)
+      net-ssh (>= 2.0.14)
+      net-ssh-gateway (>= 1.0.0)
+    capistrano-ext (1.2.1)
+      capistrano (>= 1.0.0)
+    highline (1.6.1)
+    net-scp (1.0.4)
+      net-ssh (>= 1.99.1)
+    net-sftp (2.0.5)
+      net-ssh (>= 2.0.9)
+    net-ssh (2.1.3)
+    net-ssh-gateway (1.0.1)
+      net-ssh (>= 1.99.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  capistrano-ext (>= 1.2.1)
+  capistrano-gitflow_version!

data/LICENSE

@@ -0,0 +1,21 @@
+(The MIT License)
+
+Copyright (c) 2011 Alice Brown
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,82 @@
+= gitflow_version: a Capistrano recipe for git deployment using tags in a multistage environment using MAJOR.MINOR.REVISION.BUILD
+
+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 to the multistage recipe.
+
+    # BEFORE
+    $ cap deploy              # 'deploy' goes to staging
+    $ cap production deploy   # 'deploy' goes to production
+
+    # AFTER
+    $ cap deploy
+    # 'deploy' goes to staging; tagged test-MAJOR.MINOR.REVISION.BUILD
+    $ cap production deploy
+    # deploys latest staging tag, or if last tag is a production tag then that, to production
+    # for specifying the tag by hand add `-s tag=MAJOR.MINOR.REVISION.BUILD`
+    # tag 'test-MAJOR.MINOR.REVISION.BUILD' goes to production
+    # tag 'vMAJOR.MINOR.REVISION.BUILD' created; points to test-MAJOR.MINOR.REVISION.BUILD
+
+    # BONUS
+    cap gitflow_version: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_version:log_log
+    # displays a commit log of what will be pushed to production
+
+== INSTALLATION
+
+First, install the gem:
+
+    gem install capistrano-gitflow_version
+
+Then update config/deploy.rb
+
+    require 'capistrano/gitflow_version'
+
+== 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:
+
+* if the last tag was a test-MAJOR.MINOR.REVISION.BUILD will automatically increment BUILD
+* if the last tag was vMAJOR.MINOR.REVISION.BUILD will ask you what the next tag should be
+* create a new tag
+* 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=test-0.8.4.3
+
+gitflow will automatically:
+
+* alias the staging tag to a production tag without the test- prefix
+* 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...
+
+Forked from Josh Nichols's capistrano-gitflow repo. Hacked by Alice Brown. Put under the MIT License. See the LICENSE file.
+
+

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/capistrano-gitflow_version.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "capistrano/gitflow_version/version"
+
+Gem::Specification.new do |s|
+  s.name        = "capistrano-gitflow_version"
+  s.version     = Capistrano::GitflowVersion::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Joshua Nichols", "Alice Brown"]
+  s.email       = ["josh@technicalpickles.com", "alice@alum.mit.edu"]
+  s.homepage    = "https://github.com/ambtus/capistrano-gitflow"
+  s.summary     = %q{Capistrano recipe for tagged deployment}
+  s.description = %q{Capistrano recipe for a deployment workflow based on git tags in MAJOR.MINOR.REVISION.BUILD format}
+
+  s.rubyforge_project = "capistrano-gitflow_version"
+
+  s.add_dependency('capistrano-ext', '>=1.2.1')
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/capistrano/gitflow_version.rb

@@ -0,0 +1,197 @@
+require 'capistrano'
+require 'capistrano/ext/multistage'
+require 'capistrano-gitflow_version/natcmp'
+require 'stringex'
+
+module Capistrano
+  module GitflowVersion
+    def self.load_into(capistrano_configuration)
+      capistrano_configuration.load do
+        before "deploy:update_code", "gitflow_version:calculate_tag"
+        before "gitflow_version:calculate_tag", "gitflow_version:verify_up_to_date"
+
+        namespace :gitflow_version 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('test-*')
+          end
+
+          def next_staging_tag
+            new_tag_serial = if last_production_tag == next_production_tag
+                               Capistrano::CLI.ui.ask("What is the release after #{last_production_tag}? (must be in MAJOR.MINOR.REVISION.BUILD format) ")
+                             else
+                               if last_staging_tag && last_staging_tag =~ /test-([0-9]+.[0-9]+.[0-9]+.)([0-9]+)/
+                                 $1 + ($2.to_i + 1).to_s
+                               else
+                                 release = Capistrano::CLI.ui.ask("What is the starting release? (must be in MAJOR.MINOR.REVISION.BUILD format) ")
+                                 unless release =~ /[0-9]+.[0-9]+.[0-9]+.[0-9]+/
+                                   abort "#{release} must be in MAJOR.MINOR.REVISION.BUILD format. example: 0.8.5.0"
+                                 end
+                                 release
+                               end
+            end
+
+
+            "test-#{new_tag_serial}"
+          end
+
+          def last_production_tag()
+            last_tag_matching('v*')
+          end
+
+          def next_production_tag
+            last_staging_tag = last_tag_matching("test-*")
+
+            last_staging_tag =~ /^test-(.*)$/
+            "v#{$1}"
+          end
+
+          def using_git?
+            fetch(:scm, :git).to_sym == :git
+          end
+
+          task :verify_up_to_date do
+            if using_git?
+              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 #{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
+          end
+
+          desc "Calculate the tag to deploy"
+          task :calculate_tag do
+            if using_git?
+              # 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}" if respond_to?(stage)
+
+              system "git push --tags origin #{local_branch}"
+              if $? != 0
+                abort "git push failed"
+              end
+            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
+                                    'master'
+                                  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
+            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
+              new_staging_tag = next_staging_tag
+              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 last staging tag to production."
+          task :tag_production do
+            promote_to_production_tag = last_staging_tag
+
+            unless promote_to_production_tag && promote_to_production_tag =~ /test-.*/
+              abort "Couldn't find a staging tag to deploy; use '-s tag=test-MAJOR.MINOR.REVISION.BUILD'"
+            end
+            unless last_tag_matching(promote_to_production_tag)
+              abort "Staging tag #{promote_to_production_tag} does not exist."
+            end
+
+            promote_to_production_tag =~ /^test-(.*)$/
+            new_production_tag = "v#{$1}"
+
+            if new_production_tag == last_production_tag
+              puts "using current production tag '#{new_production_tag}'"
+            else
+              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}"
+            end
+
+            set :branch, new_production_tag
+          end
+        end
+
+        namespace :deploy do
+          namespace :pending do
+            task :compare do
+              gitflow_version.commit_log
+            end
+          end
+        end
+
+      end
+
+    end
+  end
+end
+
+if Capistrano::Configuration.instance
+  Capistrano::GitflowVersion.load_into(Capistrano::Configuration.instance)
+end

data/lib/capistrano/gitflow_version/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/lib/capistrano/gitflow_version/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module GitflowVersion
+    VERSION = "0.0.1"
+  end
+end

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')

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: capistrano-gitflow_version
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Joshua Nichols
+- Alice Brown
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-03 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: capistrano-ext
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 1
+        version: 1.2.1
+  type: :runtime
+  version_requirements: *id001
+description: Capistrano recipe for a deployment workflow based on git tags in MAJOR.MINOR.REVISION.BUILD format
+email: 
+- josh@technicalpickles.com
+- alice@alum.mit.edu
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.rdoc
+- Rakefile
+- capistrano-gitflow_version.gemspec
+- lib/capistrano/gitflow_version.rb
+- lib/capistrano/gitflow_version/natcmp.rb
+- lib/capistrano/gitflow_version/version.rb
+- recipes/gitflow_recipes.rb
+has_rdoc: true
+homepage: https://github.com/ambtus/capistrano-gitflow
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: capistrano-gitflow_version
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Capistrano recipe for tagged deployment
+test_files: []
+