octopress-deploy 1.2.6 → 1.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 86e904b2e06c8c70df12dd4e301e97099f1619d4
-  data.tar.gz: 0044b426419d4fee6189e79f240139cb7fb76f7a
+  metadata.gz: 1eb5beb837b96c6e0ab922695ec87617e71f1bad
+  data.tar.gz: cf3e51606a71b99ef7410025c919fd84106ed3cc
 SHA512:
-  metadata.gz: 203001699d0cef653430a2cdc9cbf4b9bc8670377253e4abb2560ae112dc730b747b3b9a08cdc72a5934d43372d6d1e8f2a8b3a5446d1727f1cc5bb97f27e919
-  data.tar.gz: 3fbf19b756ae0ee62fd35f3b4d0e6e3c751251b8afea2a58620a088390bfbe718e949f06aa8d6ef0f47f41e0ded8f142a48a47eaa71ca1fee5a1d366a5c8fc7d
+  metadata.gz: 9f41bd149e09d98034fdafa4419ab2b66e40a991c84aa8aac00f2c1569c95c08cf28ba8a4c087e38290e83fcdbc58261fc2a861a08f356a08d4e27c09d9b0326
+  data.tar.gz: 26ff8855e56f5167d14ae11092197fc4e2a2dce3121202d8971adb6f4c42fa8f56a345f28ba43c0e754f36569189ac88ba08f48a6f897952ab9119792779a979

data/CHANGELOG.md

@@ -1,9 +1,13 @@
 # Changelog
 
-### 1.2.6 - 2015-05-15
+### 1.2.7 - 2015-06-17
+- Fix: Fixed some erroneous references to site_dir configuration. [#60](https://github.com/octopress/deploy/pull/60)
+- Minor: Moved documentation to [octopress#deploy](https://github.com/octopress/octopress#deploy).
+
+### 1.2.6 - 2015-06-15
 - Fix: Tell users to build their sites if the build dir doesn't exist.
 
-### 1.2.5 - 2015-05-15
+### 1.2.5 - 2015-06-15
 - Fix: Ensures that deployment git remote is the same as configuration before pushing.
 
 ### 1.2.4 - 2015-05-11

data/README.md

@@ -15,175 +15,7 @@ $ gem install octopress
 
 ## Usage
 
-| Subcommand                | Description                                                        |
-|:--------------------------|:-------------------------------------------------------------------|
-| `init <METHOD> [options]` | 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.
-
-```
-$ octopress deploy init git git@github.com:user/project
-$ octopress deploy init s3
-$ octopress deploy init rsync
-```
-
-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.**
-
-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:
-
-```
-$ octopress deploy init s3 --help
-```
-
-## 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
-the root directory of your static site (For Jekyll, that's
-probably `_site`) then tell Octopress to deploy it.
-
-```
-$ octopress deploy
-```
-
-This will read your `_deploy.yml` configuration and deploy your
-site. If you like, you can specify a configuration file.
-
-```
-$ octopress deploy --config _staging.yml
-```
-
-## Pull down your site
-
-With the `pull` command, you can pull your site down into a local 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.
-
-## Amazon S3 Deployment Configuration
-
-To deploy with Amazon S3 you will need to install the [aws-sdk-v1 gem](https://rubygems.org/gems/aws-sdk-v1).
-
-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                                        |              |
-| `distribution_id`   | [optional] AWS CloudFront distribution id             |              |
-| `remote_path`       | Directory files should be synced to.                  | /            |
-| `verbose`           | [optional] Display all file actions during deploy.    | false        |
-| `incremental`       | [optional] Incremental deploy (only updated files)    | false        |
-| `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 configuration 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.
-
-```
-$ 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
-|:--------------|:-------------------------------------------------|:---------------|
-| `--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_from` | Path to a file containing rsync exclusions        |                |
-| `exclude`      | Inline list of rsync exclusions                   |                |
-| `include_from` | Path to a file containing rsync inclusions        |                |
-| `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`.
+For usage instructions, please refer to [octopress](https://github.com/octopress/octopress#deploy).
 
 ## Contributing
 

data/lib/octopress-deploy.rb

@@ -145,12 +145,3 @@ FILE
 
   end
 end
-
-Octopress::Docs.add({
-  name:        "Octopress Deploy",
-  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/git.rb

@@ -9,7 +9,7 @@ module Octopress
         @remote      = @options[:remote]       || 'deploy'
         @remote_path = @options[:remote_path]  || ''
         @remote_path = @remote_path.sub(/^\//,'') #remove leading slash
-        @site_dir    = File.expand_path(@options[:site_dir]  || '_site')
+        @local       = File.expand_path(@options[:site_dir]  || '_site')
         @deploy_dir  = File.expand_path(@options[:deploy_dir] || '.deploy')
         @pull_dir    = @options[:dir]
         abort "Deploy Failed: Configure a git_url in #{@options[:config_file]} before deploying.".red if @repo.nil?
@@ -18,10 +18,10 @@ module Octopress
       # Initialize, pull, copy and deploy.
       #
       def push
-        if File.exist?(@site_dir)
+        if File.exist?(@local)
           check_branch
           init_repo
-          puts "Syncing #{@site_dir.sub(Dir.pwd.strip+'/', '')} files to #{@repo}."
+          puts "Syncing #{@local.sub(Dir.pwd.strip+'/', '')} files to #{@repo}."
           FileUtils.cd @deploy_dir do
             git_pull
             clean_deploy
@@ -29,7 +29,7 @@ module Octopress
             git_push
           end
         else
-          abort "Cannot find site build at #{@site_dir}. Be sure to build your site first."
+          abort "Cannot find site build at #{@local}. Be sure to build your site first."
         end
       end
 
@@ -47,7 +47,7 @@ module Octopress
         end
 
         if same_remote && same_branch
-          puts "Deploy to #{@branch} canceled:".red 
+          puts "Deploy to #{@branch} canceled:".red
           puts "You cannot deploy to the same branch you are working in. This will overwrite the source for your site.\n"
           puts "First, back up your site's source to a branch:"
           puts "\n  git checkout -b source".yellow
@@ -152,7 +152,7 @@ CONFIG
       #
       def copy_site
         target_dir = File.join(@deploy_dir, @remote_path).sub(/\/$/,'')
-        FileUtils.cp_r @site_dir + '/.', target_dir
+        FileUtils.cp_r @local + '/.', target_dir
         message = "Site updated at: #{Time.now.utc}"
         `git add --all .`
         `git commit -m \"#{message}\"`

data/lib/octopress-deploy/rsync.rb

@@ -20,7 +20,7 @@ module Octopress
       end
 
       def push
-        if File.exist?(@site_dir)
+        if File.exist?(@local)
           puts "Syncing #{@local} files to #{@remote_path} with rsync."
           system cmd
         else

data/lib/octopress-deploy/version.rb

@@ -1,5 +1,5 @@
 module Octopress
   module Deploy
-    VERSION = "1.2.6"
+    VERSION = "1.2.7"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: octopress-deploy
 version: !ruby/object:Gem::Version
-  version: 1.2.6
+  version: 1.2.7
 platform: ruby
 authors:
 - Brandon Mathis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-16 00:00:00.000000000 Z
+date: 2015-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorator