middleman-gh-pages 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e0d79113909c3b269d4b1ebd04e5753bf7c4430
-  data.tar.gz: e56c32ff8116c180d9c2bf33b7a80df63211b17f
+  metadata.gz: 1f29f5382e9666ebf6c1917a1875f5ff3e200075
+  data.tar.gz: 12f1f870fb7b8810628cd997908ba1f48f9a57b5
 SHA512:
-  metadata.gz: f96911891076c34bfb013c89dce3b55d3fe3ab35b38bdc385ecc0988882051d2fb03a6a6ca1a4014d422c2b1cc1f3a14cb4602dc551f0a3991b5cf24742b5777
-  data.tar.gz: 74f962062a72aa1b9cd650edac9b076791d08b053af510b0ed4c14c491dc6ee738e2269c646f49dc284622cd25fcebe9c37404f3b0fadb368e5e4261b386d56c
+  metadata.gz: d8e3cf04aec8c079224eeaa9791e5ff397cfeaea7254dea60e820deb6747d5be6185156f7b272e2d02382a103f9e8cc801a6e9bc90bbfc0652eb4dc546ec5d27
+  data.tar.gz: df54a775f2ff4ee3a44d46cfa9b178e32da211934bde43dc0562e995a60e5d8f2566ee83b2565bf3e789b736950e88d3216deeb776c77f94a954da84a6ff6947

data/README.md

@@ -1,7 +1,9 @@
 # Middleman Github Pages
 
-[Middleman](http://middlemanapp.com) makes creating static sites a joy, [Github
-Pages](http://pages.github.com) hosts static sites for free, Middleman Github
+[![Gem Version](https://img.shields.io/gem/v/middleman-gh-pages.svg)](https://rubygems.org/gems/middleman-gh-pages)
+
+[Middleman](https://middlemanapp.com/) makes creating static sites a joy, [Github
+Pages](https://pages.github.com/) hosts static sites for free, Middleman Github
 Pages brings the two together. Middleman Github Pages is just a few rake tasks
 that automate the process of deploying a Middleman site to Github Pages.
 
@@ -32,36 +34,78 @@ The only assumption is that you are deploying to a gh-pages branch in the same
 remote as the source. `rake publish` will create this branch for you if it
 doesn't exist.
 
-## Options
+## Environment Variable Options
 
-You cannot deploy your site if you have uncommitted changes. You can
-override this with the `ALLOW_DIRTY` option:
+### `ALLOW_DIRTY`
 
-```shell
+You cannot deploy your site if you have uncommitted changes, but you can
+override this (default: `nil`):
+
+```
 bundle exec rake publish ALLOW_DIRTY=true
 ```
 
-You can append a custom suffix to commit messages on the build branch:
+### `COMMIT_MESSAGE_SUFFIX`
 
-```shell
+You can append a custom suffix to commit messages on the build branch
+(default: `nil`):
+
+```
 bundle exec rake publish COMMIT_MESSAGE_SUFFIX="[skip-ci]"
 ```
 
-You can change the remote that you deploy to:
+### `REMOTE_NAME`
 
-```shell
+You can change the remote that you deploy to (default: `origin`):
+
+```
 bundle exec rake publish REMOTE_NAME=upstream
 ```
 
-If you're publishing a personal or organization page, you may want to use the branch `master` instead of `gh-pages`:
+### `BRANCH_NAME`
 
-```shell
+If you're publishing a personal or organization page, you may want to use the
+branch `master` instead of `gh-pages` (default: `gh-pages`):
+
+```
 bundle exec rake publish BRANCH_NAME=master
 ```
 
+### `PROJECT_ROOT`
+
+If your middleman project isn't at the root of your repository, you will
+likely need to change this (default: _root of git repository_):
+
+```
+bundle exec rake publish PROJECT_ROOT=/Users/me/projects/repo/www
+```
+
+### `BUILD_DIR`
+
+If you override the default middlemant `:build_dir` setting, you will likely
+also need to set this variable (default: `<PROJECT_ROOT>/build`):
+
+```
+bundle exec rake publish BUILD_DIR=/some/custom/path/to/public
+```
+
+### Setting ENV variables from your Rakefile
+
+Of course, for more permanent settings, you can always set these environment
+variables directly in your `Rakefile` instead of from the command line.
+
+```ruby
+require "middleman-gh-pages"
+
+# Ensure builds are skipped when publishing to the gh-pages branch
+ENV["COMMIT_MESSAGE_SUFFIX"] = "[skip ci]"
+# Ignore errors about dirty builds (not recommended)
+ENV["ALLOW_DIRTY"] = "true"
+```
+
 ## Custom Domain
 
-To set up a custom domain, you can follow the [GitHub help page](https://help.github.com/articles/setting-up-a-custom-domain-with-pages).
+To set up a custom domain, you can follow the [GitHub help page](https://help.github.com/articles/setting-up-a-custom-domain-with-github-pages/).
 
 __NOTE__ You will need to put your CNAME file in the `source` directory of your middleman project, NOT in its root directory. This will result in the CNAME file being in the root of the generated static site in your gh-pages branch.
 
@@ -69,8 +113,10 @@ __NOTE__ You will need to put your CNAME file in the `source` directory of your
 
 Since project pages deploy to a subdirectory, assets and page paths are relative to the organization or user that owns the repo. If you're treating the project pages as a standalone site, you can tell Middleman to generate relative paths for assets and links with these settings in the build configuration in `config.rb`
 
-    activate :relative_assets
-    set :relative_links, true
+``` ruby
+activate :relative_assets
+set :relative_links, true
+```
 
 __NOTE__ This only affects sites being accessed at the `username.github.io/projectname` URL, not when accessed at a custom CNAME.
 

data/lib/middleman-gh-pages/tasks/gh-pages.rake

@@ -14,7 +14,8 @@ def uncommitted_changes?
 end
 
 def backup_and_restore(dir, file, &block)
-  yield unless File.exist?(File.join(dir, file))
+  return yield unless File.exist?(File.join(dir, file))
+
   Dir.mktmpdir do |tmpdir|
     mv File.join(dir, file), tmpdir
     yield
@@ -38,7 +39,7 @@ file GH_PAGES_REF => BUILD_DIR do
   cd BUILD_DIR do
     sh "git init"
     sh "git remote add #{remote_name} #{repo_url}"
-    sh "git fetch #{remote_name}"
+    sh "git fetch --depth 1 #{remote_name} #{branch_name}"
 
     if `git branch -r` =~ /#{branch_name}/
       sh "git checkout #{branch_name}"
@@ -58,7 +59,7 @@ task :prepare_build_dir => GH_PAGES_REF
 # Fetch upstream changes on gh-pages branch
 task :sync_build_dir => :prepare_build_dir do
   cd BUILD_DIR do
-    sh "git fetch #{remote_name}"
+    sh "git fetch --depth 1 #{remote_name} #{branch_name}"
     sh "git reset --hard #{remote_name}/#{branch_name}"
   end
 end

data/lib/middleman-gh-pages/version.rb

@@ -1,5 +1,5 @@
 module Middleman
   module GithubPages
-    VERSION = "0.2.0"
+    VERSION = "0.3.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: middleman-gh-pages
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Adam McCrea
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-16 00:00:00.000000000 Z
+date: 2016-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake