jekyll-s3 2.6.0 → 2.7.0

data/README.md

@@ -31,6 +31,16 @@ s3_bucket: your.blog.bucket.com
 
 * Run `jekyll-s3` to push your Jekyll blog to S3. Congratulations! You are live.
 
+### Using environment variables
+
+You can use ERB in your `_jekyll_s3.yml` file which incorporates environment variables:
+
+```yaml
+s3_id: <%= ENV['S3_ID'] %>
+s3_secret: <%= ENV['S3_SECRET'] %>
+s3_bucket: blog.example.com
+```
+
 ## Additional features
 
 ### Cache Control
@@ -117,12 +127,32 @@ You can reduce the cost of hosting your blog on S3 by using Reduced Redundancy S
 
 It is easy to deliver your S3-based web site via Cloudfront, the CDN of Amazon.
 
-  * Go to <https://console.aws.amazon.com/cloudfront/home>
-  * Create a distribution and set the your Jekyll S3 bucket as the origin
-  * Add the `cloudfront_distribution_id: your-dist-id` setting into
-    `_jekyll_s3.yml`
-  * Run `jekyll-s3` to deploy your site to S3 and invalidate the Cloudfront
-    distribution
+#### Creating a new CloudFront distribution
+
+When you run the command `configure-s3-website`, it will ask you whether you
+want to deliver your website via CloudFront. If you answer yes,
+`configure-s3-website` will create a CloudFront distribution for you.
+
+This feature was added into the version 1.3.0 of the `configure-s3-website` gem.
+For more information, see the [gem's
+documentation](https://github.com/laurilehmijoki/configure-s3-website).
+
+#### Using your existing CloudFront distribution
+
+If you already have a CloudFront distribution that serves data from your Jekyll
+S3 bucket, just add the following line into the file `_jekyll_s3.yml`:
+
+    cloudfront_distribution_id: your-dist-id
+
+Next time you run `jekyll-s3`, it will invalidate the items on CloudFront and
+thus force the CDN system to reload the changes from your Jekyll S3 bucket.
+
+#### Specifying custom settings for your CloudFront distribution
+
+The gem `configure-s3-website`, which is a dependency of `jekyll-s3`, lets you
+define custom settings for your CloudFront distribution. See the [gem's
+documentation](https://github.com/laurilehmijoki/configure-s3-website) for more
+info.
 
 ### The headless mode
 
@@ -139,7 +169,7 @@ Enable the headless mode by adding the `--headless` or `-h` argument after
 You can set HTTP redirects on your Jekyll S3 website by adding the following
 configuration into the `_jekyll_s3.yml` file:
 
-´´´´yaml
+```yaml
 routing_rules:
   - condition:
       key_prefix_equals: blog/some_path
@@ -147,7 +177,11 @@ routing_rules:
       host_name: blog.example.com
       replace_key_prefix_with: some_new_path/
       http_redirect_code: 301
-´´´´
+```
+
+After adding the configuration, run the command `configure-s3-website --config
+_jekyll_s3.yml` on your command-line interface. This will apply the routing
+rules on your S3 bucket.
 
 For more information on configuring redirects, see the documentation of the
 [configure-s3-website](https://github.com/laurilehmijoki/configure-s3-website#configuring-redirects)
@@ -170,7 +204,7 @@ You can also use a basic `Hash` instead of a `_jekyll_s3.yml` file:
 config = {
   "s3_id"     => YOUR_AWS_S3_ACCESS_KEY_ID,
   "s3_secret" => YOUR_AWS_S3_SECRET_ACCESS_KEY,
-  "s3_bucket" => your.blog.bucket.com
+  "s3_bucket" => "your.blog.bucket.com"
 }
 in_headless = true
 Jekyll::S3::Uploader.run('/path/to/your/jekyll-site/_site/', config, in_headless)
@@ -223,6 +257,8 @@ Contributors (in alphabetical order)
 * Cory Kaufman-Schofield
 * Chris Kelly
 * Chris Moos
+* David Michael Barr
+* László Bácsi
 * Lauri Lehmijoki
 * Mason Turner
 * Michael Bleigh

data/changelog.md

@@ -2,6 +2,13 @@
 
 This project uses [Semantic Versioning](http://semver.org).
 
+## 2.7.0
+
+* Allow s3_id and s3_secret to be omitted
+
+  This enables deploying jekyll-s3 on EC2 instances with IAM roles. The AWS SDK
+  will automatically fetch temporary credentials.
+
 ## 2.6.0
 
 * Support configuring of redirects on the S3 website

data/jekyll-s3.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "jekyll-s3"
-  s.version     = "2.6.0"
+  s.version     = "2.7.0"
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Philippe Creux", "Lauri Lehmijoki"]
   s.email       = ["pcreux@gmail.com", "lauri.lehmijoki@iki.fi"]

data/lib/jekyll-s3/config_loader.rb

@@ -41,7 +41,7 @@ s3_bucket: your.blog.bucket.com
         end
         raise MalformedConfigurationFileError unless config
         raise MalformedConfigurationFileError if
-          ['s3_id', 's3_secret', 's3_bucket'].any? { |key|
+          ['s3_bucket'].any? { |key|
             mandatory_config_value = config[key]
             mandatory_config_value.nil? || mandatory_config_value == ''
           }

data/lib/jekyll-s3/uploader.rb

@@ -4,9 +4,13 @@ module Jekyll
       def self.run(site_dir, config, in_headless_mode = false)
         puts "Deploying _site/* to #{config['s3_bucket']}"
 
-        s3 = AWS::S3.new(:access_key_id => config['s3_id'],
-                         :secret_access_key => config['s3_secret'],
-                         :s3_endpoint => Endpoint.new(config['s3_endpoint']).hostname )
+        s3_config = { :s3_endpoint => Endpoint.new(config['s3_endpoint']).hostname }
+        s3_id, s3_secret = config['s3_id'], config['s3_secret']
+        unless s3_id.nil? || s3_id == '' || s3_secret.nil? || s3_secret == ''
+          s3_config.merge! :access_key_id => s3_id, :secret_access_key => s3_secret
+        end
+
+        s3 = AWS::S3.new(s3_config)
 
         new_files_count, changed_files_count, changed_files = upload_files(
           s3, config, site_dir

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-s3
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 2.7.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-05 00:00:00.000000000 Z
+date: 2013-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -337,7 +337,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1426117685170856027
+      hash: 4368343528403061082
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -346,7 +346,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1426117685170856027
+      hash: 4368343528403061082
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25