capistrano-helpers 0.9.1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 46c2d1ef6da197ce18d19bec1003447cb97500b4
-  data.tar.gz: 7be905d913ec17aeff03ad8e08eb2d5208471603
+  metadata.gz: 2565c2634ee8996d143d90ac9a6c2e03baa37876
+  data.tar.gz: 244dae3d4214ecf271d162f1a86b6b11a4a0372a
 SHA512:
-  metadata.gz: 8198e48e4991f7ef306a6415999c6f0f9feffad8bce169ceb5c42494c6ca9212d5032ed2f6462831f332744d948831437252aa992f738fd2e7645a04ce9615a3
-  data.tar.gz: 2322064d563c1c12a12f311cffd2ccde9361d67364d15116ff9aa5551bf2fae6b458434006c5a68feb6305a395c39fd7b92ae9d383a442bdce3d13aaebc3dab0
+  metadata.gz: b9e8a0889476ba5e8366af76ec114a3a59fb1ad96e957d08354734259966634dbdf57288d29838cda7b8827071cf3afd55f1726e3c72dd205e411de5531ef05b
+  data.tar.gz: d17a3832a4784d7ae4720cd8c31fded0074e547cbe3e4ff1f0a80e244ad711fcb02830274162911b28739cd4c2afbc6481add5f7b1ffe9b6f968d5af2004161e

data/.ruby-version

@@ -0,0 +1 @@
+2.1.4

data/{README.rdoc → README.md}

@@ -1,9 +1,9 @@
-= capistrano-helpers
+# capistrano-helpers
 
 A set of optional extensions to capistrano to make common tasks easier and
 reduce redundancy across your deployments.
 
-== Usage
+## Usage
 
 In your capistrano deploy recipe, simply require the helpers that contain the
 functionality that you would like to add to your recipe. In most cases this
@@ -12,120 +12,123 @@ time during deployment.
 
 Here's an example config/deploy.rb that uses a few helpers:
 
-  require 'capistrano-helpers/passenger' # Support for Apache passenger
-  require 'capistrano-helpers/specs'     # Check specs before deploying
-  require 'capistrano-helpers/version'   # Record the version number after deploying
-  require 'capistrano-helpers/campfire'  # Post deploy info to campfire
-
-  # The name of the application.
-  set :application, "myapp"
-
-  # The source code management software to use.
-  set :scm, "git"
-
-  # Location of the source code.
-  set :repository,  "git@github.com:mycompany/myapp.git"
+    require 'capistrano-helpers/passenger' # Support for Apache passenger
+    require 'capistrano-helpers/specs'     # Check specs before deploying
+    require 'capistrano-helpers/version'   # Record the version number after deploying
+    require 'capistrano-helpers/campfire'  # Post deploy info to campfire
+  
+    # The name of the application.
+    set :application, "myapp"
+  
+    # The source code management software to use.
+    set :scm, "git"
+  
+    # Location of the source code.
+    set :repository,  "git@github.com:mycompany/myapp.git"
 
 That's it! The recipe will now also perform the actions described by the
 helpers (in this case, the campfire helper also requires the tinder gem and
 a config/campfire.yml file).
 
-== Helpers
+## Helpers
 
-=== branch
+### branch
 
 Prompts the user for the particular tag/branch/commit to deploy.
 
-=== bundler
+### bundler
 
-Automatically runs "bundle install --deployment" to install gems from your Gemfile at the appropriate time.
+Automatically runs `bundle install --deployment` to install gems from your Gemfile at the appropriate time.
 
-=== campfire
+[Deprecated] This recipe predates bundler's direct support for capistrano. It's best to 
+`require 'bundler/capistrano'` in your recipe now instead of using this helper.
+
+### campfire
 
 Once the deploy is complete, this helper will post a message to the given
 Campfire room stating the username, the application, the branch/tag and the
 environment. E.g.:
 
-  Scott Woods finished deploying myapp v0.5.4 to staging
+    Scott Woods finished deploying myapp v0.5.4 to staging
 
 By default, it will only post when the deploy is complete. If you'd also
 like it to post when the deploy begins, you can add the following line
 to your deploy script:
 
-  before "deploy", "deploy:post_to_campfire_before"
+    before "deploy", "deploy:post_to_campfire_before"
 
 You will need to install the tinder gem to enable campfire notifications.  Run
 <tt>sudo gem install tinder</tt>, or add <tt>gem 'tinder'</tt> to your Gemfile.
 This helper expects to find a configuration file config/campfire.yml or
 ~/.campfire.yml with the following format:
 
-  # Configuration for posting to campfire.
-  subdomain: mycompany
-  token: abcd1234567890
-  room: Chatter
+    # Configuration for posting to campfire.
+    subdomain: mycompany
+    token: abcd1234567890
+    room: Chatter
 
 You can override the location of the configuration file by setting the
 :campfire_config variable:
 
-  set :campfire_config, 'somewhere/else.yml'
+    set :campfire_config, 'somewhere/else.yml'
 
 You can disable the notification for a specific deployment stage by setting
 the :campfire_notifications variable to false.
 E.g. in config/deploy/staging:
 
-  set :campfire_notifications, false
+    set :campfire_notifications, false
 
-=== ding
+### ding
 
 Once the deploy is complete, this helper will play a 'ding' sound (Mac only).
 
-=== features
+### features
 
 Before the app is deployed, this helper checks out the branch/tag that is
 being deployed and runs all the cucumber features, ensuring that they all
 pass.
 
-=== gems
+### gems
 
 Run the gems:install rake task using sudo after deployment.
 
-=== git
+### git
 
 Set git as the repository type, and set up remote caching to speed up
 deployments.
 
-=== growl
+### growl
 
 Once the deploy is complete, this helper will post a message to Growl stating
 the application, the branch/tag and the environment. E.g.:
 
-  capistrano
-
-  finished deploying myapp v0.5.4 to staging
+    capistrano
+  
+    finished deploying myapp v0.5.4 to staging
 
-=== jekyll
+### jekyll
 
 Deploy a static website with [jekyll](http://jekyllrb.com/). Rebuild the site
 during deployment, and override any server restarts (since it's just a static
 site).
 
-=== migrations
+### migrations
 
 Always run migrations during deployment.
 
-=== passenger
+### passenger
 
 Overrides the default :restart task so that it's compatible with restarting
 apache/passenger (aka mod_rails). Touches tmp/restart.txt.
 
-=== php
+### php
 
 Use this helper when using capistrano to deploy a purely PHP application.
 
 This neuters the default :restart and :finalize_updates tasks, since they
 aren't typically needed for a PHP installation.
 
-=== preflight
+### preflight
 
 Goes through a set of yes/no questions with the user before the application is
 actually deployed. This provides a way to walk the user through a set of
@@ -135,19 +138,25 @@ affirmatively.
 This helper expects to find the questions in a configuration file called
 config/preflight.yml . The file should be in the following format:
 
-  # Questions that must be answered "yes" before a deploy is allowed to proceed.
-  - Does cruise control show all tests passing?
-  - Do the staging and production servers have the required gems installed?
-  - Are you prepared to run migrations on the remote server?
-  - Have you tagged this release?
-  - Have you pushed the tags to github?
-
+    # Questions that must be answered "yes" before a deploy is allowed to proceed.
+    - Does cruise control show all tests passing?
+    - Do the staging and production servers have the required gems installed?
+    - Are you prepared to run migrations on the remote server?
+    - Have you tagged this release?
+    - Have you pushed the tags to github?
+  
 You can override the location of the configuration file by setting the
 :preflight_config variable:
 
-  set :preflight_config, 'somewhere/else.yml'
+    set :preflight_config, 'somewhere/else.yml'
+
+### robots
+
+Unless deploying to production, write a `public/robots.txt` file that will
+disallow all search engine bots and crawlers. This prevents your staging and
+beta sites from being indexed by Google.
 
-=== shared
+### shared
 
 During deployment, this helper replaces each of the given paths with a
 symbolic link that points to the same path under the "shared" directory on the
@@ -157,23 +166,23 @@ data that should persist across deployments (uploads, for example).
 After requiring this helper, set the paths to be symlinked using the
 :shared variable:
 
-  set :shared, %w{
-    public/uploads
-    public/downloads/huge_files
-  }
+    set :shared, %w{
+      public/uploads
+      public/downloads/huge_files
+    }
 
 This will create two symbolic links on the production server:
 
-  #{release_path}/public/uploads -> #{shared_path}/public/uploads
-  #{release_path}/public/downloads/huge_files -> #{shared_path}/public/downloads/huge_files
+    #{release_path}/public/uploads -> #{shared_path}/public/uploads
+    #{release_path}/public/downloads/huge_files -> #{shared_path}/public/downloads/huge_files
 
-=== skylinecms
+### skylinecms
 
 This is for the SkylineCMS gem. Skyline requires certain permissions and folders to operate,
 and this helper insures they exist. Remember to run this *after* the rest of your symlinks exist
 (eg. config/database.yml) and *before* anything loads the environment (eg. rake gems:install).
 
-=== privates
+### privates
 
 This works much like the shared helper above, except the symbolic link will
 point to the same path under "shared/private" on the server. This allows you
@@ -183,32 +192,32 @@ sensitive files safe, such as those that contain passwords or encryption keys.
 After requiring this helper, set the paths to be symlinked using the
 :privates variable:
 
-  set :privates, %w{
-    config/database.yml
-    config/session_secret.txt
-  }
-
+    set :privates, %w{
+      config/database.yml
+      config/session_secret.txt
+    }
+  
 This will create two symbolic links on the production server:
 
-  #{release_path}/config/database.yml -> #{shared_path}/private/config/database.yml
-  #{release_path}/config/session_secret.txt -> #{shared_path}/private/config/session_secret.txt
-
-=== specs
+    #{release_path}/config/database.yml -> #{shared_path}/private/config/database.yml
+    #{release_path}/config/session_secret.txt -> #{shared_path}/private/config/session_secret.txt
+  
+### specs
 
 Before the app is deployed, this helper checks out the branch/tag that is
 being deployed and runs all the rspec specs, ensuring that they all pass.
 
-=== unicorn
+### unicorn
 
 Overrides the default :restart task so that it's compatible with restarting
 unicorn.
 
-=== version
+### version
 
 Creates a VERSION file in the deployed copy that contains the name of the
 branch/tag that was deployed. Useful for displaying version information in the
 app itself.
 
-== Copyright
+## Copyright
 
 Copyright (c) 2014 West Arete Computing, Inc.

data/VERSION

@@ -1 +1 @@
-0.9.1
+0.10.0

data/capistrano-helpers.gemspec

@@ -2,26 +2,27 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: capistrano-helpers 0.9.1 ruby lib
+# stub: capistrano-helpers 0.10.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "capistrano-helpers"
-  s.version = "0.9.1"
+  s.version = "0.10.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Scott Woods"]
-  s.date = "2014-11-12"
+  s.date = "2014-11-13"
   s.description = "A set of optional extensions to capistrano to make common tasks easier."
   s.email = "team@westarete.com"
   s.extra_rdoc_files = [
     "LICENSE",
-    "README.rdoc"
+    "README.md"
   ]
   s.files = [
     ".document",
+    ".ruby-version",
     "LICENSE",
-    "README.rdoc",
+    "README.md",
     "Rakefile",
     "VERSION",
     "capistrano-helpers.gemspec",
@@ -40,6 +41,7 @@ Gem::Specification.new do |s|
     "lib/capistrano-helpers/php.rb",
     "lib/capistrano-helpers/preflight.rb",
     "lib/capistrano-helpers/privates.rb",
+    "lib/capistrano-helpers/robots.rb",
     "lib/capistrano-helpers/shared.rb",
     "lib/capistrano-helpers/skylinecms.rb",
     "lib/capistrano-helpers/specs.rb",

data/lib/capistrano-helpers/robots.rb

@@ -0,0 +1,15 @@
+require File.dirname(__FILE__) + '/../capistrano-helpers' if ! defined?(CapistranoHelpers)
+
+CapistranoHelpers.with_configuration do
+
+  namespace :deploy do
+    desc "Disallow robots unless deploying to production."
+    task :disallow_robots do
+      unless stage == :production
+        run %{cd #{release_path} && echo "User-agent: *\\nDisallow: /\\n" > public/robots.txt}
+      end
+    end
+  end
+  after "deploy:update_code", "deploy:disallow_robots"
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-helpers
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.10.0
 platform: ruby
 authors:
 - Scott Woods
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-12 00:00:00.000000000 Z
+date: 2014-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -58,11 +58,12 @@ executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE
-- README.rdoc
+- README.md
 files:
 - ".document"
+- ".ruby-version"
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION
 - capistrano-helpers.gemspec
@@ -81,6 +82,7 @@ files:
 - lib/capistrano-helpers/php.rb
 - lib/capistrano-helpers/preflight.rb
 - lib/capistrano-helpers/privates.rb
+- lib/capistrano-helpers/robots.rb
 - lib/capistrano-helpers/shared.rb
 - lib/capistrano-helpers/skylinecms.rb
 - lib/capistrano-helpers/specs.rb