jekyll-git-deploy 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e9373d96cf9be3eb302f9463eab2503af3fdb65d
-  data.tar.gz: 6b15970dbdb092f1437a48d428060c6df2c63ee2
+  metadata.gz: 6a792c9d8b5cbacca308a02f042d8a83b36b5a8d
+  data.tar.gz: 04f2e047bec41b97c128dfddde4716af8ef8d301
 SHA512:
-  metadata.gz: de59a4f1666e02e22399de95379d35a328f25c85ea0f8dea7a1c1ca4585c9abb9c505c897d54636893858ddc796d4db89940a7288ba5b28c1b0efbdf5fca574c
-  data.tar.gz: bb36bab8c8691003868b9f2b3c018123e1229fbd47d135408f68a2cc5ad57971abfb437543f060bf872f5c4e203a7c1f1b3ddc560ecbe6179f17558e135c542e
+  metadata.gz: c3ba5482ad01bef953ca5815c07699aace8ed24c645a180160ccdd771890b7aa32a16f167c3b9d77304f404239b13d0daf39ebbc25e7ca522e4a6d0b69f19f39
+  data.tar.gz: 0dc5af353cf756a653d79276bb198037c47d61ca5d2482eb7e0500e635240cc26c7a845c42c5b7b0a346b2fab2f802eb73986272321f717a3c817bfbbb6f0068

data/README.md

@@ -0,0 +1,64 @@
+jekyll-git-deploy
+========
+Executable commands to help you to deploy your [jekyll](http://jekyllrb.com/) blog through git push way conveniently!
+
+### Getting Started
+1. Install The Gem
+  Install it through command line(recommended):
+  ```sh
+  gem install jekyll-git-deploy
+  ```
+  or, install it through the Gemfile:
+  ```ruby
+  gem 'jekyll-git-deploy', '~> 0.0.1'
+```
+
+2. Config Additional Keys In Your `_config.yml` file:
+  ```yaml
+  # #{site_root}/_config.yml
+  deploy_repo: git@something.com:martin/jekyll-deploy-demo.git
+  touch_file: Staticfile
+  deploy_branch: github-pages
+  deploy_remote_name: github
+  ```
+  More details about these configs will be described later.
+
+3. Initialize The Destination
+  Run the below command in the root of your jekyll site:
+  ```sh
+  jekyll-git-deploy init
+  ```
+
+4. Deploy The Site
+  ```sh
+  jekyll-git-deploy deploy
+  ```
+
+### More Details
+#### 1. Supported Commands
+Currently, `jekyll-git-deploy` supports its name as the main command and also two sub commands: `init` and `deploy`. They are mainly used to:
+
+* `init`: Check and create destination directory for your deployment, and then check and initialize a git repo there
+* `deploy`: Build the site using `jekyll build`, touch a specified file if necessary(some PaaS requires that a specifed name should be existed, they need that to detect a suitable running environment), create or checkout to deploy branch, commit changes and push them to specified repo and its branch.
+
+#### 2. Supported Configs
+`jekyll-git-deploy` dependent on five configs to work, the first one is `destination`, which is supported by jekyll itself already, here we use it to detect the target directory for generated site. The other four configs are:
+
+| Config             | Purpose                                                     | Default Value | Required |
+| --------           | --------                                                    | --------      | -------- |
+| deploy_repo        | Specify the deploy target, should be a remote git repo      | NONE          | YES      |
+| deploy_branch      | Specify the deploy target branch                            | pages         | NO       |
+| deploy_remote_name | Specify the remote name added to git, work with deploy_repo | deploy        | NO       |
+| touch_file         | Specify the file shoule be touched during a deployment      | Staticfile    | NO       |
+
+To see source codes, visit [Source codes for configs](./lib/helpers/common_tasks.rb).
+
+### Contribute Guides
+This project is just in its initial stage, more features or patches are welcome.
+
+1. Fork this repo;
+2. Clone your forked repo to your local file system;
+3. Check out to a new branch;
+4. Write and test your codes;
+5. Commit and push your changes to a remote branch in your forked repo;
+6. Submit a new PR.

data/jekyll-git-deploy.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'jekyll-git-deploy'
-  s.version     = '0.0.1'
+  s.version     = '0.0.2'
   s.date        = '2015-01-18'
   s.summary     = "Deploy jekyll site through git push"
   s.description = "Executable commands to help you to deploy your jekyll blog through git push way conveniently!"

data/lib/helpers/common_tasks.rb

@@ -30,6 +30,17 @@ module CommonTasks
     `git rev-parse --abbrev-ref HEAD`.strip
   end
 
+  def checkout_target_branch(quiet = false)
+    unless current_branch == deploy_branch
+      puts "\nStart to checkout to deploy branch: #{deploy_branch}".yellow unless quiet
+      if `git show-branch #{deploy_branch} 2> /dev/null`.empty?  # the deploy branch didn't exist
+        `git checkout -b #{deploy_branch}`
+      else
+        `git checkout #{deploy_branch}`
+      end
+    end
+  end
+
   def self.included(base)
     REQUIRED_CONFIGS.each do |method|
       define_method method do

data/lib/jekyll_git_deploy.rb

@@ -15,7 +15,7 @@ module JekyllGitDeploy
       raise "You haven't specify any deploy repo in _config.yml file, the action can not continue!".red
     end
 
-    file = File.open('.gitignore', 'r+')
+    file = File.open('.gitignore', 'a+')
     existed_line = file.readlines.select{|line| line.strip == destination}
     unless existed_line
       puts "\nadd #{destination} directory to .gitignore".yellow
@@ -37,6 +37,9 @@ module JekyllGitDeploy
       puts "\nCurrent git remotes:\n==========================".yellow
       puts `git remote -v`
 
+      puts "Fetch remote codes...".yellow
+      `git pull #{deploy_remote_name} #{deploy_branch}`
+
       puts "\nFinished deploy initialization for the current site".green
     end
   end
@@ -44,6 +47,16 @@ module JekyllGitDeploy
   # Build and push(deploy) the newest generated site
   #
   def deploy
+    # Pull the newest deploy data
+    Dir.chdir destination do
+      unless `git branch`.empty?
+        checkout_target_branch
+
+        puts "Updating remote deployed versions...".green
+        `git pull #{deploy_remote_name} #{deploy_branch}`
+      end
+    end
+
     puts "\nGenerating the newest site".yellow
     `jekyll build`
 
@@ -54,6 +67,7 @@ module JekyllGitDeploy
     end
 
     puts "\nruning `cd #{destination}`".yellow
+
     Dir.chdir destination do
       if `git branch`.empty?  # Fully new git repo
         commit_newest_site
@@ -61,20 +75,24 @@ module JekyllGitDeploy
         puts "\nThis is a new git repo, creating new branch #{deploy_branch} now".yellow
         `git checkout -b #{deploy_branch} &> /dev/null && git merge #{current_branch}`
       else
-        unless current_branch == deploy_branch
-          puts "\nStart to checkout to deploy branch: #{deploy_branch}".yellow
-          if `git show-branch #{deploy_branch} 2> /dev/null`.empty?  # the deploy branch didn't exist
-            `git checkout -b #{deploy_branch}`
-          else
-            `git checkout #{deploy_branch}`
-          end
-        end
-
+        checkout_target_branch
         commit_newest_site
       end
 
       puts "\nPushing newest generated site:".yellow
-      `git push -u #{deploy_remote_name} #{deploy_branch}`
+      push_result = `git push -u #{deploy_remote_name} #{deploy_branch} 2>&1`
+      if push_result.include?("Updates were rejected because the remote contains work")
+        print "Oops! It seems there are some updates exist in the remote repo so that your pushing has been rejected, do you want to force to update?[Y/N]".red
+        if STDIN.gets.chomp.to_s.downcase == 'y'
+          puts "Try to force to update remote repo...".yellow
+          `git push -f #{deploy_remote_name} #{deploy_branch}`
+        else
+          puts "You have canceled the deploy process, you need to manually merge remote updates before deploy!".yellow
+          exit
+        end
+      else
+        puts push_result
+      end
 
       puts "\nThe deploy is finished!".green
       baseurl = read_configs['baseurl'] || ""

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-git-deploy
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Martin Hong
@@ -18,7 +18,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- README.md
 - bin/jekyll-git-deploy
 - jekyll-git-deploy.gemspec
 - lib/helpers/common_tasks.rb
@@ -34,18 +35,19 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Deploy jekyll site through git push
 test_files: []
+has_rdoc: