capistrano-deploytags 0.5

data/LICENSE

@@ -0,0 +1,26 @@
+Copyright (c) 2012 MyDrive Solutions Limited, All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+    * Redistributions of source code must retain the above copyright
+    notice, this list of conditions and the following disclaimer.
+
+    * Redistributions in binary form must reproduce the above
+    copyright notice, this list of conditions and the following
+    disclaimer in the documentation and/or other materials provided
+    with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,56 @@
+Capistrano Deployment Tags
+==========================
+This plugin to Capistrano will add timestamped and latest Git tags
+at each deployment, automatically.  It is intended to be used with
+the multistage recipe and will tag each release by environment.
+You can, however, use it without multistage simply by setting :branch
+and :stage in your recipe.
+
+What It Does
+------------
+Simply: it makes it so you can track your deployments from Git.
+If I were to issue the command:
+
+`cap production deploy`
+
+This would result in one new git tag with the environment and
+timestamp:
+
+`production-2012.04.02-203155`
+
+It would also result in moving or creating this tag:
+
+`production-latest`
+
+These tags can be used for any number of useful things including
+generating statistics about deployments per day/week/year, tracking
+code size over a period of time, detecting Rails migrations, and
+probably a thousand other things I haven't thought of.
+
+Usage
+-----
+If you use Bundler, be sure to add the gem to your Gemfile.
+In your Capistrano `config/deploy.rb` you should add:
+
+`require 'capistrano-deploytags'`
+
+This will create two tasks, one that runs before deployment and one
+that runs after.
+
+NOTE: You will be creating and pushing tags from the version of the
+code in the current checkout. This plugin needs to be run from a
+clean checkout of your codebase. You should be deploying from a
+clean checkout anyway, so in most cases this is not a restriction
+on how you already do things. The plugin will check if your code
+is clean and complain if it is not.
+
+Credits
+-------
+This software was written by [Karl Matthias](https://github.com/relistan)
+with help from [Gavin Heavyside](https://github.com/hgavin) and the
+support of [MyDrive Solutions Limited](http://mydrivesolutions.com).
+
+License
+-------
+This plugin is released under the BSD two clause license which is
+available in both the Ruby Gem and the source repository.

data/lib/capistrano-deploytags.rb

@@ -0,0 +1,3 @@
+Dir[File.join(File.dirname(__FILE__), 'capistrano', '*')].each do |file|
+  require file
+end

data/lib/capistrano/deploy_tags.rb

@@ -0,0 +1,84 @@
+module Capistrano
+  module DeployTags
+    def pending_git_changes?
+      # Do we have any changes vs HEAD on deployment branch?
+      !(`git fetch && git diff #{branch} --shortstat`.strip.empty?)
+    end
+    
+    def git_tag_for(stage)
+      "#{stage}-#{Time.now.strftime("%Y.%m.%d-%H%M%S")}"
+    end
+    
+    def last_git_tag_for(stage)
+      "#{stage}-latest"
+    end
+    
+    def safe_run(*args)
+      raise "#{args.join(" ")} failed!" unless system(*args)
+    end
+  
+    def validate_git_vars
+      unless exists?(:branch) && exists?(:stage)
+        logger.log Capistrano::Logger::IMPORTANT, "Capistrano Deploytags requires that :branch and :stage be defined."
+        raise 'define :branch or :stage'
+      end
+    end
+
+    def git_tag?(tag)
+      !`git tag -l #{tag}`.strip.empty?
+    end
+
+    def has_remote?
+      !`git remote`.strip.empty?
+    end
+
+    def self.load_into(configuration)
+      configuration.load do
+        before :deploy, 'git:prepare_tree'
+        after  :deploy, 'git:tagdeploy'
+
+        desc 'prepare git tree so we can tag on successful deployment'
+        namespace :git do
+          task :prepare_tree, :except => { :no_release => true } do
+            cdt.validate_git_vars
+
+            logger.log Capistrano::Logger::IMPORTANT, "Preparing to deploy HEAD from branch '#{branch}' to '#{stage}'"
+          
+            if cdt.pending_git_changes?
+              logger.log Capistrano::Logger::IMPORTANT, "Whoa there, partner. Dirty trees can't deploy. Git yerself clean first."
+              raise 'Dirty git tree'
+            end
+
+            cdt.safe_run "git", "checkout", branch
+            cdt.safe_run "git", "pull", "origin", branch if cdt.has_remote?
+          end
+          
+          desc 'add git tags for each successful deployment'
+          task :tagdeploy, :except => { :no_release => true } do
+            cdt.validate_git_vars
+
+            current_sha = `git rev-parse #{branch} HEAD`.strip[0..8]
+            logger.log Capistrano::Logger::INFO, "Tagging #{current_sha} for deployment"
+          
+            tag_user = (ENV['USER'] || ENV['USERNAME']).strip
+            cdt.safe_run "git", "tag", "-a", cdt.git_tag_for(stage), "-m", "#{tag_user} deployed #{current_sha} to #{stage}"
+            if cdt.git_tag?(cdt.last_git_tag_for(stage))
+              cdt.safe_run "git", "tag", "-d", cdt.last_git_tag_for(stage)
+              cdt.safe_run "git", "push", "--tags" if cdt.has_remote?
+            end
+          
+            cdt.safe_run "git", "tag", "-a", cdt.last_git_tag_for(stage), "-m", "#{tag_user} deployed #{current_sha} to #{stage}"
+            cdt.safe_run "git", "push", "--tags" if cdt.has_remote?
+          end
+        end
+
+      end
+    end
+  end
+end
+
+Capistrano.plugin :cdt, Capistrano::DeployTags
+
+if Capistrano::Configuration.instance
+  Capistrano::DeployTags.load_into(Capistrano::Configuration.instance(:must_exist))
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-deploytags
+version: !ruby/object:Gem::Version
+  version: '0.5'
+  prerelease: 
+platform: ruby
+authors:
+- Karl Matthias
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: &70334355156820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70334355156820
+- !ruby/object:Gem::Dependency
+  name: capistrano-ext
+  requirement: &70334355156380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70334355156380
+description: ! '  All you have to do is require capistrano-deploytags and each deployment
+  will add a new tag for that deployment, and will move the *-latest tag to the latest
+  commit. This lets you easily see which code is deployed on each environment, and
+  allows you to figure out which code was running in an environment at any time in
+  the past.
+
+'
+email: relistan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/capistrano/deploy_tags.rb
+- lib/capistrano-deploytags.rb
+- README.md
+- LICENSE
+homepage: http://github.com/mydrive/capistrano_deploytags
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Add dated, environment-specific tags to your git repo at each deployment.
+test_files: []