octopress-deploy 1.0.0.rc.11 → 1.0.0.rc.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 296a444e68bbd230304ed1ab4f85e7d97523e419
-  data.tar.gz: 6598445489a8e5282e2411eba164ee5f0e41c024
+  metadata.gz: e2f19db8a6fac623c988cdbb3ce1571ea697ee3a
+  data.tar.gz: def8b281c86a64ce1bbe125a3611125bcb0535a3
 SHA512:
-  metadata.gz: 1803d580f91c4528ca5346de10a40c590cde16ef44c2c56681012e01bd4ad30580c4e19e7c898cd697b0c724041643f925221e922bb79f6d3f1e38f74f9a32bf
-  data.tar.gz: 79c1cf157adc9a9046fa6360fd9f59b4b40b4df9a84acd49dee858d1f9addc51b1a3a9ba57d3f662de443fa56706da89cd2902ce36545102a5056f071e940ca2
+  metadata.gz: 260095f55a4495a05edb0c8e12c32aea5565352064ff93c233881301daf82136bc5417f87acecd930e327e392efbf1697e2751c814fdb31a2b19629cc89bd370
+  data.tar.gz: 5464e5e1c20578f2fa551f63a3fbd975017a69aa833601a1711482a59263d769b17dd90936fe1ae8cd7fdadd39d4738db537ce83db284feb13aa75ddfc76f0f9

data/README.md

@@ -1,22 +1,15 @@
 # Octopress Deploy
 
-Currently this gem supports deploying static sites using S3, Git and Rsync. Pull request to support other deployment methods are welcome.
+Easily deploy any Jekyll or Octopress site using S3, Git or Rsync.
 
-<!--[![Gem Version](https://badge.fury.io/rb/octopress-deploy.png)](http://badge.fury.io/rb/octopress-deploy)-->
+Pull request to support other deployment methods are welcome.
 
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'octopress-deploy', '~> 1.0.0.rc.10'
+[![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)
 
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
+## Installation
 
-    $ gem install octopress-deploy --pre
+To use Octopress Deploy, first install the Octopress gem with `gem install octopress` or by adding it to your Gemfile.
 
 ## Set up
 
@@ -31,7 +24,7 @@ directory which you can edit to add any necessary configuration.
 **Remember to add your configuration to `.gitignore` to be sure
 you never commit sensitive information to your repository.**
 
-## Deploying
+## Deploying your site.
 
 Deployment is tailored to work with Jekyll, but it will work for
 any static site. Simply make sure your configuration points to
@@ -113,7 +106,7 @@ headers:
 
 ### AWS config via ENV
 
-If you prefer, you can store AWS access credentials in environment variables instead of a conifiguration file. 
+If you prefer, you can store AWS access credentials in environment variables instead of a configuration file. 
 
 | Config              | ENV var                        |
 |:--------------------|:-------------------------------|

data/Rakefile

@@ -1,11 +1 @@
 require "bundler/gem_tasks"
-require "octopress-ink"
-
-desc "Copy Readme and Changelog into docs"
-
-task 'ship' => ['update_docs', 'release']
-
-task 'update_docs' do
-  Octopress::Ink.copy_doc 'README.md', 'assets/docs/index.markdown'
-  Octopress::Ink.copy_doc 'CHANGELOG.md', 'assets/docs/changelog.markdown', '/changelog/'
-end

data/lib/octopress-deploy/docs.rb

@@ -1,27 +1,8 @@
-module Octopress
-  module Deploy
-    class DeployDocs < Octopress::Ink::Plugin
-      def configuration
-        {
-          name:        "Octopress Deploy",
-          description: "Deploy your site with Git, Rsync or S3.",
-          slug:        "deploy",
-          assets_path: Octopress::Deploy.gem_dir('assets'),
-          version:     Octopress::Deploy::VERSION,
-        }
-      end
+require 'octopress-docs'
 
-      def docs_base_path
-        'docs/deploy'
-      end
-
-      def info(options)
-        if options['docs']
-          super
-        else
-          ''
-        end
-      end
-    end
-  end
-end
+Octopress::Docs.add({
+  name:        "Octopress Deploy",
+  slug:        "deploy",
+  dir:         File.expand_path(File.join(File.dirname(__FILE__), "../../")),
+  base_url:    "docs/deploy"
+})

data/lib/octopress-deploy/version.rb

@@ -1,5 +1,5 @@
 module Octopress
   module Deploy
-    VERSION = "1.0.0.rc.11"
+    VERSION = "1.0.0.rc.12"
   end
 end

data/lib/octopress-deploy.rb

@@ -1,5 +1,4 @@
 $LOAD_PATH.unshift File.expand_path("../", __FILE__)
-#
 
 require 'colorator'
 require 'yaml'
@@ -142,10 +141,3 @@ FILE
 
   end
 end
-
-begin
-  require 'octopress-ink'
-  require 'octopress-deploy/docs'
-  Octopress::Ink.register_plugin(Octopress::Deploy::DeployDocs)
-rescue LoadError
-end

data/octopress-deploy.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = Octopress::Deploy::VERSION
   spec.authors       = ["Brandon Mathis"]
   spec.email         = ["brandon@imathis.com"]
-  spec.description   = %q{Deploy Octopress and Jekyll sites easily.}
-  spec.summary       = %q{Deploy Octopress and Jekyll sites easily.}
+  spec.description   = %q{Easily deploy any Jekyll or Octopress site using S3, Git, or Rsync.}
+  spec.summary       = %q{Easily deploy any Jekyll or Octopress site using S3, Git, or Rsync.}
   spec.homepage      = "https://github.com/octopress/deploy"
   spec.license       = "MIT"
 
@@ -17,10 +17,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "octopress", "~> 3.0.0.rc.10"
   spec.add_runtime_dependency "colorator"
+  spec.add_runtime_dependency "octopress-docs"
 
-  spec.add_development_dependency "octopress-ink"
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: octopress-deploy
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc.11
+  version: 1.0.0.rc.12
 platform: ruby
 authors:
 - Brandon Mathis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-25 00:00:00.000000000 Z
+date: 2014-09-24 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: octopress
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.0.0.rc.10
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.0.0.rc.10
 - !ruby/object:Gem::Dependency
   name: colorator
   requirement: !ruby/object:Gem::Requirement
@@ -39,13 +25,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: octopress-ink
+  name: octopress-docs
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -80,7 +66,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Deploy Octopress and Jekyll sites easily.
+description: Easily deploy any Jekyll or Octopress site using S3, Git, or Rsync.
 email:
 - brandon@imathis.com
 executables: []
@@ -93,8 +79,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- assets/docs/changelog.markdown
-- assets/docs/index.markdown
 - lib/octopress-deploy.rb
 - lib/octopress-deploy/commands.rb
 - lib/octopress-deploy/core_ext.rb
@@ -132,10 +116,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.1
 signing_key: 
 specification_version: 4
-summary: Deploy Octopress and Jekyll sites easily.
+summary: Easily deploy any Jekyll or Octopress site using S3, Git, or Rsync.
 test_files:
 - test/.gitignore
 - test/Gemfile

data/assets/docs/changelog.markdown

@@ -1,60 +0,0 @@
----
-title: "Octopress Deploy Changelog"
-permalink: /changelog/
----
-
-## Current version
-
-###  1.0.0 RC10 - 2014-07-06
-- Fix: Pass options to initialization when adding a bucket. [#34](https://github.com/octopress/deploy/pull/34)
-
-## Past versions
-
-###  1.0.0 RC9 - 2014-05-31
-
-- New: S3 header configuration options. [#25](https://github.com/octopress/deploy/issues/25)
-- Fix: `site_dir` defaults to `'_site'`. [#29](https://github.com/octopress/deploy/issues/29)
-- Fix: A Windows OS issue. [#30](https://github.com/octopress/deploy/pull/30)
-
-###  1.0.0 RC8 - 2014-05-08
-
-- Now using SafeYAML for loading configurations.
-
-###  1.0.0 RC7 - 2014-05-02
-
-- Fixed: `--version` flag.
-- Fixed: Moved requiring `pry-debugger` to tests.
-
-### 1.0.0 RC6 - 2014-04-17
-
-- Fixed: CLI options now override config file settings.
-
-### 1.0.0 RC5 - 2014-04-01
-
-- Fixed: `site_dir` config didn't work.
-
-
-### 1.0.0 RC4 - 2014-03-25
-
-- Added: Octopress Ink documentation site support
-
-### 1.0.0 RC3 - 2014-03-22
-
-#### Minor Enhancements
-- Default rsync flags are now `-rltDvz` so they no
-  longer try to set file permissions or preserve owner and
-  group name on remote. Issue: #19
-- Added `flags` config for rsync allows customization of flags.
-- Added support for octopress-ink documentation system.
-- Added a `update_docs` Rake task to update assets/docs/index.markdown from README.md.
-
-#### Bug Fixes
-- No longer stripping forward slashes on remote_path. Issue #18
-- `pull` command no longer promises a default directory.
-
-
-### 1.0.0 RC2 - 2014-03-18
-- CHANGE: `add_bucket` command becomes `add-bucket` 
-
-### 1.0.0 RC1 - 2014-03-17
-- Initial release

data/assets/docs/index.markdown

@@ -1,207 +0,0 @@
----
-title: "Octopress Deploy"
----
-
-Currently this gem supports deploying static sites using S3, Git and Rsync. Pull request to support other deployment methods are welcome.
-
-<!--[![Gem Version](https://badge.fury.io/rb/octopress-deploy.png)](http://badge.fury.io/rb/octopress-deploy)-->
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'octopress-deploy', '~> 1.0.0.rc.10'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install octopress-deploy --pre
-
-## Set up
-
-First set up a configuration file for your deployment method.
-
-```sh
-$ octopress deploy init git  # or rsync, s3
-```
-
-This will generate a `_deploy.yml` file in your current
-directory which you can edit to add any necessary configuration.
-**Remember to add your configuration to `.gitignore` to be sure
-you never commit sensitive information to your repository.**
-
-## Deploying
-
-Deployment is tailored to work with Jekyll, but it will work for
-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
-```
-
-## Pull down your site
-
-With the `pull` command, you can pull your site down into a local directory.
-
-```sh
-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.
-
-## Amazon S3 Deployment Configuration
-
-To deploy with Amazon S3 you will need to install the [aws-sdk gem](https://rubygems.org/gems/aws-sdk).
-
-Important: when using S3, you must add your `_deploy.yml` to your .gitignore to prevent accidentally sharing
-account access information.
-
-| Config              | Description                                           | Default
-|:--------------------|:------------------------------------------------------|:-------------|
-| `method`            | Deployment method, in this case use 's3'              |              |
-| `site_dir`          | Path to static site files                             | _site        |
-| `bucket_name`       | S3 bucket name                                        |              |
-| `access_key_id`     | AWS access key                                        |              |
-| `secret_access_key` | AWS secret key                                        |              |
-| `remote_path`       | Directory files should be synced to.                  | /            |
-| `verbose`           | [optional] Display all file actions during deploy.    | true         |
-| `region`            | [optional] Region for your AWS bucket                 | us-east-1    |
-| `delete`            | Delete files in `remote_path` not found in `site_dir` | false        |
-| `headers`           | Set headers for matched files                         | []           |
-
-If you choose a bucket which doesn't yet exist, Octopress Deploy will offer to create it for you, and offer to configure it as a static website.
-
-If you configure Octopress to delete files, all files found in the `remote_path` on S3 bucket will be removed unless they match local site files.
-If `remote_path` is a subdirectory, only files in that subdirectory will be evaluated for deletion.
-
-
-### S3 Headers
-
-You can create an array of header congifs to set expiration, content and cache settings for any paths matching the `filename`.
-
-| Header Config       | Description                                           | Default
-|:--------------------|:------------------------------------------------------|:-------------|
-| `filename`          | A regex or a substring of the file to match           |              |
-| `site_dir`          | An http date or a number of years or days from now    |              |
-| `content_type`      | A string which is passed through to the headers       |              |
-| `content_encoding`  | A string which is passed through to the headers       |              |
-| `cache_control`     | A string which is passed through to the headers       |              |
-
-Here is how you might set expriation and cache controls for CSS and Javascript files.
-
-```yaml
-headers:
-  - filename: '^assets.*\.js$'
-    expires: '+3 years'
-    cache_control: 'max-age=94608000'
-    content_type: 'application/javascript'
-  - filename: '^assets.*\.css$'
-    expires: '+3 years'
-    cache_control: 'max-age=94608000'
-    content_type: 'text/css'
-```
-
-### AWS config via ENV
-
-If you prefer, you can store AWS access credentials in environment variables instead of a conifiguration file. 
-
-| Config              | ENV var                        |
-|:--------------------|:-------------------------------|
-| `access_key_id`     | AWS_ACCESS_KEY_ID              |
-| `secret_access_key` | AWS_SECRET_ACCESS_KEY          |
-
-Note: configurations in `_deploy.yml` will override environment variables so be sure to remove those if you decide to use environment variables.
-
-### Add a new bucket
-
-If your AWS credentials are properly configured, you can add a new bucket with this command.
-
-```sh
-octopress deploy add-bucket
-```
-
-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     |
-| `--config`    | Use a custom configuration file                  | _deploy.yml    |
-
-You'll only need to pass options if you want to override settings in your deploy config file.
-
-## Git Deployment Configuration
-
-Only `git_url` is required. Other options will default as shown below.
-
-| Config        | Description                                      | Default
-|:--------------|:-------------------------------------------------|:---------------|
-| `method`      | Deployment method, in this case use 'git'        |                |
-| `site_dir`    | Path to static site files                        | _site          |
-| `git_url`     | Url for remote git repository                    |                |
-| `git_branch`  | Deployment branch for git repository             | master         |
-| `deploy_dir`  | Directory where deployment files are staged      | .deploy        |
-| `remote`      | Name of git remote                               | deploy         |
-
-## Rsync Deployment Configuration
-
-| Config         | Description                                       | Default
-|:---------------|:--------------------------------------------------|:---------------|
-| `method`       | Deployment method, in this case use 'rsync'       |                |
-| `site_dir`     | Path to static site files                         | _site          |
-| `user`         | ssh user, e.g user@host.com                       |                |
-| `port`         | ssh port                                          | 22             |
-| `remote_path`  | Remote destination's document root                |                |
-| `exclude_file` | Path to a file containing rsync exclusions        |                |
-| `exclude`      | Inline list of rsync exclusions                   |                |
-| `include`      | Inline list of inclusions to override exclusions  |                |
-| `delete`       | Delete files in destination not found in source   | false          |
-
-You can rsync to a local directory by configuring `remote_path` and leaving off `user` and `port`.
-
-## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
-
-## License
-
-Copyright (c) 2014 Brandon Mathis
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.