octopress-deploy 1.0.0.rc.2 → 1.0.0.rc.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3efe926242e9c3f0936e369b1c3881909a2db698
-  data.tar.gz: 1093e88356c8500b3fe8a8cc0a730c9cefb70441
+  metadata.gz: bedbad944ec84caf8996e0ad73948eb63a0018dd
+  data.tar.gz: 04745c41ed2ae1879c9896645d29add34f5352ee
 SHA512:
-  metadata.gz: 3de6a859d40bb71a6be9d544780965a325957d41d2b5012ebdd5755afb140f75f21f176aff62981c8196dd12ad327e027a1af7b8c5e060acfef5a836cc77a73c
-  data.tar.gz: 2518b7c9a75884da919a445c8eb709a0f657e747b36c9d23ce7abbe829158f47806f6b08492babac0f807745df86db42cf402f70d7ca6382f54d70a0e8d1ae7e
+  metadata.gz: 4386f246e4e5a2ef29376d9702184d0a47e9948b1a1c7605f6fc76e38eeabac1d048bfa485d23b63a5be65bee80ea134974f6b5d1d88198cc0a4b6b21989d033
+  data.tar.gz: 507f9b34ca94e126f868929c9ea373332a3e743279a579d6357ca736553734126417b2c10735d84f27b646075375f50601390642e4009657bea25a110c495194

data/CHANGELOG.md

@@ -0,0 +1,25 @@
+# Octopress Deploy Changelog
+
+## Current version
+
+### 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.
+
+## Past versions
+
+### 1.0.0 RC2 - 2014-03-18
+- CHANGE: `add_bucket` command becomes `add-bucket` 
+
+### 1.0.0 RC1 - 2014-03-17
+- Initial release

data/README.md

@@ -1,16 +1,14 @@
 # Octopress Deploy
 
-Deployment tools for Octopress and Jekyll blogs (or really any static site).
+Currently this gem supports deploying static sites using S3, Git and Rsync. Pull request to support other deployment methods are welcome.
 
-Currently this supports deploying through 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)
+<!--[![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.1'
+    gem 'octopress-deploy', '~> 1.0.0.rc.2'
 
 And then execute:
 
@@ -56,7 +54,7 @@ $ octopress deploy --config _staging.yml
 With the `pull` command, you can pull your site down into a local directory.
 
 ```sh
-octopress deploy pull <DIRECTORY>
+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.
@@ -101,7 +99,7 @@ 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
 ```
 
 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.

data/Rakefile

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

data/assets/docs/changelog/index.markdown

@@ -0,0 +1,27 @@
+---
+title: "Octopress Deploy Changelog"
+---
+
+## Current version
+
+### 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.
+
+## Past versions
+
+### 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

@@ -0,0 +1,179 @@
+---
+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.2'
+
+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        |
+
+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.
+
+### 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.

data/lib/octopress-deploy.rb

@@ -8,7 +8,6 @@ require 'octopress-deploy/version'
 require 'octopress-deploy/core_ext'
 require 'octopress-deploy/commands'
 
-
 module Octopress
   module Deploy
     autoload :Git,    'octopress-deploy/git'
@@ -130,5 +129,17 @@ FILE
         true
       end
     end
+
+    def self.gem_dir(*subdirs)
+      File.expand_path(File.join(File.dirname(__FILE__), '../', *subdirs))
+    end
+
   end
 end
+
+begin
+  require 'octopress-ink'
+  require 'octopress-deploy/docs'
+  Octopress::Ink.register_plugin(Octopress::Deploy::DeployDocs)
+rescue LoadError
+end

data/lib/octopress-deploy/commands.rb

@@ -12,8 +12,8 @@ module Octopress
           end
 
           c.command(:pull) do |c|
-            c.syntax "pull <DIRECTORY>"
-            c.description "Pull down the published copy of your site into a directory (default: ./site-pull)"
+            c.syntax "pull <DIR>"
+            c.description "Pull down the published copy of your site into DIR"
             c.option "config_file", "--config FILE", "The path to your config file (default: _deploy.yml)"
 
             c.action do |args, options|

data/lib/octopress-deploy/docs.rb

@@ -0,0 +1,19 @@
+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
+
+      def docs_base_path
+        'docs/deploy'
+      end
+    end
+  end
+end

data/lib/octopress-deploy/rsync.rb

@@ -4,6 +4,7 @@ module Octopress
 
       def initialize(options)
         @options      = options
+        @flags        = @options[:flags] || ' -rltDvz'
         @user         = @options[:user]
         @port         = @options[:port]
         @local        = @options[:site_dir]
@@ -15,7 +16,6 @@ module Octopress
         @exclude_file = @options[:include_file]
         @exclude_file = File.expand_path(@include_file) if @include_file
         @delete       = @options[:delete] || false
-        @remote_path  = @remote_path.sub(/^\//,'') #remove leading slash
         @pull_dir     = @options[:dir]
       end
 
@@ -33,14 +33,15 @@ module Octopress
         local = ''
         remote = ''
 
-        cmd    =  "rsync -avz "
-        cmd    << " -e "                               if @exclude_file || @exclude
-        cmd    << " --exclude-from #{@exclude_file} "  if @exclude_file
-        cmd    << " --exclude #{@exclude} "            if @exclude
-        cmd    << " --include-from #{@include_file} "  if @include_file
-        cmd    << " --include #{@include} "            if @include
-        cmd    << " --rsh='ssh -p#{@port}' "           if @user && @port
-        cmd    << " --delete "                         if @delete
+        cmd    =  "rsync "
+        cmd    << "#{@flags} "
+        cmd    << " -e"                               if @exclude_file || @exclude
+        cmd    << " --exclude-from #{@exclude_file}"  if @exclude_file
+        cmd    << " --exclude #{@exclude}"            if @exclude
+        cmd    << " --include-from #{@include_file}"  if @include_file
+        cmd    << " --include #{@include}"            if @include
+        cmd    << " --rsh='ssh -p#{@port}'"           if @user && @port
+        cmd    << " --delete"                         if @delete
 
         local  << " #{File.join(@local, '')} "
         remote << " #{@user}:"                         if @user
@@ -59,12 +60,12 @@ module Octopress
 #{"remote_path: #{options[:remote_path]}".ljust(40)}  # Destination directory
 #{"delete: #{options[:delete]}".ljust(40)}  # Remove files from destination which don't match files in source
 
+#{"# flags: #{options[:flags] || '-rltDvz'}".ljust(40)}  # Modify flags as necessary to suit your hosting setup
 #{"# port: #{options[:port]}".ljust(40)}  # If your host requires a non standard port
 #{"# exclude: ".ljust(40)}  # Path to file containing list of files to exclude
 #{"# exclude-file: ".ljust(40)}  # Path to file containing list of files to exclude
 #{"# include: ".ljust(40)}  # Path to file containing list of files to include
 #{"# include-file: ".ljust(40)}  # Path to file containing list of files to include
-
 CONFIG
       end
       

data/lib/octopress-deploy/version.rb

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

data/octopress-deploy.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "octopress", "~> 3.0.0.rc.1"
   spec.add_runtime_dependency "colorator"
 
+  spec.add_development_dependency "octopress-ink"
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: octopress-deploy
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc.2
+  version: 1.0.0.rc.3
 platform: ruby
 authors:
 - Brandon Mathis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-19 00:00:00.000000000 Z
+date: 2014-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octopress
@@ -38,6 +38,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: octopress-ink
+  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: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -74,13 +88,17 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- assets/docs/changelog/index.markdown
+- assets/docs/index.markdown
 - lib/octopress-deploy.rb
 - lib/octopress-deploy/commands.rb
 - lib/octopress-deploy/core_ext.rb
+- lib/octopress-deploy/docs.rb
 - lib/octopress-deploy/git.rb
 - lib/octopress-deploy/rsync.rb
 - lib/octopress-deploy/s3.rb