capistrano-kyan 0.2.11 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0d3ae3b47b060f5f6d9c001e79327d546bdd0f05
-  data.tar.gz: 20916d7312a1056a983f6e1a72106b60dd89e818
+  metadata.gz: 4cd2659b32416d402c899c30ca4f9ea3dc989dc1
+  data.tar.gz: 8ff0b261d55c5d74d7a670675c237ee1318967f4
 SHA512:
-  metadata.gz: ec10f9251dfa36b3f8b70f5070dab40c0b995e486f89168b63a418536a6eec669bdd3620de67596767a6d44264211c5cb23b2ee886a1372c28b06ae90e349ddf
-  data.tar.gz: 6901ecfa52e484cdf3c5da1595ce5cbf5e0fd393c76d2ff3487752ba73a986f79f90932235be06a7a49663acb8aab38b53cb33dfb16f869df6aa06776238ac72
+  metadata.gz: 0a2a4966493eb324c4edc605840d42c50ddfce3a1a6162f5975b39795e7354b00ec6ba9ac3676ab1e54cd312d8a25f46c7068b334c3fd8f411de7e68da531b8f
+  data.tar.gz: b732e1293fdbc1f3104950d2961b6e709da0d90a15a1a71c9821d3d9f103c9aafd665c09e9a3b989a508a49a8ae5e503b42333993ff7921ac8f746d879c69c85

data/README.md

@@ -4,6 +4,10 @@ Capistrano plugin that includes a collection of tasks we find useful here at Kya
 
 ## Usage
 
+### Prerequisites
+
+We assume you are using multi-stage environments.
+
 ### Setup
 
 Add the library to your `Gemfile`:
@@ -14,36 +18,132 @@ group :development do
 end
 ```
 
-And load it into your deployment script `config/deploy.rb`:
+Update your config/deploy.rb. Here's an example one:
 
 ```ruby
 require 'capistrano-kyan'
+require 'capistrano/ext/multistage'
+
+set :stages, %w(production staging)
+set :default_stage, "staging"
+set :application, "ournewserver.co.uk"
+
+set :user, "deploy"
+set :use_sudo, false
+
+ssh_options[:forward_agent] = true
+default_run_options[:pty] = true
+
+set :scm, :git
+set :deploy_via, :copy
+set :repository, "."
+set :branch, "master"
+
+# If you are using Passenger mod_rails uncomment this:
+namespace :deploy do
+  task :start do ; end
+  task :stop do ; end
+  task :restart, :roles => :app, :except => { :no_release => true } do
+    run "#{try_sudo} touch #{File.join(current_path,'tmp','restart.txt')}"
+  end
+end
+
+# these are the capistrano-kyan bits
+after "deploy:setup",           "kyan:vhost:setup"
+after "deploy:finalize_update", "kyan:db:symlink"
+after "deploy:create_symlink",  "nginx:reload"
 ```
 
-Add kyan vhost task hook:
+Add your vhost files:
 
-```ruby
-after "deploy:setup", "kyan:vhost:setup"
+```
+#
+# /config/vhosts/staging.vhost.conf.erb
+#
+
+server {
+  listen 80;
+
+  server_name staging.ournewserver.co.uk;
+  root /var/www/staging.ournewserver.co.uk/current/public;
+  passenger_enabled on;
+  rails_env staging;
+  client_max_body_size 4M;
+
+  # serve static content directly
+  location ~* \.(ico|jpg|gif|png|swf|html)$ {
+    if (-f $request_filename) {
+      expires max;
+      break;
+    }
+  }
+}
 ```
 
-Add kyan db task hook:
+and
 
-```ruby
-after "deploy:setup", "kyan:db:setup"
+```
+#
+# /config/vhosts/production.vhost.conf.erb
+#
+
+server {
+  listen 80;
+
+  server_name ournewserver.co.uk;
+  root /var/www/ournewserver.co.uk/current/public;
+  passenger_enabled on;
+  rails_env staging;
+  client_max_body_size 4M;
+
+  # serve static content directly
+  location ~* \.(ico|jpg|gif|png|swf|html)$ {
+    if (-f $request_filename) {
+      expires max;
+      break;
+    }
+  }
+}
 ```
 
-### Test
+Now you need to update your multi-stage files to include these:
+
+```
+#
+# config/deploy/staging.rb
+#
+
+server 'ournewserver.co.uk', :app, :web, :db, :primary => true
+set :branch, "staging"
+set :rails_env, 'staging'
+set :deploy_to, "/var/www/staging.#{application}"
+set :vhost_tmpl_name, "staging.vhost.conf.erb"
+```
+
+```
+#
+# config/deploy/production.rb
+#
+
+server 'ournewserver.co.uk', :app, :web, :db, :primary => true
+set :branch, "staging"
+set :rails_env, 'staging'
+set :deploy_to, "/var/www/staging.#{application}"
+set :vhost_tmpl_name, "production.vhost.conf.erb"
+```
+
+## Deploying
+
+This will create the directory structure.
 
-First, make sure you're running the latest release:
 
 ```
-cap deploy:setup
+$ cap deploy:setup
 ```
 
 Then you can test each individual task:
 
 ```
-cap kyan:db:setup
 cap kyan:vhost:setup
 ```
 
@@ -55,16 +155,12 @@ You can modify any of the following options in your `deploy.rb` config.
 - `vhost_tmpl_path` - Set vhost template path. Default to `config/deploy`.
 - `vhost_tmpl_name` - Set vhost template name. Default to `vhost.conf.erb`.
 - `vhost_server_path` - Set vhost server path. Default to `/etc/nginx/sites-enabled`.
-- `vhost_server_name` - Set vhost server name. Default to `File.basename(deploy_to)`.
-
-I'm assuming you are using capistrano multistage.
 
 ## Available Tasks
 
 To get a list of all capistrano tasks, run `cap -T`:
 
 ```
-cap kyan:db:setup               # Creates a database.yml file in the apps shared path.
 cap kyan:vhost:setup            # Creates and symlinks an Nginx virtualhost entry.
 ```
 

data/capistrano-kyan.gemspec

@@ -12,14 +12,14 @@ Gem::Specification.new do |gem|
   gem.description   = %q{Capistrano tasks for database.yml and vhost creation}
   gem.summary       = %q{A bunch of useful Capistrano tasks}
   gem.homepage      = "http://github.com/kyan/capistrano-kyan"
+  gem.licenses      = ['MIT']
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
+  gem.add_development_dependency 'rake', '~> 0'
 
-  gem.add_development_dependency 'rake'
-
-  gem.add_runtime_dependency 'capistrano', '~> 2.14.1'
+  gem.add_runtime_dependency 'capistrano',  '~> 2.14', '>= 2.14.1'
 end

data/lib/capistrano-kyan/capistrano_integration.rb

@@ -6,7 +6,6 @@ module CapistranoKyan
     TASKS = [
       'deploy:seed',
       'deploy:add_env',
-      'kyan:db:setup',
       'kyan:vhost:setup',
       'kyan:vhost:show',
       'nginx:start',
@@ -142,39 +141,6 @@ module CapistranoKyan
           # database.yml cap tasks
           #
           namespace :db do
-            desc <<-DESC
-              Creates a database.yml file in the apps shared path.
-            DESC
-            task :setup, :except => { :no_release => true } do
-
-              require 'digest/sha1'
-              app = appize(application, fetch(:stage))
-              database = fetch(:db_database, app)
-              username = fetch(:db_username, app)
-              password = Capistrano::CLI.ui.ask("DB password for #{database} (empty for default): ")
-              password = password.empty? ? Digest::SHA1.hexdigest(database) : password
-
-              default_template = <<-EOF
-      base: &base
-        encoding: utf8
-        adapter: postgresql
-        pool: <%= fetch(:db_pool, 5) %>
-        host: <%= fetch(:db_host, 'localhost') %>
-      <%= fetch(:stage) %>:
-        database: <%= database %>
-        username: <%= username %>
-        password: <%= password %>
-        <<: *base
-              EOF
-
-              location = fetch(:template_dir, "config/deploy") + '/database.yml.erb'
-              template = File.file?(location) ? File.read(location) : default_template
-              config = ERB.new(template, nil , '-')
-
-              run "mkdir -p #{shared_path}/config"
-              put config.result(binding), "#{shared_path}/config/database.yml"
-            end
-
             #
             # Updates the symlink for database.yml file to the just deployed release.
             #

data/lib/capistrano-kyan/version.rb

@@ -1,3 +1,3 @@
 module CapistranoKyan
-  VERSION = "0.2.11"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,41 +1,47 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-kyan
 version: !ruby/object:Gem::Version
-  version: 0.2.11
+  version: 0.3.0
 platform: ruby
 authors:
 - Duncan Robertson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-11 00:00:00.000000000 Z
+date: 2014-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: capistrano
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.14.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.14.1
 description: Capistrano tasks for database.yml and vhost creation
@@ -45,7 +51,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -56,7 +62,8 @@ files:
 - lib/capistrano-kyan/version.rb
 - templates/vhost.conf.erb
 homepage: http://github.com/kyan/capistrano-kyan
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -64,17 +71,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A bunch of useful Capistrano tasks