Simplify your Heroku deploy with quick and concise deployment rake tasks.

Installation

Add this line to your application's Gemfile:

  gem 'paratrooper'

and then execute

  bundle

or

install it yourself with

  gem install paratrooper

Usage

Instantiate Paratrooper with the name of your heroku application.

Paratrooper::Deploy.new('amazing-app')

You can also provide a tag:

Paratrooper::Deploy.new('amazing-app', tag: 'staging')

Authentication

You can authenticate your Heroku account in a few different ways:

• Providing API Key

Paratrooper::Deploy.new('app', api_key: 'API_KEY')

• Setting an environment variable

ENV['HEROKU_API_KEY'] = 'API_KEY'
Paratrooper::Deploy.new('app')

• Local Netrc file

Paratrooper::Deploy.new('app')

This method works via a local Netrc file which is handled via the Heroku Toolbelt and is the default and preferred method of providing your authentication key.

Tag Management

By providing tag options into Paratrooper, your code can be tagged and deployed from different reference points.

Staging example

  Paratrooper::Deploy.new("staging-app",
    tag: 'staging'
  )

This will create/update a staging git tag at HEAD

Production example

  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

This will perform the following tasks:

• Activating maintenance mode
• Create or update a git tag (if provided)
• Push changes to Heroku
• Run database migrations
• Restart the application
• Deactivate maintenance mode
• Warm application instance

Example Usage

require 'paratrooper'

namespace :deploy do
  desc 'Deploy app in staging environment'
  task :staging do
    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',
      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. Every deployment method sends a notification that can be captured and used in most any way you can think of.

For example, say you want to let New Relic know that you are deploying and to disable your application monitoring.

Example Usage

# Gemfile
gem 'paratrooper-newrelic'

# lib/tasks/deploy.rake
require 'paratrooper'

namespace :deploy do
  desc 'Deploy app in production environment'
  task :production do
    deployment = Paratrooper::Deploy.new("amazing-production-app",
      tag: 'production',
      match_tag_to: 'staging',
      notifiers: [
        Paratrooper::Notifers::ScreenNotifier.new,
        Paratrooper::Newrelic::Notifier.new('api_key', 'account_id', 'application_id')
      ]
    )
  end
end

• The ScreenNotifier is added by default so when you override the notifiers option you need to manually add it in to continue getting screen output.

To make your own notifier, take a look at Paratrooper::Notifier to see what methods are available to be overridden.

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request

Thanks

• Rye Mason for the fantastic heading image