alphonse 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eca6476d4582e41a9876f51298289244287cf23c
-  data.tar.gz: f190e28637afb81af3a5e26e0e08b4c3ec8b0a60
+  metadata.gz: 0e62eb740aaa3582c44b98cb88081880d2b62d09
+  data.tar.gz: 30ca2e601d5c3cfcc8d70570558cd8608c89c6a2
 SHA512:
-  metadata.gz: 683cb5795d84008e488f0a87e9503657422f7436c350ca370847137cc1b145cadd0e95d9cdf83fa9de03d698c4cccadf268ef95c23cef99539e45c26d126d330
-  data.tar.gz: 69fdfb30730d9ebdc52dc6d4a7d6111d43fa906fd3337a122dc89f45120de74a026de9cf31f54fedd14c3374f938966b86cd23ae0e139c00b5a0d94fa7aebae7
+  metadata.gz: 9ea7cf8ed79c288d48442bc4e60f3175fb0b770959912c4ce1349dfc6a1e4aa9fe199fe6f9d893bd40e6b389aea7af88bc488f299de3d31434156083b1a47ad9
+  data.tar.gz: e406f25c7c356fbd597df5a4530b0f5962b0c95cede53c816032b905a27cef93973f2b3f89c0eeb28a9c7253d34a793e3ceac42338ffcfee5a4554cd9f047bb9

data/README.md

@@ -1,20 +1,70 @@
 # Alphonse
 
-Deployment gem
+Deploy like the fonz with this simple deployment gem.
 
 ## Installation
 
+1. Either `gem install alphonse` or add it to your Gemfile `gem "alphonse", "~> 0.0.4"`.
+2. Navigate to the directory in which you wish to use alphonse.
+3. Run `alphonse init` - this will generate the default Fonzfile.
+4. Edit the Fonzfile to suit your app and deployment operations required.
 
 ## Usage
 
-TODO: Write usage instructions here
+Once you have finished optmising the Fonzfile with the specific operations configurations, run the operations using `alphonse [OPERATION] [OPTIONS]`:
 
+`alphonse setup`
+`alphonse deploy -e staging` (the environment will be used when running rake tasks)
+`alphonse update --verbose` (verbose will return the output of each command irrelevant of success or failure)
+
+### Task
+
+A Task is a set of simple commands that are to be run in sequence. For example, the preset :clone_repository action consists of the following commands used to clone a git repository:
+  
+  `"git checkout master -q", "git pull origin master -q", "git gc --aggressive"`
+
+### Operation
+
+An Operation is in turn a collection of Tasks which are run in sequence. For example, the present :deploy operation consists of the following Tasks which could be considered necessary for a Rails app deployment
+
+  ```ruby :install_gems, :setup_database, :restart_app```
+
+### Example Fonzfile
+
+  ```ruby
+  # Settings
+  user 'remote_user'
+  app_name 'application_name'
+  hosts 'stage.example.com'
+  path "/fullpath/to/folder"
+  git_repo 'git@gitaddress:application_name.git'
+  branch 'master'
+  ruby_bin_path '/path/to/ruby/'
+  start_command 'start_app command' 
+  restart_command 'restart_app command' # E.g. 'touch tmp/restart.txt'
+
+  operation :setup, 'Setup server' do
+    tasks :setup_directory
+  end
+
+  operation :deploy, 'Deploy repository' do
+    tasks :clone_repository, :install_gems, :setup_database, :start_app
+  end
+
+  operation :update, 'Update the repository on the server' do
+    tasks :update_repository, :install_gems, :update_database, :restart_app
+  end
+
+  operation :restart, 'Restart application' do
+    tasks :restart_app
+  end
+  ```
 
 ## Note
 
 Chances are you will experience issues with PATH variables and rubygems etc. So here's a quick solution:
 
-Log in to your deployment server, as a root user, add the following line to /etc/ssh/sshd_config:
+Log in to your server, as a root user, add the following line to /etc/ssh/sshd_config:
 
     PermitUserEnvironment yes
 

data/lib/alphonse/default/fonzfile.rb

@@ -6,13 +6,14 @@ path "/fullpath/to/folder"
 git_repo 'git@gitaddress:repository.git'
 branch 'master'
 ruby_bin_path '/path/to/ruby/'
+restart_command 'touch tmp/restart.txt'
 
 operation :setup, 'Setup server' do
   tasks :setup_directory
 end
 
 operation :deploy, 'Deploy repository' do
-  tasks :clone_repository, :install_gems, :setup_database, :restart_app
+  tasks :clone_repository, :install_gems, :setup_database, :start_app
 end
 
 operation :update, 'Update the repository on the server' do
@@ -31,4 +32,5 @@ end
   # install_gems
   # setup_database
   # update_database
+  # start_app
   # restart_app

data/lib/alphonse/version.rb

@@ -2,7 +2,7 @@ module Alphonse
   module Version
     MAJOR = 0
     MINOR = 0
-    TINY  = 4
+    TINY  = 5
     PRE   = nil
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join('.')
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: alphonse
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Simon Jones