middleman-gh-pages 0.0.2 → 0.0.3

data/README.md

@@ -9,7 +9,7 @@ that automate the process of deploying a Middleman site to Github Pages.
 
 Add this line to your Gemfile:
 
-```shell
+```ruby
 gem 'middleman-gh-pages'
 ```
 
@@ -32,13 +32,42 @@ 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.
 
-Note that you cannot deploy your site if you have uncommitted changes. You can
+## Options
+
+You cannot deploy your site if you have uncommitted changes. You can
 override this with the `ALLOW_DIRTY` option:
 
 ```shell
 bundle exec rake publish ALLOW_DIRTY=true
 ```
 
+You can append a custom suffix to commit messages on the build branch:
+
+```shell
+bundle exec rake publish COMMIT_MESSAGE_SUFFIX="--skip-ci"
+```
+
+You can change the remote that you deploy to:
+
+```shell
+bundle exec rake publish REMOTE_NAME=upstream
+```
+
+## 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).
+
+__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.
+
+## Project Page Path Issues
+
+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
+
+__NOTE__ This only affects sites being accessed at the `username.github.io/projectname` URL, not when accessed at a custom CNAME.
+
 ## Contributing
 
 1. Fork it

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

@@ -1,8 +1,12 @@
 require 'fileutils'
 
+def remote_name
+  ENV.fetch("REMOTE_NAME", "origin")
+end
+
 PROJECT_ROOT = `git rev-parse --show-toplevel`.strip
 BUILD_DIR    = File.join(PROJECT_ROOT, "build")
-GH_PAGES_REF = File.join(BUILD_DIR, ".git/refs/remotes/origin/gh-pages")
+GH_PAGES_REF = File.join(BUILD_DIR, ".git/refs/remotes/#{remote_name}/gh-pages")
 
 directory BUILD_DIR
 
@@ -10,13 +14,14 @@ file GH_PAGES_REF => BUILD_DIR do
   repo_url = nil
 
   cd PROJECT_ROOT do
-    repo_url = `git config --get remote.origin.url`.strip
+    repo_url = `git config --get remote.#{remote_name}.url`.strip
   end
 
   cd BUILD_DIR do
     sh "git init"
-    sh "git remote add origin #{repo_url}"
-    sh "git fetch origin"
+    sh "git remote add #{remote_name} #{repo_url}"
+    sh "git fetch #{remote_name}"
+    sh "git checkout master"
 
     if `git branch -r` =~ /gh-pages/
       sh "git checkout gh-pages"
@@ -25,7 +30,7 @@ file GH_PAGES_REF => BUILD_DIR do
       sh "touch index.html"
       sh "git add ."
       sh "git commit -m 'initial gh-pages commit'"
-      sh "git push origin gh-pages"
+      sh "git push #{remote_name} gh-pages"
     end
   end
 end
@@ -36,8 +41,8 @@ task :prepare_git_remote_in_build_dir => GH_PAGES_REF
 # Fetch upstream changes on gh-pages branch
 task :sync do
   cd BUILD_DIR do
-    sh "git fetch origin"
-    sh "git reset --hard origin/gh-pages"
+    sh "git fetch #{remote_name}"
+    sh "git reset --hard #{remote_name}/gh-pages"
   end
 end
 
@@ -59,10 +64,11 @@ end
 desc "Build and publish to Github Pages"
 task :publish => [:not_dirty, :prepare_git_remote_in_build_dir, :sync, :build] do
   message = nil
+  suffix = ENV["COMMIT_MESSAGE_SUFFIX"]
 
   cd PROJECT_ROOT do
     head = `git log --pretty="%h" -n1`.strip
-    message = "Site updated to #{head}"
+    message = ["Site updated to #{head}", suffix].compact.join("\n\n")
   end
 
   cd BUILD_DIR do
@@ -72,6 +78,6 @@ task :publish => [:not_dirty, :prepare_git_remote_in_build_dir, :sync, :build] d
     else
       sh "git commit -m \"#{message}\""
     end
-    sh "git push origin gh-pages"
+    sh "git push #{remote_name} gh-pages"
   end
 end

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

@@ -1,5 +1,5 @@
 module Middleman
   module GithubPages
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: middleman-gh-pages
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-14 00:00:00.000000000 Z
+date: 2014-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -63,8 +63,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Easy deployment of Middleman sites to Github Pages
 test_files: []
+has_rdoc: