Contents

# OpsworksShip

Provides a shipping script for AWS OpsWorks apps.

## Installation

This requires the AWS CLI tools to be configured on the machine running the script. [Learn how](http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html)  

Add this line to your application's Gemfile, probably in the `development` group:

```ruby
gem 'opsworks_ship'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install opsworks_ship
    
Create a script (probably in `bin/deploy`) similar to the following:

        #!/usr/bin/env ruby
        
        gem 'opsworks_ship'
        require 'opsworks_ship/deploy'
        
        initialize(stack_name, revision, app_type, app_layer_name_regex, hipchat_auth_token = nil, hipchat_room_id = nil)
        
        args = [ARGV[0], ARGV[1], 'rails', 'rails|sidekiq', 'abcde_this_is_a_token', 12345].compact
        OpsworksShip::Deploy.new(*args).deploy

## Usage examples

* `./bin/deploy help`
* `./bin/deploy staging heads/master rails rails|sidekiq`
* `./bin/deploy staging heads/master rails rails|sidekiq my_hipchat_token my_hipchat_room`
* `./bin/deploy production heads/master java "Java App Server" my_hipchat_token my_hipchat_room`

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/NEWECX/opsworks_ship.


## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

Version data entries

5 entries across 5 versions & 1 rubygems

Version	Path
opsworks_ship-1.1.0	README.md
opsworks_ship-1.0.0	README.md
opsworks_ship-0.3.0	README.md
opsworks_ship-0.2.0	README.md
opsworks_ship-0.1.0	README.md