make repository configurable

Author: X1011

deploy.sh

@@ -8,15 +8,35 @@ deploy_branch=gh-pages
 default_username=deploy.sh
 default_email=
 
+#repository to deploy to. must be readable and writable.
+repo=origin
+
 if [[ $1 = "-v" || $1 = "--verbose" ]]; then
-	#echo expanded commands as they are executed
-	set -o xtrace
+	verbose=true
 fi
 
+#echo expanded commands as they are executed (for debugging)
+function enable_expanded_output {
+	if [ $verbose ]; then
+		set -o xtrace
+		set +o verbose
+	fi
+}
+
+#this is used to avoid outputting the repo URL, which may contain a secret token
+function disable_expanded_output {
+	if [ $verbose ]; then
+		set +o xtrace
+		set -o verbose
+	fi
+}
+
+enable_expanded_output
+
 commit_title=`git log -n 1 --format="%s" HEAD`
 commit_hash=`git log -n 1 --format="%H" HEAD`
 
-set_user_id() {
+function set_user_id {
 	if [[ -z `git config user.name` ]]; then
 		git config user.name "$default_username"
 	fi
@@ -32,7 +52,9 @@ if ! git diff --exit-code --quiet --cached; then
 	exit 1
 fi
 
-git fetch --force origin $deploy_branch:$deploy_branch
+disable_expanded_output
+git fetch --force $repo $deploy_branch:$deploy_branch
+enable_expanded_output
 
 #make deploy_branch the current branch
 git symbolic-ref HEAD refs/heads/$deploy_branch
@@ -43,16 +65,19 @@ git --work-tree "$deploy_directory" reset --mixed --quiet
 git --work-tree "$deploy_directory" add --all
 
 set +o errexit
-git --work-tree "$deploy_directory" diff --exit-code --quiet HEAD
-diff=$?
+diff=$(git --work-tree "$deploy_directory" diff --exit-code --quiet HEAD)$?
 set -o errexit
 case $diff in
 	0) echo No changes to files in $deploy_directory. Skipping commit.;;
 	1)
 		set_user_id
 		git --work-tree "$deploy_directory" commit -m \
 			"publish: $commit_title"$'\n\n'"generated from commit $commit_hash"
-		git push origin $deploy_branch
+		
+		disable_expanded_output
+		#--quiet is important here to avoid outputting the repo URL, which may contain a secret token
+		git push --quiet $repo $deploy_branch
+		enable_expanded_output
 		;;
 	*)
 		echo git diff exited with code $diff. Aborting.

readme.md

@@ -1,11 +1,14 @@
 This is a script for deploying generated files to a git branch, such as when building a single-page app using [Yeoman](http://yeoman.io) and deploying to [GitHub Pages](http://pages.github.com). Unlike the [git-subtree approach](http://yeoman.io/deployment.html), it does not require the generated files be committed to the source branch. It keeps a linear history on the deploy branch and does not make superfluous commits or deploys when the generated files do not change.
 
+For an example of use, see [X1011/verge-mobile-bingo](https://github.com/X1011/verge-mobile-bingo).
+
 ## configuration
 Edit these variables at the top of the script to fit your project:
 
 - **deploy_directory**: root of the tree of files to deploy
 - **deploy_branch**: branch to commit files to and push to origin
 - **default_username**, **default_email**: identity to use for git commits if none is set already. Useful for CI servers.
+- **repo**: (optional) repository to deploy to. Must be readable and writable. The default of "origin" will not work on Travis CI, since it uses the read-only git protocol. In that case, it is recommended to store a [GitHub token](https://help.github.com/articles/creating-an-access-token-for-command-line-use) in a [secure environment variable](http://about.travis-ci.org/docs/user/build-configuration/#Secure-environment-variables) and use it in an HTTPS URL like this: <code>repo=https://$GITHUB_TOKEN@github.com/<i>user</i>/<i>repo</i>.git</code>
 
 ## setup
 This could be implemented in the script, but I don’t feel like doing it. Replace "dist" with your deploy_directory and "gh-pages" with your deploy_branch.