# eycap [![Build Status](https://secure.travis-ci.org/engineyard/eycap.png)](http://travis-ci.org/engineyard/eycap)


## Description

The Engine Yard capistrano tasks are for use specifically with Engine Yard Managed services.  But can be used as examples for building other tasks as well.

## Requirements

* [Capistrano](https://github.com/capistrano/capistrano) >= 2.2.0

* NOTE: When using a git repository use Capistrano >= 2.5.3.

## Install

    $ gem install eycap

## Usage

Your initial deploy.rb will be provided for you when your servers are provisioned on Engine Yard Managed.  In order to deploy your application, you can go to the `RAILS_ROOT` folder and run:

    $ capify .

This generates the `Capfile` and the `config/deploy.rb` file for you.  You'll replace the `config/deploy.rb` file with the `deploy.rb` given to you by Engine Yard.

For deploying Rails 3.1 or greater apps using the [asset pipeline](https://github.com/engineyard/eycap/wiki/Asset-Pipeline) read more on the linked page.

### Deploying to Environment

To ensure your environments are ready to deploy, check on staging.

    $ cap staging deploy:check

This will determine if all requirements are met to deploy.  Sometimes if the default folders are not setup you may be able to repair by running:

	$ cap staging deploy:setup

If you cannot get `deploy:check` to pass, please open a [new support ticket](https://support.cloud.engineyard.com/tickets/new) and let us know.

Now you're ready to do a test deploy.

Optionally, `cap deploy:cold` will run your migrations and start (instead of restart) your app server.  

    $ cap staging deploy:cold

Or if you have already dumped a copy of your data to staging or do not want to run migrations you can simply do a deploy.

    $ cap staging deploy

And to do all this on production, just change the environment name and you'll be all set.

    $ cap production deploy

## Eycap Commands

For a list of all available commands, run:

    $ cap -T

This will show you not only the default capistrano commands but also the ones you get by including the eycap gem.    

## Pull Requests
 
If you'd like to contribute to the eycap gem please create a fork, then send a pull request and a member of the eycap team will review it.

## Issues

When you run into a problem please check the [issues](/issues) to see if one has been reported.  If not, please report the issue and we'll get to work on fixing it. 
## License

Copyright (c) 2008-2012 Engine Yard

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.