shuttle 1.2.8 → 1.2.9

data/README.md

@@ -2,7 +2,7 @@
 
 A simplest continuous integration for a Rails application. Enjoy it!
 
-Get a new code from another team members, install new gems, run new migrations, run specs and send your new feature to the origin repository. At the simplest way!
+Get a new code from another team members, install new gems, run new migrations, run specs, send your new feature to the origin repository and deploy your application. At the simplest way!
 
 ## Installation
 
@@ -14,14 +14,72 @@ Install the gem with Bundler:
 
     $ bundle
 
+## Configuration
+
 And then configure default Shuttle Steps:
 
     $ rails g shuttle:install
+    
+This will create a configuration file in `config/initializers/shuttle.rb` looks like this:
+
+    Shuttle.setup do |s|
+      s.steps = [
+        'shuttle:git:check',
+        'shuttle:git:pull',
+        'shuttle:bundle',
+        'db:migrate',
+        'shuttle:spec',
+        'shuttle:git:push',
+        # 'log:clear',
+        # 'tmp:clear',
+      ]
+    
+      # s.stages = {
+      #   staging:    'your@server.com:staging-repository.git',
+      #   production: 'your@server.com:production-repository.git'
+      # }
+    end
+
+### Understanding
+
+#### Shuttle Steps
+
+The steps are nothing more than Rake tasks that are performed at the time of integration. The order of the steps in the array will be the order they will be executed. You have the freedom to rearrange, add or delete steps according to your need.
+
+##### Shuttle's pre-defined Steps:
+
+* `shuttle:git:check` checks for files to be commited
+* `shuttle:git:pull` gives a pull from the origin repository
+* `shuttle:git:push` gives a push to the origin repository
+* `shuttle:bundle` install all the new gems
+* `shuttle:spec` prepare and run all specs
+
+#### Shuttle Stages
 
-## Usage
+Stages are repositories for deploy, usually a repository hosted on [Heroku](http://heroku.com). You can configure multiple repositories representing different execution environments for their application, such as `staging` or `production`.
+
+## How To
+
+#### Integrate
+
+Just run this to integrate your app:
 
     $ rake shuttle
 
+#### Deploy
+
+If you wish to deploy your app in `staging`, run this:
+
+    $ rake shuttle[staging]
+    
+Or, deploy to `staging`, and then to `production`, run this:
+
+    $ rake shuttle[staging:production]
+    
+You can deploy on how many repositories you want at once, as long as they are configured as Shuttle Stages.
+
+**Note**: before deploy, it will integrate the app.
+
 ## Contributing
 
 1. Fork it

data/lib/shuttle/version.rb

@@ -1,3 +1,3 @@
 module Shuttle
-  VERSION = "1.2.8"
+  VERSION = "1.2.9"
 end

data/shuttle.gemspec

@@ -4,7 +4,7 @@ Gem::Specification.new do |gem|
   gem.authors       = ["Felipe Bazzarella"]
   gem.email         = ["fbazzarella@gmail.com"]
   gem.description   = %q{A simplest continuous integration for a Rails application. Enjoy it!}
-  gem.summary       = %q{Get a new code from another team members, install new gems, run new migrations, run specs and send your new feature to the origin repository. At the simplest way!}
+  gem.summary       = %q{Get a new code from another team members, install new gems, run new migrations, run specs, send your new feature to the origin repository and deploy your application. At the simplest way!}
 
   gem.files         = `git ls-files`.split($\)
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shuttle
 version: !ruby/object:Gem::Version
-  version: 1.2.8
+  version: 1.2.9
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-22 00:00:00.000000000 Z
+date: 2013-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colored
@@ -66,9 +66,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Get a new code from another team members, install new gems, run new migrations,
-  run specs and send your new feature to the origin repository. At the simplest way!
+  run specs, send your new feature to the origin repository and deploy your application.
+  At the simplest way!
 test_files: []