mina 0.3.8 → 1.0.0.beta1

data/bin/mina

@@ -1,65 +1,4 @@
 #!/usr/bin/env ruby
-$:.unshift File.expand_path('../../lib', __FILE__)
-
-require 'rubygems' unless Object.const_defined?(:Gem)
 require 'mina'
-require 'rake'
-
-# Intercept: if invoked as 'mina --help', don't let it pass through Rake, or else
-# we'll see the Rake help screen. Redirect it to 'mina help'.
-if ARGV.delete('--help') || ARGV.delete('-h')
-  ARGV << 'help'
-end
-
-if ARGV.delete('--version') || ARGV.delete('-V')
-  puts "Mina, version v#{Mina.version}"
-  exit
-end
-
-if ARGV.delete('--simulate') || ARGV.delete('-S')
-  ENV['simulate'] = '1'
-end
-
-scope = self
-
-Rake.application.instance_eval do
-  standard_exception_handling do
-    begin
-      # Initialize Rake and make it think it's Mina.
-      init 'mina'
-
-      # (The only way @rakefiles has only 1 value is if -f is specified.)
-      custom_rakefile = (@rakefiles.size == 1)
-      @rakefiles = ['Minafile', 'config/deploy.rb']  unless custom_rakefile
-
-      # Workaround: Rake 0.9+ doesn't record task descriptions unless it's needed.
-      # Need it for 'mina help'
-      if Rake::TaskManager.respond_to?(:record_task_metadata)
-        Rake::TaskManager.record_task_metadata = true
-      end
-
-      # Load the Mina Rake DSL.
-      require 'mina/rake'
-
-      # Allow running without a Rakefile
-      begin
-        load_rakefile  if have_rakefile || custom_rakefile
-      rescue Exception
-        puts "Error loading Rakefile!"
-        raise "There may be a problem with config/deploy.rb and/or Rakefile"
-      end
-
-      # Run tasks
-      top_level
-
-      scope.mina_cleanup! if top_level_tasks.any?
-
-    rescue Mina::Failed => e
-      puts ""
-      scope.print_error "Command failed."
-      scope.print_stderr "#{e.message}"
-      exit(e.exitstatus > 255 ? e.exitstatus >> 8 : e.exitstatus)
-    end
-  end
-end
 
+Mina::Application.new.run

data/data/deploy.rb

@@ -1,8 +1,8 @@
 require 'mina/bundler'
 require 'mina/rails'
 require 'mina/git'
-# require 'mina/rbenv'  # for rbenv support. (http://rbenv.org)
-# require 'mina/rvm'    # for rvm support. (http://rvm.io)
+# require 'mina/rbenv'  # for rbenv support. (https://rbenv.org)
+# require 'mina/rvm'    # for rvm support. (https://rvm.io)
 
 # Basic settings:
 #   domain       - The hostname to SSH to.
@@ -15,18 +15,15 @@ set :deploy_to, '/var/www/foobar.com'
 set :repository, 'git://...'
 set :branch, 'master'
 
-# For system-wide RVM install.
-#   set :rvm_path, '/usr/local/rvm/bin/rvm'
-
-# Manually create these paths in shared/ (eg: shared/config/database.yml) in your server.
-# They will be linked in the 'deploy:link_shared_paths' step.
-set :shared_paths, ['config/database.yml', 'config/secrets.yml', 'log']
-
 # Optional settings:
-#   set :user, 'foobar'    # Username in the server to SSH to.
-#   set :port, '30000'     # SSH port number.
+#   set :user, 'foobar'          # Username in the server to SSH to.
+#   set :port, '30000'           # SSH port number.
 #   set :forward_agent, true     # SSH forward_agent.
 
+# They will be linked in the 'deploy:link_shared_paths' step.
+# set :shared_dirs, -> { fetch(:shared_dirs, []).push('config') }
+# set :shared_files, -> { fetch(:shared_files, []).push('config/database.yml', 'config/secrets.yml') }
+
 # This task is the environment that is loaded for most commands, such as
 # `mina deploy` or `mina rake`.
 task :environment do
@@ -38,37 +35,14 @@ task :environment do
   # invoke :'rvm:use[ruby-1.9.3-p125@default]'
 end
 
-# Put any custom mkdir's in here for when `mina setup` is ran.
-# For Rails apps, we'll make some of the shared paths that are shared between
-# all releases.
-task :setup => :environment do
-  queue! %[mkdir -p "#{deploy_to}/#{shared_path}/log"]
-  queue! %[chmod g+rx,u+rwx "#{deploy_to}/#{shared_path}/log"]
-
-  queue! %[mkdir -p "#{deploy_to}/#{shared_path}/config"]
-  queue! %[chmod g+rx,u+rwx "#{deploy_to}/#{shared_path}/config"]
-
-  queue! %[touch "#{deploy_to}/#{shared_path}/config/database.yml"]
-  queue! %[touch "#{deploy_to}/#{shared_path}/config/secrets.yml"]
-  queue  %[echo "-----> Be sure to edit '#{deploy_to}/#{shared_path}/config/database.yml' and 'secrets.yml'."]
-
-  if repository
-    repo_host = repository.split(%r{@|://}).last.split(%r{:|\/}).first
-    repo_port = /:([0-9]+)/.match(repository) && /:([0-9]+)/.match(repository)[1] || '22'
-
-    queue %[
-      if ! ssh-keygen -H  -F #{repo_host} &>/dev/null; then
-        ssh-keyscan -t rsa -p #{repo_port} -H #{repo_host} >> ~/.ssh/known_hosts
-      fi
-    ]
-  end
+# Put any custom commands you need to run at setup
+# All paths in `shared_dirs` and `shared_paths` will be created on their own.
+task setup: :environment do
+  # command 'rbenv install 2.3.0'
 end
 
 desc "Deploys the current version to the server."
-task :deploy => :environment do
-  to :before_hook do
-    # Put things to run locally before ssh
-  end
+task deploy: :environment do
   deploy do
     # Put things that will set up an empty directory into a fully set-up
     # instance of your project.
@@ -79,16 +53,15 @@ task :deploy => :environment do
     invoke :'rails:assets_precompile'
     invoke :'deploy:cleanup'
 
-    to :launch do
-      queue "mkdir -p #{deploy_to}/#{current_path}/tmp/"
-      queue "touch #{deploy_to}/#{current_path}/tmp/restart.txt"
+    on :launch do
+      in_path(fetch(:current_path)) do
+        command "mkdir -p tmp/"
+        command "touch tmp/restart.txt"
+      end
     end
   end
 end
 
 # For help in making your deploy script, see the Mina documentation:
 #
-#  - http://nadarei.co/mina
-#  - http://nadarei.co/mina/tasks
-#  - http://nadarei.co/mina/settings
-#  - http://nadarei.co/mina/helpers
+#  - https://github.com/mina-deploy/mina/docs

data/data/deploy.sh.erb

@@ -1,40 +1,40 @@
 <%
-  prepare = commands(:default).map { |s| "(\n\n#{indent 2, s}\n\n)" }.join(" && ")
-  build   = commands(:build).map   { |s| "(\n\n#{indent 2, s}\n\n)" }.join(" && ")
-  launch  = commands(:launch).map  { |s| "(\n\n#{indent 2, s}\n\n)" }.join(" && ")
-  clean   = commands(:clean).map   { |s| "(\n\n#{indent 2, s}\n\n)" }.join(" && ")
+  default = commands.fetch(:default).map { |s| indent 2, s }.join(" &&\n")
+  build   = commands.fetch(:build).map   { |s| indent 2, s }.join(" &&\n")
+  launch  = commands.fetch(:launch).map  { |s| indent 2, s }.join(" &&\n")
+  clean   = commands.fetch(:clean).map   { |s| indent 2, s }.join(" &&\n")
 %>
 #!/usr/bin/env bash
 
 # Go to the deploy path
-cd "<%= deploy_to %>" || (
+cd "<%= fetch(:deploy_to) %>" || (
   echo "! ERROR: not set up."
-  echo "The path '<%= deploy_to %>' is not accessible on the server."
+  echo "The path '<%= fetch(:deploy_to) %>' is not accessible on the server."
   echo "You may need to run 'mina setup' first."
   false
 ) || exit 15
 
 # Check releases path
-if [ ! -d "<%= releases_path %>" ]; then
+if [ ! -d "<%= fetch(:releases_path) %>" ]; then
   echo "! ERROR: not set up."
-  echo "The directory '<%= releases_path %>' does not exist on the server."
+  echo "The directory '<%= fetch(:releases_path) %>' does not exist on the server."
   echo "You may need to run 'mina setup' first."
   exit 16
 fi
 
 # Check lockfile
-if [ -e "<%= lock_file %>" ]; then
+if [ -e "<%= fetch(:lock_file) %>" ]; then
   echo "! ERROR: another deployment is ongoing."
-  echo "The file '<%= lock_file %>' was found."
+  echo "The file '<%= fetch(:lock_file) %>' was found."
   echo "If no other deployment is ongoing, run 'mina deploy:force_unlock' to delete the file."
   exit 17
 fi
 
 # Determine $previous_path and other variables
-[ -h "<%= current_path %>" ] && [ -d "<%= current_path %>" ] && previous_path=$(cd "<%= current_path %>" >/dev/null && pwd -LP)
+[ -h "<%= fetch(:current_path) %>" ] && [ -d "<%= fetch(:current_path) %>" ] && previous_path=$(cd "<%= fetch(:current_path) %>" >/dev/null && pwd -LP)
 build_path="./tmp/build-`date +%s`$RANDOM"
-version=$((`cat "<%= deploy_to %>/last_version" 2>/dev/null`+1))
-release_path="<%= releases_path %>/$version"
+version=$((`cat "<%= fetch(:deploy_to) %>/last_version" 2>/dev/null`+1))
+release_path="<%= fetch(:releases_path) %>/$version"
 
 # Sanity check
 if [ -e "$build_path" ]; then
@@ -45,11 +45,11 @@ fi
 # Bootstrap script (in deployer)
 (
   echo "-----> Creating a temporary build path"
-  <%= echo_cmd %[touch "#{lock_file}"] %> &&
+  <%= echo_cmd %[touch "#{fetch(:lock_file)}"] %> &&
   <%= echo_cmd %[mkdir -p "$build_path"] %> &&
   <%= echo_cmd %[cd "$build_path"] %> &&
   (
-<%= indent 4, (prepare.empty? ? "true" : prepare) %>
+<%= indent 2, (default.empty? ? "true" : default) %>
   ) &&
   echo "-----> Deploy finished"
 ) &&
@@ -62,7 +62,7 @@ fi
   <%= echo_cmd %[mv "$build_path" "$release_path"] %> &&
   <%= echo_cmd %[cd "$release_path"] %> &&
   (
-<%= indent 4, (build.empty? ? "true" : build) %>
+<%= indent 2, (build.empty? ? "true" : build) %>
   ) &&
   echo "-----> Build finished"
 
@@ -73,22 +73,21 @@ fi
 # Rename to the real release path, then symlink 'current'
 (
   echo "-----> Launching"
-  echo "-----> Updating the <%= current_path %> symlink" &&
-  <%= echo_cmd %[ln -nfs "$release_path" "#{current_path}"] %>
+  echo "-----> Updating the <%= fetch(:current_path) %> symlink" &&
+  <%= echo_cmd %[ln -nfs "$release_path" "#{fetch(:current_path)}"] %>
 ) &&
 
 # ============================
 # === Start up server => (in deployer)
 (
-  echo "-----> Launching"
-  <%= echo_cmd %[cd "#{current_path}"] %>
+  <%= echo_cmd %[cd "#{fetch(:current_path)}"] %>
 <%= indent 2, (launch.empty? ? "true" : launch) %>
 ) &&
 
 # ============================
 # === Complete & unlock
 (
-  rm -f "<%= lock_file %>"
+  rm -f "<%= fetch(:lock_file) %>"
   echo "$version" > "./last_version"
   echo "-----> Done. Deployed v$version"
 ) ||
@@ -110,11 +109,11 @@ fi
   )
   (
     echo "Unlinking current"
-    [ -n "$previous_path" ] && <%= echo_cmd %[ln -nfs "$previous_path" "#{current_path}"] %>
+    [ -n "$previous_path" ] && <%= echo_cmd %[ln -nfs "$previous_path" "#{fetch(:current_path)}"] %>
   )
 
   # Unlock
-  <%= echo_cmd %[rm -f "#{lock_file}"] %>
+  <%= echo_cmd %[rm -f "#{fetch(:lock_file)}"] %>
   echo "OK"
   exit 19
 )

data/docs/Readme.md

@@ -0,0 +1,8 @@
+# Mina Documentations
+
+* [Getting started](getting_started.md)
+* [Migrating from 0.3.x to 1.0](migrating.md)
+* [Deploying](deploying.md)
+* [Writing your own tasks](writing_your_own_tasks.md)
+* [Command line options](command_line_options.md)
+* [FAQ](faq.md)

data/docs/command_line_options.md

@@ -0,0 +1,33 @@
+Command line options
+--------------------
+
+Basic usage:
+
+    $ mina [OPTIONS] [TASKS] [VAR1=val VAR2=val ...]
+
+### Options
+
+Beside normal rake options mina added some of its own:
+
+* `-v` / `--verbose` - This will show commands being done on the server. Off by
+  default.
+
+* `-s` / `--simulate` - This will not run any commands; instead, it will simply output the script it builds.
+
+* `-V` / `--version` - Shows the current version.
+
+* `-d` / `--debug-configuration-variables` - Display the defined config variables before runnig the tasks.
+
+### Tasks
+
+There are many tasks available. See the [tasks reference](http://mina-deploy.github.io/mina/tasks/), or
+type `mina -T`.
+
+### Variables
+
+You may specify additional variables in the `KEY=value` style, just like any other command line tools.
+You can add as many variables as needed.
+
+    $ mina restart on=staging
+
+    # This sets the ENV['on'] variable to 'staging'.

data/docs/deploying.md

@@ -0,0 +1,97 @@
+Deploying
+--------------------
+
+Mina provides the `deploy` command which runs your commands on remote backend.
+
+``` ruby
+# config/deploy.rb
+set :domain, 'flipstack.com'
+set :user, 'flipstack'
+set :deploy_to, '/var/www/flipstack.com'
+set :repository, 'http://github.com/flipstack/flipstack.git'
+
+task :deploy do
+  deploy do
+    # Put things that prepare the empty release folder here.
+    # Commands queued here will be run on a new release directory.
+    invoke :'git:clone'
+    invoke :'bundle:install'
+
+    # These are instructions to start the app after it's been prepared.
+    to :launch do
+      queue 'touch tmp/restart.txt'
+    end
+
+    # This optional block defines how a broken release should be cleaned up.
+    to :clean do
+      queue 'log "failed deployment"'
+    end
+  end
+end
+```
+
+It works by capturing the *queue*d commands inside the block, wrapping them
+in a deploy script, then *queue*ing them back in.
+
+### How deploying works
+
+Here is an example of a deploy! (Note that some commands have been simplified
+to illustrate the point better.)
+
+### Step 1: Build it
+
+The deploy process builds a new temp folder with instructions you provide.
+In this example, it will do `git:clone` and `bundle:install`.
+
+    $ mina deploy --verbose
+    -----> Creating the build path
+           $ mkdir tmp/build-128293482394
+    -----> Cloning the Git repository
+           $ git clone https://github.com/flipstack/flipstack.git . -n --recursive
+           Cloning... done.
+    -----> Installing gem dependencies using Bundler
+           $ bundle install --without development:test
+           Using i18n (0.6.0)
+           Using multi_json (1.0.4)
+           ...
+           Your bundle is complete! It was installed to ./vendor/bundle
+
+### Step 2: Move it to releases
+
+Once the project has been built, it will be moved to `releases/`. A symlink
+called `current/` will be created to point to the active release.
+
+    $
+    -----> Moving to releases/4
+           $ mv "./tmp/build-128293482394" "releases/4"
+    -----> Symlinking to current
+           $ ln -nfs releases/4 current
+
+### Step 3: Launch it
+
+Invoke the commands queued up in the `to :launch` block. These often
+commands to restart the webserver process. Once this in complete, you're done!
+
+    $
+    -----> Launching
+           $ cd releases/4
+           $ sudo service nginx restart
+    -----> Done. Deployed v4
+
+### What about failure?
+
+If it fails at any point, the release path will be deleted. If any commands are
+queued using the `to :clean` block, they will be run. It will be as if nothing
+happened. Lets see what happens if a build fails:
+
+    $
+    -----> Launching
+           $ cd releases/4
+           $ sudo service nginx restart
+           Starting nginx... error: can't start service
+    -----> ERROR: Deploy failed.
+    -----> Cleaning up build
+           $ rm -rf tmp/build-128293482394
+    -----> Unlinking current
+           $ ln -nfs releases/3 current
+           OK

data/docs/faq.md

@@ -0,0 +1 @@
+# WIP

data/docs/getting_started.md

@@ -0,0 +1,44 @@
+Setting up a project
+--------------------
+
+Let's deploy a project using Mina.
+
+### Step 1: Create a config/deploy.rb
+
+In your project, type `mina init` to create a sample of this file.
+
+    $ mina init
+    Created config/deploy.rb.
+
+This is just a Rake file with tasks! See [How to write your own tasks](writing_your_own_tasks.md) for
+more info on what *deploy.rb* is. You will want to at least configure your
+server:
+
+``` ruby
+# config/deploy.rb
+set :user, 'username'
+set :domain, 'your.server.com'
+set :deploy_to, '/var/www/flipstack.com'
+...
+```
+
+### Step 2: Run 'mina setup'
+
+Back at your computer, do `mina setup` to set up the folder structure in `deploy_to` path.
+This will connect to your server via SSH and create the right directories.
+
+    $ mina setup
+    -----> Creating folders... done.
+
+See [directory structure](https://github.com/mina-deploy/mina/wiki/Directory-structure) for more info.
+
+### Step 3: Deploy!
+
+Use `mina deploy` to run the `deploy` task defined in *config/deploy.rb*.
+
+    $ mina deploy
+    -----> Deploying to 2012-06-12-040248
+           ...
+           Lots of things happening...
+           ...
+    -----> Done.