rake-jekyll 1.0.4 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e10e3e33be1203cbf0bf52796a3e1656d21c9d46
-  data.tar.gz: 82fdf6429da1b35aa3cdfa173a090c6c9acc9346
+  metadata.gz: ac699ba1d1df2ed15767446ee842fbe45906c142
+  data.tar.gz: be141acdedfa657144ec01b79415a7342c2a8430
 SHA512:
-  metadata.gz: b22bf29cf1a9ab34801a273f91db759e34093cf04781ea0381f5dd49b8069601d2a39da462dfb1c23e53cdd957859996e29c2d8404f0a02d04a988f58d0948fb
-  data.tar.gz: a57ba8f2b4b0d115096700d843ebf3964ee68a85e3b17f76d6fb7757284ae0afbefb90d1263302f5fb6571a19786f07e95cf5b05d5c41098519199979c948b0c
+  metadata.gz: b40e103011acf97f5b140c0b99d5934ec97f1eef9ff7450936bdc3998eaa82d58efd43603aec1736811aa0b15ed5edd5b351a9c5039f4975ced980b717fbfb40
+  data.tar.gz: 7b21c15052fc052c4f3e23da7d287ba7641e337c94c7e1d91efdd74ba6bf2d601757c425b61451ca940fba6eec7000c88af62da3a9c2f84ff474b78eff71fda0

data/README.adoc

@@ -72,13 +72,17 @@ Rake::Jekyll::GitDeployTask.new(:deploy) do |t|
   # user.name is not set in git config.
   t.committer = 'Jekyll'
 
-  # Deploy the built site into remote branch named 'gh-pages'. It will be
-  # automatically created if not exist yet.
-  t.deploy_branch = 'gh-pages'
-
+  # Deploy the built site into remote branch named 'gh-pages', or 'master' if
+  # the remote repository URL matches `#{gh_user}.github.io.git`.
+  # It will be automatically created if not exist yet.
+  t.deploy_branch = -> {
+    gh_user = ENV['TRAVIS_REPO_SLUG'].to_s.split('/').first
+    remote_url.match(/[:\/]#{gh_user}\.github\.io\.git$/) ? 'master' : 'gh-pages'
+  }
   # Run this command to build the site.
-  t.jekyll_build = ->(dest_dir) {
-    Rake.sh "bundle exec jekyll build --destination #{dest_dir}"
+  t.build_script = ->(dest_dir) {
+    puts "\nRunning Jekyll..."
+    sh "bundle exec jekyll build --destination #{dest_dir}"
   }
   # Use the default committer (configured in git) when available.
   t.override_committer = false
@@ -86,16 +90,22 @@ Rake::Jekyll::GitDeployTask.new(:deploy) do |t|
   # Use URL of the 'origin' remote to fetch/push the built site into. If env.
   # variable GH_TOKEN is set, then it adds it as a userinfo to the URL.
   t.remote_url = -> {
-    `git config remote.origin.url`.strip.gsub(/^git:/, 'https:').tap do |url|
-      url.gsub!(%r{^https://}, "https://#{ENV['GH_TOKEN']}@") if ENV.key? 'GH_TOKEN'
-    end
+    url = `git config remote.origin.url`.strip.gsub(/^git:/, 'https:')
+    next url.gsub(%r{^https://([^/]+)/(.*)$}, 'git@\1:\2') if ssh_key_file?
+    next url.gsub(%r{^https://}, "https://#{ENV['GH_TOKEN']}@") if ENV.key? 'GH_TOKEN'
+    next url
   }
-  # Skip commit and push when building a pull request or env. variable
-  # SKIP_COMMIT represents truthy.
-  t.skip_commit = -> {
+  # Skip commit and push when building a pull request, env. variable
+  # SKIP_DEPLOY represents truthy, or env. variable SOURCE_BRANCH is set, but
+  # does not match TRAVIS_BRANCH.
+  t.skip_deploy = -> {
     ENV['TRAVIS_PULL_REQUEST'].to_i > 0 ||
-      %w[yes y true 1].include?(ENV['SKIP_COMMIT'].to_s.downcase)
+      %w[yes y true 1].include?(ENV['SKIP_DEPLOY'].to_s.downcase) ||
+      (ENV['SOURCE_BRANCH'] && ENV['SOURCE_BRANCH'] != ENV['TRAVIS_BRANCH'])
   }
+  # Path of the private SSH key to be used for communication with the
+  # repository defined by remote_url.
+  t.ssh_key_file = '.deploy_key'
 end
 ----
 
@@ -147,6 +157,12 @@ script: bundle exec rake deploy
 .. open your https://travis-ci.org/profile/[profile page] on Travis,
 .. find the repository and turn on the switch,
 .. then click on repository settings (next to the switch) and enable “Build only if .travis.yml is present.”
+
+Now you can choose if you want to use GitHub token (an easier way), or a deploy key (more secure way).
+
+===== A. Use GitHub token
+
+[start=6]
 . Generate a new personal access token on GitHub:
 .. open https://github.com/settings/tokens/new[this page] to generate a new personal access token,
 .. select the scope _public_repo_, fill some description and confirm.
@@ -163,6 +179,46 @@ env:
   global:
     secure: YOUR-ENCRYPTED-TOKEN
 ----
++
+. Commit changes, push to GitHub and check that Travis has started the job and finished it successfully.
+
+===== B. Use SSH deploy key
+
+[start=6]
+. Generate new RSA key pair and write it to file `.deploy_key` (and `.deploy_key.pub`) in the root of your Jekyll repository:
++
+  $ ssh-keygen -N '' -f .deploy_key
++
+. Encrypt the private key and add it to your `.travis.yml`:
+.. encrypt the key:
++
+  $ travis encrypt-file .deploy_key --add
++
+.. check that it created file `.deploy_key.enc` and added something like the following to `.travis.yml`:
++
+[source, yaml]
+----
+before_install:
+  - openssl aes-256-cbc -K $encrypted_e18dd77852c2_key -iv $encrypted_e18dd77852c2_iv -in .deploy_key.enc -out .deploy_key -d
+----
++
+.. and add command `chmod 600 .deploy_key` to `.travis.yml` after the `openssl` command, so you will end with something like:
++
+[source, yaml]
+----
+before_install:
+  - openssl aes-256-cbc -K $encrypted_e18dd77852c2_key -iv $encrypted_e18dd77852c2_iv -in .deploy_key.enc -out .deploy_key -d
+  - chmod 600 .deploy_key
+----
++
+. Add `.deploy_key` to `.gitignore` (this is unencrypted private key, keep it in secret!):
++
+  $ echo '.deploy_key' >> .gitignore
++
+. Register the generated key as a deploy key in your GitHub repository:
+.. open `https://github.com/<username>/<reponame>/settings/keys` and click on _Add deploy key_,
+.. paste content of the `.deploy_key.pub` file to the textbox,
+.. select “Allow write access” and confirm.
 . Commit changes, push to GitHub and check that Travis has started the job and finished it successfully.
 
 

data/bin/git-ssh-wrapper

@@ -0,0 +1,7 @@
+#!/bin/sh
+
+if [ -z "$SSH_PRIVATE_KEY" ]; then
+    ssh "$@"
+else
+    ssh -i "$SSH_PRIVATE_KEY" "$@"
+fi

data/lib/rake-jekyll.rb

@@ -1,2 +1,8 @@
+module Rake
+  module Jekyll
+    BIN_DIR = File.expand_path('../bin', __dir__)
+  end
+end
+
 require 'rake-jekyll/version'
 require 'rake-jekyll/git_deploy_task'

data/lib/rake-jekyll/git_deploy_task.rb

@@ -95,14 +95,16 @@ module Rake::Jekyll
     # @param attr_name [#to_s] name of the attribute to define.
     # @param default_value [Object] the default value (optional).
     # @yield When the block is given, then it's used as a default value.
-    #   It takes precedence over +default_value+.
+    #   It takes precedence over the +default_value+. It's evaluated in an
+    #   instance context.
     def self.callable_attr(attr_name, default_value = nil, &default_block)
       var_name = "@#{attr_name}".sub('?', '').to_sym
 
       define_method attr_name do
         value = instance_variable_get(var_name)
+
         if value.nil? && default_block
-          do_in_working_dir &default_block
+          do_in_working_dir { instance_eval &default_block }
         elsif value.nil?
           default_value
         elsif value.is_a?(Proc) && value.arity.zero?
@@ -171,23 +173,33 @@ module Rake::Jekyll
     # If the remote branch doesn't exist yet, then it's automatically created
     # as an orphan branch.
     #
-    # @return [String, Proc] name of the remote branch (default: +gh-pages+).
+    # @return [String, Proc] name of the remote branch. Defaults to +gh-page+,
+    #   or +master+ if the _remote_url_ matches `#{gh_user}.github.io.git`.
     #
-    callable_attr :deploy_branch, 'gh-pages'
+    callable_attr :deploy_branch do
+      gh_user = ENV['TRAVIS_REPO_SLUG'].to_s.split('/').first
+      remote_url.match(/[:\/]#{gh_user}\.github\.io\.git$/) ? 'master' : 'gh-pages'
+    end
 
     ##
-    # @!attribute jekyll_build
+    # @!attribute build_script
     # Defines a function that executes Jekyll to build the site.
     # Defaults to:
+    #   puts "\nRunning Jekyll..."
     #   Rake.sh "bundle exec jekyll build --destination #{dest_dir}"
     #
     # @return [Proc] a Proc that accepts one argument; the destination
     #   directory to generate the site into.
     #
-    callable_attr :jekyll_build, ->(dest_dir) {
+    callable_attr :build_script, ->(dest_dir) {
+      puts "\nRunning Jekyll..."
       Rake.sh "bundle exec jekyll build --destination #{dest_dir}"
     }
 
+    # For backward compatibility, remove in 2.x.
+    alias_method :jekyll_build, :build_script
+    alias_method :jekyll_build=, :build_script=
+
     ##
     # @!attribute override_committer?
     # @return [Boolean, Proc] +true+ to always use {#committer}, +false+ to use
@@ -196,30 +208,56 @@ module Rake::Jekyll
 
     ##
     # @!attribute remote_url
-    # @return [String, Proc] URL of the remote git repository to fetch and push
-    #   the built site into. The default is to use URL of the +origin+ remote,
-    #   replace +git:+ schema with +https:+ and add environment variable
-    #   +GH_TOKEN+ as an userinfo (if exists).
+    # Defines URL of the remote git repository to pull and push the built site
+    # into. The default is to use URL of the +origin+ remote and:
+    #
+    # a. if {#ssh_key_file} is readable, then convert URL to SSH address with
+    #    user +git+;
+    # b. or if environment variable +GT_TOKEN+ is set, then replace +git:+
+    #    schema with +https:+ and add +GH_TOKEN+ as an userinfo.
+    # c. else use remote URL as is.
+    #
+    # @return [String, Proc] URL of the target git repository.
+    #
     callable_attr :remote_url do
-      `git config remote.origin.url`.strip.gsub(/^git:/, 'https:').tap do |url|
-        url.gsub!(%r{^https://}, "https://#{ENV['GH_TOKEN']}@") if ENV.key? 'GH_TOKEN'
-      end
+      url = `git config remote.origin.url`.strip.gsub(/^git:/, 'https:')
+      next url.gsub(%r{^https://([^/]+)/(.*)$}, 'git@\1:\2') if ssh_key_file?
+      next url.gsub(%r{^https://}, "https://#{ENV['GH_TOKEN']}@") if ENV.key? 'GH_TOKEN'
+      next url
     end
 
     ##
-    # @!attribute [w] skip_commit
+    # @!attribute [w] skip_deploy
     # Whether to skip the commit and push phase.
     # Default is to return +true+ when env variable +TRAVIS_PULL_REQUEST+
-    # is an integer value greater than 0 or +SKIP_COMMIT+ represents truthy
-    # (i.e. contains yes, y, true, or 1).
+    # is an integer value greater than 0, +SKIP_DEPLOY+ represents truthy
+    # (i.e. contains yes, y, true, or 1), or +SOURCE_BRANCH+ is set and does
+    # not match +TRAVIS_BRANCH+.
     #
-    # @return [Boolean, Proc]
+    # @return [Boolean, Proc] skip deploy?
     #
-    callable_attr :skip_commit? do
+    callable_attr :skip_deploy? do
       ENV['TRAVIS_PULL_REQUEST'].to_i > 0 ||
-        %w[yes y true 1].include?(ENV['SKIP_COMMIT'].to_s.downcase)
+        %w[yes y true 1].include?((ENV['SKIP_DEPLOY'] || ENV['SKIP_COMMIT']).to_s.downcase) ||
+        (ENV['SOURCE_BRANCH'] && ENV['SOURCE_BRANCH'] != ENV['TRAVIS_BRANCH'])
     end
 
+    # For backward compatibility, remove in 2.x.
+    alias_method :skip_commit?, :skip_deploy?
+    alias_method :skip_commit=, :skip_deploy=
+
+    ##
+    # @!attribute ssh_key_file
+    # Defines path of the private SSH key to be used for communication with
+    # {#remote_url}. This is optional; when the file doesn't exist, then it's
+    # ignored.
+    #
+    # @note NEVER STORE YOUR PRIVATE SSH KEY IN THE REPOSITORY UNENCRYPTED!
+    #
+    # @return [String, Proc] path of the private SSH key (default: +.deploy_key+).
+    #
+    callable_attr :ssh_key_file, '.deploy_key'
+
 
     ##
     # @param name [#to_sym] name of the task to define.
@@ -231,6 +269,11 @@ module Rake::Jekyll
 
       yield self if block_given?
 
+      if ssh_key_file?
+        ENV['SSH_PRIVATE_KEY'] = "#{@working_dir}/#{ssh_key_file}"
+        ENV['GIT_SSH'] = "#{BIN_DIR}/git-ssh-wrapper"
+      end
+
       define_task!
     end
 
@@ -256,16 +299,15 @@ module Rake::Jekyll
             end
           end
 
-          puts "\nRunning Jekyll..."
-          jekyll_build[temp_dir]
+          build_script.call(temp_dir)
 
           Dir.chdir temp_dir do
             unless any_changes?
-              puts 'Nothing to commit.'; next
+              puts 'Nothing to commit and deploy.'; next
             end
 
-            if skip_commit?
-              puts 'Skipping commit.'; next
+            if skip_deploy?
+              puts 'Skipping deploy.'; next
             end
 
             if override_committer? || !config_set?('user.name')
@@ -284,5 +326,9 @@ module Rake::Jekyll
         yield
       end
     end
+
+    def ssh_key_file?
+      File.readable?(ssh_key_file)
+    end
   end
 end

data/lib/rake-jekyll/version.rb

@@ -1,5 +1,5 @@
 module Rake
   module Jekyll
-    VERSION = '1.0.4'
+    VERSION = '1.1.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rake-jekyll
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.1.0
 platform: ruby
 authors:
 - Jakub Jirutka
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-16 00:00:00.000000000 Z
+date: 2015-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -61,6 +61,7 @@ files:
 - LICENSE
 - README.adoc
 - Rakefile
+- bin/git-ssh-wrapper
 - lib/rake-jekyll.rb
 - lib/rake-jekyll/git_deploy_task.rb
 - lib/rake-jekyll/version.rb