negroku 1.1.4 → 1.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4616eed3ef790989b7fa11e5d5dfab9ace86455a
-  data.tar.gz: 3b7f1d30b0389ac1c0ede79a65e64e9c6e4a641c
+  metadata.gz: 9adb73105871cbf165656dfe33507cda128c5c8a
+  data.tar.gz: b07e0bcd847d070997f21f08139bc33dc63b0d94
 SHA512:
-  metadata.gz: cf42f8f48160b0cabfaaa67e0405ddf1ac37fb0a1187901018093e38740c02481f15b5632722b7622e44a5ee4970e5bc12cb69103af6a6b78c3b2db357281d42
-  data.tar.gz: 05d8e3d372a48ea887be1f9346cc9fb96ed126518d26b4672996be6dec268d39ea2c44951857369ff6865b01947d5b53eaf5246290fd7eaf021e1e6596e894bc
+  metadata.gz: bacb1d75946396c708f3c2ac661dd3747ff338e87eebb481722855008261f74181816d9726ebee62ce1e619515346b3cc9946aaf425291966bbec920d5b16489
+  data.tar.gz: b532f52f6edd707cfe13a0be44cca44df22270bdc13cbbd8a1f7cf380e719fcd3fff9d956d96592f87c254fff2bf6221f6fad0262539144ccbb26f3c5b1cdc25

data/README.md

@@ -3,22 +3,76 @@ Negroku
 
 Negroku is an opinionated collection of recipes for capistrano.
 
-The goal is to be able to deploy **ruby on rails applications** and **static websites** without the hassle of configure and define all the stuff involved in an application deployment.
+The goal is to be able to deploy **ruby on rails applications** and **static websites** without the hassle of configuring and defining all the stuff involved in an application deployment.
 
-All the server configurations pre-defined in the configuration files generated by negroku are targeted oto this generic [configuration guide](https://github.com/platanus/guides/tree/master/deployment).
+All the server settings pre-defined in the configuration files generated by negroku are targeted to this server generic [configuration guide](https://github.com/platanus/guides/tree/master/deployment). Although in most cases you can customize those settings.
 
 Installation
 ------------
 
-Just install negroku as a global gem.
+Install negroku as a global gem.
 
-    gem install negroku
+```shell
+$ gem install negroku
+```
+
+Add the negroku gem to your `Gemfile` development group to lock the version your are going to use.
+
+```ruby
+group :development do
+    gem 'negroku', '1.1.4'
+end
+```
+
+You will need to add to your Gemfile these two gems:
+
+```ruby
+group :assets do
+    gem 'therubyracer', :platforms => :ruby
+end
+
+group :production do
+    gem 'unicorn'
+end
+```
+
+Then execute
+
+```shell
+$ bundle install
+```
+
+**Note:** Add the `therubyracer` gem only if your are going to use the assets precompile of a rails project.
 
 ## Getting started
 
-1. Bootpstrapp your app (behind the scene it runs `capify .` plus some customizations)
+1. Create your app executing the following command, and just follow the on-screen questions.
+
+    ```
+    $ negroku app create
+    ```
+
+    ####Give your application a name
+
+    This will be used to create the app folder structure in the server and to name some files, for example, the log files.
+
+
+    ####Please choose your repository
+
+    You'll need to choose the git respository where your are going to store your project. Typically a GitHub repository, it can be any repository that the server has access to.
+
+    If you have already initializated your git repository for the project, you'll be offered to choose the remotes of the current repo.
+
+    ####Target servers
 
-    It will add this files to your proyect, this is the same structure that capistrano expect when using multistage extensions
+    You'll need to choose the server address where the project will be deployed and the hostname that will be used by *nginx* to host the application. Negroku will ask this for two stage servers (staging, production)
+
+    *Note:* Refer to the [negroku config taks](#config-task) to add some default servers to the negroku configuration.
+
+
+1. The `app create` command will bootpstrapp your app (behind the scenes it will run the capistrano command `capify .` and add some customizations)
+
+    Some files and folders will be added to your project, this is the same structure that capistrano expects when using multistage extensions
 
     ```
     project_root
@@ -30,36 +84,52 @@ Just install negroku as a global gem.
                  +--- staging.rb        # Specific settings for staging server
     ```
 
-    It will also add to your Gemfile two gems
+1. Configure your specific settings in the files created above
 
-    ```ruby
-    group :assets do
-        gem 'therubyracer', :platforms => :ruby
-    end
+    ####Common settings for all stages `deploy.rb`
 
-    group :production do
-        gem 'unicron'
-    end
+    Here you can add all the settings that are common to all the stage severs.
+
+    ```ruby
+    #You may want to change the stages and the default stage
+    set :stages, %w(production staging)
+    set :default_stage, "staging"
     ```
 
-1. Configure your specific settings in the files created above
 
-1. Prepare your server for your application with `cap deploy:setup` task
+    ####Per-stage settings `staging.rb` `production.rb`
+
+    Here you can add all the settings that are specific to the stage.
+
+    ```ruby
+    #You may want to change the repository branch for each stage.
+    set :branch,        "production"        # Optional, defaults to master
+    ```
+
 
-1. Deploy you application with `cap deploy` task
+1. Prepare the server for your application executing
 
-### Type of applications supported
+    ```shell
+    $ cap deploy:setup
+    ```
 
-You can bootstrap with negroku two type of applications, ruby on rails applications with native capistrano support and static web sites with specific recipes.
+1. Commit and push the changes to the repository
 
+1. Configure all your environmental variables for your project using the [negroku env taks](#env-task)
 
-        negroku app create <appname>
+1. Deploy you application for the first time executing
 
-    Follow the in-screen instructions and questions.
+    ```shell
+    $ cap deploy:cold                # for the default stage
+    $ cap production deploy:cold     # for the production stage
+    ```
 
-2.
+    For all the next following deploys, you should execute
 
-#Static websites
+    ```shell
+    $ cap deploy                     # for the default stage
+    $ cap production deploy          # for the production stage
+    ```
 
 The CLI
 -------
@@ -68,10 +138,16 @@ Negroku also provides a simple CLI that helps to initialize the deployment of yo
 
 ### App task
 
+*comming soon...*
+
 ### Env task
 
+*comming soon...*
+
 ### Config task
 
+*comming soon...*
+
 Included recipes
 ----------------
 
@@ -123,9 +199,15 @@ cap rbenv:vars:symlink            # Symlink rbenv-vars file into the current ...
 Customizing the recipes
 -----------------------
 
-Aside of prodefine some ways of doing the deployments, negroku is very flexible. This flexibility is inherit from capistrano where you can extend negroku with your recipes, overide existing ones, and modify every configuration you want.
-
+Aside of predefining some ways of doing the deployments, negroku is very flexible. This flexibility is inherited from capistrano, so you can extend negroku with your recipes, overide existing ones, and modify every configuration you want.
 
+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
 
 

data/lib/negroku/helpers.rb

@@ -43,19 +43,19 @@ def init(target=".", data)
 
   # Create the new deploy
   puts "[Negroku] => Writing new deploy.rb."
-  erb = File.read(File.join(File.dirname(__FILE__), 'templates', 'deploy.rb.erb'))
+  erb = getTemplate 'deploy.rb.erb'
   File.open(deployfile, 'w') do |f|
     f.write ERB.new(erb).result(binding)
   end
 
   # Create the new configuration stages
   puts "[Negroku] => Writing new deploy/staging.rb"
-  erb = File.read(File.join(File.dirname(__FILE__), 'templates', 'staging.rb.erb'))
+  erb = getTemplate 'staging.rb.erb'
   File.open(stagingfile, 'w') do |f|
     f.write ERB.new(erb).result(binding)
   end
   puts "[Negroku] => Writing new deploy/production.rb"
-  erb = File.read(File.join(File.dirname(__FILE__), 'templates', 'production.rb.erb'))
+  erb = getTemplate 'production.rb.erb'
   File.open(productionfile, 'w') do |f|
     f.write ERB.new(erb).result(binding)
   end
@@ -75,6 +75,10 @@ def showConfig()
   puts config
 end
 
+def getTemplate(template)
+  File.read(File.join(File.dirname(__FILE__), 'templates', template))
+end
+
 ##
 # Helper Method that assists in loading in tasks from the tasks folder
 def load_tasks(tasks)

data/lib/negroku/version.rb

@@ -1,3 +1,3 @@
 module Negroku
-  VERSION = "1.1.4"
+  VERSION = "1.1.5"
 end

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: negroku
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 1.1.5
 platform: ruby
 authors:
 - Juan Ignacio Donoso
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-25 00:00:00.000000000 Z
+date: 2013-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 2.15.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 2.15.4
 - !ruby/object:Gem::Dependency
   name: capistrano-unicorn
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.1.9
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.1.9
 - !ruby/object:Gem::Dependency