README.md

S3deploy

Rake tasks for pushing stuff to S3. Heavily cribbed from Mixbook's S3 Deployer. Unlike Mixbook's thing, this does no versioning or fancy revisiony stuff.

Installation

Add this line to your application's Gemfile:

gem 's3deploy', git: 'https://github.com/ryanmark/s3deploy-ruby.git'

And then execute:

$ bundle install

Rake usage

Your Rakefile should look something like this:

require 'rubygems'
require 'bundler'
Bundler.setup

require 's3deploy/tasks'

S3deploy.configure do
  bucket "my-staging-bucket"
  app_path "devastator" # dir in the S3 bucket to deploy to
  dist_dir "dist" # local dir to deploy from
  gzip [/\.js$/, /\.css$/, /\.json$/, /\.html$/, /\.csv$/] # or just use 'true' to gzip everything

  before_deploy -> do
    # Some custom code to execute before deploy
  end

  after_deploy -> do
    # Some custom code to execute after deploy
  end

  # You also can specify environment-specific settings, the default environment is 'production'
  environment(:production) do
    bucket "my-production-bucket"
  end

  access_key_id ENV['AWS_ACCESS_KEY_ID']
  secret_access_key ENV['AWS_SECRET_ACCESS_KEY']
end

To actually deploy:

$ rake s3:deploy

To deploy to production:

$ ENV=production rake s3:deploy

API Usage

You can also use the deployer in your own code as a plain old object.

require 's3deploy/deployer'

deployer = S3deploy::Deployer.new(
    # required
    dist_dir: 'upload',
    bucket: 'my-bucket',
    # optional
    access_key_id: 'AWS access key id',
    secret_access_key: 'AWS access key',
    app_path: 'graphics/foo',
    gzip: [/\.js$/, /\.css$/, /\.html?$/],
    logger: Rails.logger
)

Contributing

1. Fork it ( https://github.com/ryanmark/s3deploy/fork )
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 a new Pull Request