capistrano-deploytags 0.9.1 → 0.9.2

data/README.md

@@ -16,7 +16,7 @@ If I were to issue the command:
 This would result in one new git tag with the environment and
 timestamp:
 
-`production-2012.04.02-203155`
+`production-2012.04.02-203155-utc`
 
 These tags can be used for any number of useful things including
 generating statistics about deployments per day/week/year, tracking
@@ -72,7 +72,7 @@ Disabling Tagging for a Stage
 -----------------------------
 Sometimes you do not want to enable deployment tagging for a particular
 stage. In that event, you can simply disable tagging by setting `no_deploytags`
-lik so:
+like so:
 
 ```ruby
 set :no_deploytags, true
@@ -86,6 +86,22 @@ are hooked to the Capistrano Deploytags tasks will also still run, but they may
 find their expectations are not met with regards to the cleanliness of the git
 tree.
 
+Customizing the Tag Format
+--------------------------
+You may override the time format in `config/deploy.rb`:
+
+```ruby
+set :deploytag_time_format, "%Y.%m.%d-%H%M%S-utc"
+```
+
+Customizing the Tag Commit Message
+----------------------------------
+By default, Capistrano Deploytags will create a tag with a message that indicates
+the local user name on the box where the deployment is done, and the hash of the
+tagged commit. If you prefer to have a more detailed commit message you may override
+the `:deploytag_commit_message` setting from your `deploy.rb` or on the command line
+with `-S deploytag_commit_message='This is my commit message for the deployed tag'`.
+
 Viewing Deployment History
 --------------------------
 It's trivial to view the deployment history for a repo. From a checkout
@@ -98,7 +114,6 @@ dev-2013.07.22-114437 gavin deployed 776e15414 to dev
 dev-2013.07.22-115103 karl deployed 619ff5724 to dev
 dev-2013.07.22-144121 joshmyers deployed cf1ed1a02 to dev
 ```
-
 A little use of `grep` and you can easily get the history for a
 particular (e.g. `git tag -l -n1 | grep dev`).
 
@@ -128,9 +143,9 @@ supplying `-S branch=<new branch>` as arguments to Capistrano.
 
 Running from Jenkins
 --------------------
-Because Jenkins will check out the code with the current revision 
-number you will be in a detached state. This causes the plugin to be 
-unhappy about the git tree. The solution is to add `-S branch=$GIT_COMMIT` 
+Because Jenkins will check out the code with the current revision
+number you will be in a detached state. This causes the plugin to be
+unhappy about the git tree. The solution is to add `-S branch=$GIT_COMMIT`
 to the cap deploy line called from your Jenkins build. This will cause
 the diffs and comparisons done by the deploytags gem to be correct.
 

data/lib/capistrano/deploy_tags.rb

@@ -9,7 +9,11 @@ module Capistrano
     end
 
     def git_tag_for(stage)
-      "#{stage}-#{Time.new.utc.strftime('%Y.%m.%d-%H%M%S-utc')}"
+      "#{stage}-#{formatted_time}"
+    end
+
+    def formatted_time
+      Time.new.utc.strftime(fetch(:deploytag_time_format, "%Y.%m.%d-%H%M%S-utc"))
     end
 
     def safe_run(*args)
@@ -39,6 +43,15 @@ module Capistrano
       exists?(:git_remote) ? git_remote : `git remote`.strip.split(/\n/).first
     end
 
+    def commit_message(current_sha)
+      if exists?(:deploytag_commit_message)
+        deploytag_commit_message
+      else
+        tag_user = (ENV['USER'] || ENV['USERNAME'] || 'deployer').strip
+        "#{tag_user} deployed #{current_sha} to #{stage}"
+      end
+    end
+
     def self.load_into(configuration)
       configuration.load do
         before 'deploy', 'git:prepare_tree'
@@ -74,8 +87,7 @@ module Capistrano
             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}"
+            cdt.safe_run 'git', 'tag', '-a', cdt.git_tag_for(stage), '-m', cdt.commit_message(current_sha)
             cdt.safe_run 'git', 'push', '--tags' if cdt.has_remote?
           end
         end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-deploytags
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.9.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-14 00:00:00.000000000 Z
+date: 2014-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -56,8 +56,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/capistrano/deploy_tags.rb
 - lib/capistrano-deploytags.rb
+- lib/capistrano/deploy_tags.rb
 - README.md
 - LICENSE
 homepage: http://github.com/mydrive/capistrano-deploytags