octopress-deploy 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2af5039aee38f546a01d3f4433517c162deb1153
-  data.tar.gz: e2bd066149b99dbc4f85b2552e946e15413eb3a4
+  metadata.gz: b30fec5fea505bb7a246e1d0bc5e0c739343b504
+  data.tar.gz: 61f1c39b6c169843e4fe19c1451247ad8af88709
 SHA512:
-  metadata.gz: 5e4ba7fafe0ddc43969a6f4266bef6c245774f3593000f7ec94877ff9a3e19416109df3ddf5166ba14a8611656799176d317eb955f2e7f03dfb3350634a502a5
-  data.tar.gz: 2449bab2c6e132dded9f82f6c98284f43840f0b3d28053a10b57d3252893cbc88feb57e45d8178e3e03b44ac353ccf7a796a27705868e3e7819bf8cf4f771a6d
+  metadata.gz: 528045680665befb6071813aff95d2b531da8167f1fee9799a3422c3d52befacbc94343b91c8a651a57415a78a40d833fd7dbb2dc3eb45064f3967f2609959a8
+  data.tar.gz: d659d156bac37ae764b2dfa9e7191d717f0d6aa2e49f6db08e494bad4bd582ed57007006feaa3cd90dab09d261f18e50faf009f42fdff736c1298744491e72f4

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Octopress Deploy Changelog
 
+### 1.0.3 - 2015-01-04
+
+- On add-bucket, added <NAME> as an optional argument instead of an option flag
+- Added --force option to pull
+- Minor documentation improvements
+
 ### 1.0.2 - 2015-01-02
 
 - Updated Octopress docs integration.

data/README.md

@@ -1,21 +1,31 @@
 # Octopress Deploy
 
-Easily deploy any Jekyll or Octopress site using S3, Git or Rsync.
-
-Pull request to support other deployment methods are welcome.
+Easily deploy any static site using S3, Git or Rsync. Pull request to support other deployment methods are welcome.
 
 [![Gem Version](http://img.shields.io/gem/v/octopress-deploy.svg)](https://rubygems.org/gems/octopress-deploy)
 [![License](http://img.shields.io/:license-mit-blue.svg)](http://octopress.mit-license.org)
 
 ## Installation
 
-To use Octopress Deploy, first install the Octopress gem with `gem install octopress` or by adding it to your Gemfile.
+Octopress Deploy is bundled with the Octopress Gem, to use it from the command line, install Octopress first.
+
+```
+$ gem install octopress
+```
+
+## Usage
+
+| Subcommand          | Description                                                        |
+|:--------------------|:-------------------------------------------------------------------|
+| `init <METHOD>`     | Generate a config file for the deployment method. (git, s3, rsync) |
+| `pull <DIR>`        | Pull down your site into a local directory.                        |
+| `add-bucket <NAME>` | (S3 only) Add a bucket using your configured S3 credentials.       |
 
 ## Set up
 
 First set up a configuration file for your deployment method.
 
-```sh
+```
 $ octopress deploy init git  # or rsync, s3
 ```
 
@@ -27,7 +37,7 @@ you never commit sensitive information to your repository.**
 You can pass configurations as command line options. To see specific options for any method, add the `--help` flag.
 For example to see the options for configuring S3:
 
-```sh
+```
 $ octopress deploy init s3 --help
 ```
 
@@ -38,14 +48,14 @@ any static site. Simply make sure your configuration points to
 the root directory of your static site (For Jekyll, that's
 probably `_site`) then tell Octopress to deploy it.
 
-```sh
+```
 $ octopress deploy
 ```
 
 This will read your `_deploy.yml` configuration and deploy your
 site. If you like, you can specify a configuration file.
 
-```sh
+```
 $ octopress deploy --config _staging.yml
 ```
 
@@ -53,8 +63,8 @@ $ octopress deploy --config _staging.yml
 
 With the `pull` command, you can pull your site down into a local directory.
 
-```sh
-octopress deploy pull <DIR>
+```
+$ octopress deploy pull <DIR>
 ```
 
 Mainly you'd do this if you're troubleshooting deployment and you want to see if it's working how you expected.
@@ -126,15 +136,14 @@ Note: configurations in `_deploy.yml` will override environment variables so be
 
 If your AWS credentials are properly configured, you can add a new bucket with this command.
 
-```sh
-octopress deploy add-bucket
+```
+$ octopress deploy add-bucket <NAME>
 ```
 
 This will connect to AWS, create a new S3 bucket, and configure it for static website hosting. This command can use the settings in your deployment configuration or you can pass options to override those settings.
 
 | Option        | Description                                      | Default
 |:--------------|:-------------------------------------------------|:---------------|
-| `--name`      | Override the `bucket_name` configuration         |                |
 | `--region`    | Override the `region` configuration              |                |
 | `--index`     | Specify an index page for your site              | index.html     |
 | `--error`     | Specify an error page for your site              | error.html     |

data/lib/octopress-deploy.rb

@@ -34,11 +34,15 @@ module Octopress
     def self.pull(options={})
       options = merge_configs(options)
 
-      if !File.exists? options[:dir]
+      if Dir.exist?(options[:dir]) &&
+          !(Dir.entries(options[:dir]) - %w{. ..}).empty? &&
+          !options[:force]
+            puts "Pull failed. Directory #{options[:dir]} is not empty. Pass --force to overwrite."
+            abort
+      else
         FileUtils.mkdir_p options[:dir]
+        deployer(options).pull
       end
-
-      deployer(options).pull
     end
 
     def self.add_bucket(options={})
@@ -144,7 +148,9 @@ end
 
 Octopress::Docs.add({
   name:        "Octopress Deploy",
-  description: "An Octopress plugin for deploying static websites.",
+  gem:         "octopress-deploy",
+  version:     Octopress::Deploy::VERSION,
+  description: "Easily deploy any static site using S3, Git or Rsync.",
   path:        File.expand_path(File.join(File.dirname(__FILE__), "../")),
   source_url:  "https://github.com/octopress/deploy",
 })

data/lib/octopress-deploy/commands.rb

@@ -15,6 +15,7 @@ module Octopress
           c.command(:pull) do |c|
             c.syntax "pull <DIR>"
             c.description "Pull down the published copy of your site into DIR"
+            c.option 'force', '--force', 'Overwrite existing files on pull'
             c.option "config_file", "--config FILE", "The path to your config file (default: _deploy.yml)"
 
             c.action do |args, options|
@@ -79,15 +80,15 @@ module Octopress
           end
 
           c.command(:'add-bucket') do |c|
-            c.syntax 'add-bucket [options]'
-            c.description "Add a new S3 bucket and configure it for static websites."
-            c.option 'bucket_name','--name NAME','Choose a bucket name. (Defaults: to bucket_name in config file)'
+            c.syntax 'add-bucket <NAME> [options]'
+            c.description "Add a new S3 bucket and configure it for static websites. Name defaults to bucket_name in config file"
             c.option 'region','--region REGION','Choose a region. (Defaults: to region in config file)'
             c.option 'index_page','--index PAGE','Specify an index page. (Default: index.html)'
             c.option 'error_page','--error PAGE','Specify an error page. (Default: 404.html)'
             c.option "config_file", "--config FILE", "The path to your config file (default: _deploy.yml)"
 
             c.action do |args, options|
+              options['bucket_name'] = args.first
               Octopress::Deploy.add_bucket(options)
             end
           end

data/lib/octopress-deploy/version.rb

@@ -1,5 +1,5 @@
 module Octopress
   module Deploy
-    VERSION = "1.0.2"
+    VERSION = "1.0.3"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: octopress-deploy
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Brandon Mathis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-02 00:00:00.000000000 Z
+date: 2015-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorator