middleman-deploy 0.1.0 → 0.1.1

data/Gemfile

@@ -10,6 +10,7 @@ group :development do
 end
 
 group :test do
+  gem "compass"
   gem "cucumber"
   gem "fivemat"
   gem "aruba"

data/README.md

@@ -1,149 +1,124 @@
-Middleman Deploy - Deploy a [middleman](http://middlemanapp.com/)
-built site over rsync, ftp, sftp, or git (e.g. gh-pages on github).
+# middleman-deploy [![Build Status](https://travis-ci.org/tvaughan/middleman-deploy.png?branch=master)](https://travis-ci.org/tvaughan/middleman-deploy)
 
-[![Build Status](https://secure.travis-ci.org/tvaughan/middleman-deploy.png)](http://travis-ci.org/tvaughan/middleman-deploy)
+Deploys a [middleman](http://middlemanapp.com/) built site via **rsync**,
+**ftp**, **sftp**, or **git** (e.g. gh-pages on github).
 
-# QUICK START
+## Installation
 
-## Step 1
+Add this to the Gemfile of the repository of your middleman site:
 
-    middleman init example-site
-    cd example-site
+```ruby
+gem "middleman-deploy"
+```
+
+and run `bundle install`.
 
-## Step 2
+## Usage
 
-Edit `Gemfile`, and add:
+```
+$ middleman build [--clean]
+$ middleman deploy [--build-before]
+```
 
-    gem "middleman-deploy", ">= 0.1.0"
+To automatically run `middleman build` during `middleman deploy`, turn on the
+`build_before` option while activating the deploy extension:
 
-Then run:
+```ruby
+activate :deploy do |deploy|
+  # ...
+  deploy.build_before = true # default: false
+end
+```
 
-    bundle install
+## Possible Configurations
 
-## Step 3a - Rsync setup
+Middleman-deploy can deploy a site via rsync, ftp, sftp, or git.
 
-First be sure that `rsync` is installed.
+### rsync
 
-**These settings are required.**
+Make sure that `rsync` is installed, and activate the extension by adding the
+following to `config.rb`:
 
-Edit `config.rb`, and add:
+```ruby
+activate :deploy do |deploy|
+  deploy.method = :rsync
+  deploy.user   = "tvaughan"
+  deploy.host   = "www.example.com"
+  deploy.path   = "/srv/www/site"
+  # Optional Settings
+  # deploy.port  = 5309 # ssh port, default: 22
+  # deploy.clean = true # remove orphaned files on remote host, default: false
+end
+```
 
-    activate :deploy do |deploy|
-      deploy.method = :rsync
-      deploy.user = "tvaughan"
-      deploy.host = "www.example.com"
-      deploy.path = "/srv/www/site"
-    end
+### Git (e.g. GitHub Pages)
 
-Adjust these values accordingly.
+Make sure that `git` is installed, and activate the extension by adding the
+following to `config.rb`:
 
-**These settings are optional.**
+```ruby
+activate :deploy do |deploy|
+  deploy.method = :git
+  # Optional Settings
+  # deploy.remote = "custom-remote" # remote name or git url, default: origin
+  # deploy.branch = "custom-branch" # default: gh-pages
+end
+```
 
-To use a particular SSH port, add:
+If you use a remote name, you must first add it using `git remote add`. Run
+`git remote -v` to see a list of possible remote names. If you use a git url,
+it must end with '.git'.
 
-      deploy.port = 5309
+Afterwards, the `build` directory will become a git repo. This branch will be
+created on the remote if it doesn't already exist.
 
-Default is `22`.
+### FTP
 
-To remove orphaned files or directories on the remote host, add:
+Activate the extension by adding the following to `config.rb`:
 
-      deploy.clean = true
+```ruby
+activate :deploy do |deploy|
+  deploy.method   = :ftp
+  deploy.host     = "ftp.example.com"
+  deploy.user     = "tvaughan"
+  deploy.password = "secret"
+  deploy.path     = "/srv/www/site"
+end
+```
 
-Default is `false`.
+### SFTP
 
-## Step 3b - Git setup
+Activate the extension by adding the following to `config.rb`:
 
-First be sure that `git` is installed.
+```ruby
+activate :deploy do |deploy|
+  deploy.method   = :sftp
+  deploy.host     = "sftp.example.com"
+  deploy.user     = "tvaughan"
+  deploy.password = "secret"
+  deploy.path     = "/srv/www/site"
+end
+```
 
-**These settings are required.**
+## Breaking Changes
 
-Edit `config.rb`, and add:
-
-    activate :deploy do |deploy|
-      deploy.method = :git
-    end
-
-By default this will deploy to the `gh-pages` branch on the `origin`
-remote. The `build` directory will become a git repo.
-
-**These settings are optional.**
-
-To use a particular remote, add:
-
-      deploy.remote = "some-other-remote-name"
-
-Default is `origin`. This can be a remote name or a git url.
-
-If you use a remote name, you must first add it using `git remote
-add`. Run `git remote -v` to see a list of possible remote names. If
-you use a git url, it must end with '.git'.
-
-To use a particular branch, add:
-
-      deploy.branch = "some-other-branch-name"
-
-Default is `gh-pages`. This branch will be created on the remote if it
-doesn't already exist.
-
-## Step 3c - FTP setup
-
-**These settings are required.**
-
-Edit `config.rb`, and add:
-
-    activate :deploy do |deploy|
-      deploy.method = :ftp
-      deploy.host = "ftp.example.com"
-      deploy.user = "tvaughan"
-      deploy.password = "secret"
-      deploy.path = "/srv/www/site"
-    end
-
-Adjust these values accordingly.
-
-## Step 3d - SFTP setup
-
-**These settings are required.**
-
-Edit `config.rb`, and add:
-
-    activate :deploy do |deploy|
-      deploy.method = :sftp
-      deploy.host = "sftp.example.com"
-      deploy.user = "tvaughan"
-      deploy.password = "secret"
-      deploy.path = "/srv/www/site"
-    end
-
-Adjust these values accordingly.
-
-## Step 4
-
-    middleman build [--clean]
-    middleman deploy [--build-before]
-
-To run `middleman build` before `middleman deploy`, add:
-
-    deploy.build_before = true
-
-Default is `false`.
-
-## BREAKING CHANGES
-
- * v0.1.0
-
-   * Removed the `--clean` command-line option. This option only applied
-   to the rsync deploy method. The idea going forward is that
-   command-line options must apply to all deploy methods. Options that
-   are specific to a deploy method will only be available in
-   `config.rb`.
-
-   * Removed `deploy` from the `after_build` hook. This caused a
-   `deploy` to be run each time `build` was called. This workflow never
-   made sense. `deploy` was added to the `after_build` hook simply
-   because it was available.
-
-## NOTES
+* `v0.1.0`
+    - Removed the `--clean` command-line option. This option only applied to
+      the rsync deploy method. The idea going forward is that command-line
+      options must apply to all deploy methods. Options that are specific to a
+      deploy method will only be available in `config.rb`.
+    - Removed `deploy` from the `after_build` hook. This caused a `deploy` to
+      be run each time `build` was called. This workflow never made
+      sense. `deploy` was added to the `after_build` hook simply because it
+      was available.
+
+## Thanks!
+
+A **BIG** thanks to
+[everyone who has contributed](https://github.com/tvaughan/middleman-deploy/graphs/contributors)!
+Almost all pull requests are accepted.
+
+## Other
 
 Inspired by the rsync task in
 [Octopress](https://github.com/imathis/octopress).

data/lib/middleman-deploy/commands.rb

@@ -36,8 +36,7 @@ module Middleman
         end
         if build_before
           # http://forum.middlemanapp.com/t/problem-with-the-build-task-in-an-extension
-          builder = ::Middleman::Cli::Build.new(args=[], options={:instrument=>false})
-          builder.build
+          run("middleman build") || exit(1)
         end
         send("deploy_#{self.deploy_options.method}")
       end

data/lib/middleman-deploy/pkg-info.rb

@@ -1,7 +1,7 @@
 module Middleman
   module Deploy
     PACKAGE = "middleman-deploy"
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
     TAGLINE = "Deploy a middleman built site over rsync, ftp, sftp, or git (e.g. gh-pages on github)."
   end
 end

data/middleman-deploy.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Tom Vaughan"]
   s.email       = ["thomas.david.vaughan@gmail.com"]
-  s.homepage    = "http://tvaughan.github.com/middleman-deploy/"
+  s.homepage    = "http://tvaughan.github.io/middleman-deploy/"
   s.summary     = Middleman::Deploy::TAGLINE
   s.description = Middleman::Deploy::TAGLINE
   s.license     = "MIT"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: middleman-deploy
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-17 00:00:00.000000000 Z
+date: 2013-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman-core
@@ -72,7 +72,6 @@ files:
 - Gemfile
 - README.md
 - Rakefile
-- THANKS
 - features/support/env.rb
 - lib/middleman-deploy.rb
 - lib/middleman-deploy/commands.rb
@@ -80,7 +79,7 @@ files:
 - lib/middleman-deploy/pkg-info.rb
 - lib/middleman_extension.rb
 - middleman-deploy.gemspec
-homepage: http://tvaughan.github.com/middleman-deploy/
+homepage: http://tvaughan.github.io/middleman-deploy/
 licenses:
 - MIT
 post_install_message: 
@@ -93,12 +92,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 1810602657871223633
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 1810602657871223633
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23

data/THANKS

@@ -1,4 +0,0 @@
-Ben Cates - Git deploy method.
-Gilbert Townshend - Bug reports and feature requests.
-Konstantin Gribov -- Git deploy method improvements.
-Benjamin Knofe -- FTP deploy method and Git improvements.