paratrooper 1.0.0 → 1.1.0

data/README.md

@@ -4,7 +4,7 @@
 [![Build Status](https://travis-ci.org/mattpolito/paratrooper.png?branch=master)](https://travis-ci.org/mattpolito/paratrooper)
 [![Code Climate](https://codeclimate.com/github/mattpolito/paratrooper.png)](https://codeclimate.com/github/mattpolito/paratrooper)
 
-Make your complex deploy to [Heroku][] easy.
+Make your complex deploy to [Heroku][] easy. This library affords you the ability to make a quick and concise deployment rake task.
 
 ## Installation
 
@@ -60,6 +60,27 @@ Paratrooper::Deploy.new('app')
 Paratrooper::Deploy.new('app')
 ```
 
+## Tag Management
+
+By providing tag options into Paratrooper, your code can be tagged and deployed from different reference points.
+
+### Staging example
+```ruby
+  Paratrooper::Deploy.new("staging-app",
+    tag: 'staging'
+  )
+```
+This will create/update a `staging` git tag at `HEAD`
+
+### Production example
+```ruby
+  Paratrooper::Deploy.new("amazing-production-app",
+    tag: 'production'
+    match_tag_to: 'staging'
+  )
+```
+This will create/update a `production` git tag at `staging` and deploys the `production` tag
+
 ## Sensible Default Deployment
 
 You can use the objects methods any way you'd like but we've provided a sensible default at `Paratrooper#deploy`
@@ -74,31 +95,67 @@ This will perform the following tasks:
 * Deactivate maintenance mode
 * Warm application instance
 
-## Example Usage
-
+### Example Usage
 ```ruby
 require 'paratrooper'
 
 namespace :deploy do
   desc 'Deploy app in staging environment'
   task :staging do
-    deployment = Paratrooper::Deploy.new("amazing-staging-app", tag: 'staging')
+    deployment = Paratrooper::Deploy.new("amazing-staging-app",
+      tag: 'staging'
+    )
 
     deployment.deploy
   end
 
   desc 'Deploy app in production environment'
   task :production do
-    deployment = Paratrooper::Deploy.new("amazing-production-app", tag: 'production')
+    Paratrooper::Deploy.new("amazing-production-app",
+      tag: 'production'
+      match_tag_to: 'staging'
+    )
 
     deployment.deploy
   end
 end
 ```
 
+## Bucking the Norm
+
+Our default deploy gets us most of the way but maybe it's not for you. We've got you covered. Once you've instantated Paratrooper, you have access to all of the included methods as well as any arbitrary code that needs to be run.
+
+Say you want to let [New Relic][] know that you are deploying. That way your heartbeat notifications will not make you crazy with false downtime.
+
+### Example Usage
+```ruby
+require 'paratrooper'
+
+namespace :deploy do
+  desc 'Deploy app in production environment'
+  task :production do
+    Paratrooper::Deploy.new("amazing-production-app",
+      tag: 'production'
+      match_tag_to: 'staging'
+    )
+
+    %x[curl https://heroku.newrelic.com/accounts/ACCOUNT_ID/applications/APPLICATION_ID/ping_targets/disable -X POST -H "X-Api-Key: API_KEY"]
+
+    deployment.activate_maintenance_mode
+    deployment.update_repo_tag
+    deployment.push_repo
+    deployment.run_migrations
+    deployment.app_restart
+    deployment.deactivate_maintenance_mode
+    deployment.warm_instance
+
+    %x[curl https://heroku.newrelic.com/accounts/ACCOUNT_ID/applications/APPLICATION_ID/ping_targets/enable -X POST -H "X-Api-Key: API_KEY"]
+  end
+end
+```
+
 ## Nice to haves
 
-* deploy to heroku from tags
 * send [New Relic][] a notification to toggle heartbeat during deploy
 
 ## Contributing

data/lib/paratrooper/deploy.rb

@@ -5,14 +5,14 @@ require 'paratrooper/system_caller'
 module Paratrooper
   class Deploy
     attr_reader :app_name, :formatter, :system_caller, :heroku, :tag_name,
-      :deploy_tag
+      :match_tag
 
     def initialize(app_name, options = {})
       @app_name      = app_name
       @formatter     = options[:formatter] || DefaultFormatter.new
       @heroku        = options[:heroku] || HerokuWrapper.new(app_name, options)
       @tag_name      = options[:tag]
-      @deploy_tag    = options[:deploy_tag] || 'master'
+      @match_tag     = options[:match_tag_to] || 'master'
       @system_caller = options[:system_caller] || SystemCaller.new
     end
 
@@ -29,14 +29,15 @@ module Paratrooper
     def update_repo_tag
       unless tag_name.nil? || tag_name.empty?
         notify_screen("Updating Repo Tag: #{tag_name}")
-        system_call "git tag #{tag_name} #{deploy_tag} -f"
+        system_call "git tag #{tag_name} #{match_tag} -f"
         system_call "git push origin #{tag_name}"
       end
     end
 
     def push_repo
-      notify_screen("Pushing #{deploy_tag} to Heroku")
-      system_call "git push -f #{git_remote} #{deploy_tag}:master"
+      reference_point = tag_name || 'master'
+      notify_screen("Pushing #{reference_point} to Heroku")
+      system_call "git push -f #{git_remote} #{reference_point}:master"
     end
 
     def run_migrations

data/lib/paratrooper/version.rb

@@ -1,3 +1,3 @@
 module Paratrooper
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/spec/paratrooper/deploy_spec.rb

@@ -107,7 +107,7 @@ describe Paratrooper::Deploy do
 
       context "when deploy_tag is available" do
         before do
-          options.merge!(deploy_tag: 'deploy_this')
+          options.merge!(match_tag_to: 'deploy_this')
         end
 
         it 'creates a git tag at deploy_tag reference point' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paratrooper
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors: