capistrano-deploytags 0.7.0 → 0.8.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZTkwOGQ4YjJjOWZkMDg4ODEwMjM3NTJlZjEzZDhhYTI3YTFjYzczYw==
+  data.tar.gz: !binary |-
+    YzZkMDkxZWM1ZDgzZTJiZmE5NmYzNGM1MDkwYzA2OTAwMGQ0MGFhZQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    MTA2OTY3NDU3MjI0MTZlMDJhMjY0M2M3MWMzNjhhN2Q2ZDA2MzJmMGY4N2Nj
+    ZGNjYzY3ODYzZmQ1MjAyZjMyN2QxOWUyNzVlY2ViODU2YWMyY2Q4NjM0MDE5
+    M2IwNjBhNmZjYzcxN2E0OWVhNzA0OGY5MDc3YmFjNTkyZTliOTg=
+  data.tar.gz: !binary |-
+    MTRiNGMxOTdhYzUzYzE1ZDBlZGFjMTEyNmE0NGM2NzdjZDlhYzMzYTAzNTFk
+    YzZlYjBiNTg0YTkyNjMzOTAyYWQyN2QxZDMxY2RmODQzMGVmZGRhMTU0YmY2
+    MDAzNWQ5NTkyMDMwZjRjYmNiNzg0Y2IyZmQwZTI4NjM1ZWNkOTE=

data/README.md

@@ -39,19 +39,78 @@ In your Capistrano `config/deploy.rb` you should add:
 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.
+*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.
+
+*ALSO:* The plugin will do a pull to make sure you have the code on your local
+system that will actually be deployed before checking the tree for changes.
+Know this ahead of time as this may affect how you deal with your deployment
+branches.
+
+Setting the Remote
+------------------
+By default, Capistrano Deploytags will use the first remote in the list returned
+by `git remote`. If you prefer to use a different remote, then you may change the
+`:git_remote` setting from your `deploy.rb`, the stage, or on the command line with
+`-S git_remote=your-remote`.
+
+Working on Your Deployment Scripts
+----------------------------------
+Because you must have a clean tree to deploy, working on your deployment
+scripts themselves can be a bit frustrating unless you know how to make it
+work. The easiest way around this problem is to simply commit your changes
+before you deploy. You do not have to push them. The plugin will then
+happily carry on deploying without complaint.
+
+Alternatively, you could disable the plugin temporarily with one of the
+methods described below.
+
+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:
+
+```ruby
+set :no_deploytags, true
+```
+
+You can also set this from the command line at any time with `-S no_deploytags=true`.
+
+*NOTE:* this will disable the use of the plugin's functionality entirely for
+that stage. The tasks will run, but will do nothing. This means that tasks that
+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.
+
+Viewing Deployment History
+--------------------------
+It's trivial to view the deployment history for a repo. From a checkout
+of the repo, type `git tag -l -n1`. The output looks something like:
+
+```
+dev-2013.07.22-105130 baz deployed a4d522d9d to dev
+dev-2013.07.22-113207 karl deployed 4c43f8464 to dev
+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`).
+
+It should be noted that the names used when tags are created are the
+local user name on the box where the deployment is done.
 
 Helpful Git Config
 ------------------
 You might find it useful to add this to your ~/.gitconfig in order
 to get a nice history view of the commits and tags.
 
-```
+```ini
 [alias]
    lol = log --pretty=oneline --abbrev-commit --graph --decorate
 ```
@@ -59,6 +118,14 @@ to get a nice history view of the commits and tags.
 You can then view the list by typing `git lol` from the checked out
 code path.
 
+Deploying a Previous Commit
+---------------------------
+Because you have to actually be on the head of the branch you are
+deploying in order for tagging to work properly, deploying a previous
+commit doesn't work as you might expect. The simple solution is to
+create a new branch from the previous commit you wish to deploy and
+supplying `-S branch=<new branch>` as arguments to Capistrano.
+
 Credits
 -------
 This software was written by [Karl Matthias](https://github.com/relistan)

data/lib/capistrano/deploy_tags.rb

@@ -15,7 +15,7 @@ module Capistrano
 
     def validate_git_vars
       unless exists?(:branch) && exists?(:stage)
-        logger.log Capistrano::Logger::IMPORTANT, "Capistrano Deploytags requires that :branch and :stage be defined."
+        logger.log Capistrano::Logger::IMPORTANT, 'Capistrano Deploytags requires that :branch and :stage be defined.'
         raise 'define :branch and :stage'
       end
     end
@@ -28,16 +28,22 @@ module Capistrano
       !`git remote`.strip.empty?
     end
 
+    def remote
+      exists?(:git_remote) ? git_remote : `git remote`.strip.split(/\n/).first
+    end
+
     def self.load_into(configuration)
       configuration.load do
-        before "deploy", 'git:prepare_tree'
-        before "deploy:migrations", 'git:prepare_tree'
-        after  "deploy", 'git:tagdeploy'
-        after  "deploy:migrations", 'git:tagdeploy'
+        before 'deploy', 'git:prepare_tree'
+        before 'deploy:migrations', 'git:prepare_tree'
+        after  'deploy', 'git:tagdeploy'
+        after  'deploy:migrations', 'git:tagdeploy'
 
         desc 'prepare git tree so we can tag on successful deployment'
         namespace :git do
           task :prepare_tree, :except => { :no_release => true } do
+            next if fetch(:no_deploytags, false)
+
             cdt.validate_git_vars
 
             logger.log Capistrano::Logger::IMPORTANT, "Preparing to deploy HEAD from branch '#{branch}' to '#{stage}'"
@@ -47,21 +53,23 @@ module Capistrano
               raise 'Dirty git tree'
             end
 
-            cdt.safe_run "git", "checkout", branch
-            cdt.safe_run "git", "pull", "origin", branch if cdt.has_remote?
+            cdt.safe_run 'git', 'checkout', branch
+            logger.log Capistrano::Logger::IMPORTANT, "Pulling from #{branch}"
+            cdt.safe_run 'git', 'pull', cdt.remote, branch if cdt.has_remote?
           end
 
           desc 'add git tags for each successful deployment'
           task :tagdeploy, :except => { :no_release => true } do
+            next if fetch(:no_deploytags, false)
+
             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}"
-
-            cdt.safe_run "git", "push", "--tags" if cdt.has_remote?
+            cdt.safe_run 'git', 'tag', '-a', cdt.git_tag_for(stage), '-m', "#{tag_user} deployed #{current_sha} to #{stage}"
+            cdt.safe_run 'git', 'push', '--tags' if cdt.has_remote?
           end
         end
 

metadata

@@ -1,38 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-deploytags
 version: !ruby/object:Gem::Version
-  version: 0.7.0
-  prerelease: 
+  version: 0.8.0
 platform: ruby
 authors:
 - Karl Matthias
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-02 00:00:00.000000000 Z
+date: 2013-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
-  requirement: &2153587100 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2153587100
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: capistrano-ext
-  requirement: &2153586660 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2153586660
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: ! '  Capistrano Deploytags is a simple plugin to Capistrano that works
   with your deployment framework to track your code releases. All you have to do is
   require capistrano-deploytags and each deployment will add a new tag for that deployment,
@@ -52,26 +57,25 @@ files:
 - LICENSE
 homepage: http://github.com/mydrive/capistrano-deploytags
 licenses: []
+metadata: {}
 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
+rubygems_version: 2.0.6
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Add dated, environment-specific tags to your git repo at each deployment.
 test_files: []