whiskey_disk 0.0.1 → 0.0.2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009, Flawed Logic, OG Consulting, Rick Bradley.
+
+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.

data/README

@@ -1,5 +1,75 @@
 Whiskey Disk -- embarrassingly fast deployments.
 
+  A very opinionated deployment tool, designed to be as fast as technologically
+  possible.
+
+  Should work with any project which is git hosted, not just Ruby / Ruby on Rails projects.
+  Allows for local deploys as well as remote.
+
+  Dependencies:  rake, ssh, git, rsync on the deployment target server (affectionately
+                 referred to as the "g-node" by vinbarnes), bash-ish shell on deployment
+                 server.
+
+  Assumptions:
+
+    - you have a Rakefile in the top directory of your project's checkout
+    - you are deploying over ssh
+    - your project is managed via git
+    - you have a second git repository for per-application/per-environment configuration files
+    - you are comfortable defining post-setup and post-deployment actions with rake
+
+  Installation:
+
+    As a gem:
+
+    % gem install whiskey_disk
+
+    As a rails plugin:
+
+    % script/plugin install git://github.com/flogic/whiskey_disk.git
+
+  Configuration:
+
+    - look in the examples/ directory for sample configuration files
+    - main configuration is in <app_root>/config/deploy.yml
+    - per-environment configurations can be stored in <app_root>/config/deploy-<environment>.yml
+    - config files are YAML, with a section for each environment.
+
+      Known config file settings (if you're familiar with capistrano and vlad these
+      should seem eerily familiar)::
+ 
+      - domain:            host on which to deploy (this is an ssh connect string) 
+      - deploy_to:         path to which to deploy main application
+      - repository:        git repo path for main application
+      - branch:            git branch to deploy from main application git repo
+      - deploy_config_to:  where to deploy the configuration repository
+      - config_repository: git repository for configuration files
+      - project:           project name (used to compute path in configuration checkout)
+
+    - defining a deploy:<environment>:post_setup rake task (e.g., in lib/tasks/ or in 
+      your project's Rakefile) will cause that task to be run at the end of deploy:setup
+
+    - defining a deploy:<environment>:post_deploy rake task (e.g., in lib/tasks/ or in 
+      your project's Rakefile) will cause that task to be run at the end of deploy:now
+
+  Running:
+
+  - rake deploy:setup to=<environment>   (e.g., "staging", "production", etc.)
+  - rake deploy:now   to=<environment>
+
+
+  Resources:
+    - http://github.com/blog/470-deployment-script-spring-cleaning
+    - http://github.com/mislav/git-deploy
+    - http://toroid.org/ams/git-website-howto
+  
+-----
+
+
+NOTES (aka the original README):
+
+
+
 The idea here is inspired by github's cleaned up deployment scripts, and mislav's git-deploy project.  Only, we gave up on capistrano a long time ago, and after a few years of doing deployments on a few dozen projects, we realized that we really have very little variation on how we do things.  That is, we can afford to have a very opinionated tool to do our deployments.
 
 Here are the features/constraints we're envisioning:
@@ -41,11 +111,3 @@ Here are the features/constraints we're envisioning:
  - build this spec-first (whenever possible) so that there's a useful test suite.
  
  - M$ windows hasn't been a priority for me for over a decade, not starting now.
-
----
-
-Resources:
-  - http://github.com/blog/470-deployment-script-spring-cleaning
-  - http://github.com/mislav/git-deploy
-  - http://toroid.org/ams/git-website-howto
-  

data/TODO.txt

@@ -1,2 +1,16 @@
- - update the README
+ - common post-deploy tasks (including db:migrate, server bounce)
+   - some sort of simple API for hooks to check which files have changed (either via git rev differences or rsync output), so then the rake task would just do something like:
+   
+   require 'whiskey_disk/rake'
+   
+   namespace :deploy do
+     task :post_deploy do 
+       if changed_in?('db/migrate') or changed?('config/database.yml')
+         Rake::Task['db:migrate'].invoke
+       end
+       # etc. ...
+     end
+   end
+   
  - install hooks (look at maybe git-deploy for good examples)
+ - make sure the config repo stuff is optional

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/lib/whiskey_disk.rb

@@ -106,13 +106,13 @@ class WhiskeyDisk
     def run_post_setup_hooks
       needs(:deploy_to)
       enqueue "cd #{self[:deploy_to]}"
-      enqueue "rake --trace deploy:post_setup"
+      enqueue "rake --trace deploy:post_setup to=#{self[:environment]}"
     end
 
     def run_post_deploy_hooks
       needs(:deploy_to)
       enqueue "cd #{self[:deploy_to]}"
-      enqueue "rake --trace deploy:post_deploy"
+      enqueue "rake --trace deploy:post_deploy to=#{self[:environment]}"
     end
   end
 end

data/spec/whiskey_disk_spec.rb

@@ -272,6 +272,11 @@ describe 'WhiskeyDisk' do
       WhiskeyDisk.run_post_setup_hooks
       WhiskeyDisk.buffer.join(' ').should.match(%r{rake.*deploy:post_setup})
     end
+    
+    it 'should use the same environment when running the rake tasks' do
+      WhiskeyDisk.run_post_setup_hooks
+      WhiskeyDisk.buffer.join(' ').should.match(%r{to=#{@env}})      
+    end
   end
   
   describe 'running post deployment hooks' do
@@ -296,6 +301,11 @@ describe 'WhiskeyDisk' do
       WhiskeyDisk.run_post_deploy_hooks
       WhiskeyDisk.buffer.join(' ').should.match(%r{rake.*deploy:post_deploy})
     end
+    
+    it 'should use the same environment when running the rake tasks' do
+      WhiskeyDisk.run_post_deploy_hooks
+      WhiskeyDisk.buffer.join(' ').should.match(%r{to=#{@env}})      
+    end
   end
   
   describe 'flushing changes' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: whiskey_disk
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Rick Bradley
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-30 00:00:00 +05:30
+date: 2009-12-31 00:00:00 +05:30
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,6 +32,7 @@ extra_rdoc_files:
 - README
 files: 
 - .gitignore
+- MIT-LICENSE
 - README
 - Rakefile
 - TODO.txt