lukekarrys/git-directory-deploy lukekarrys/git-directory-deploy

Deploy a git directory to a branch.

Host: GitHub

License: MIT

Language: Shell

Keywords: deploy, git, github, pages, directory


Build Status NPM

Deploy a subdirectory from a git repo to a different branch. Useful to deploy to GitHub Pages.


The shell script portion of this code is from X1011/git-directory-deploy, and it's best explained in that README:

Unlike the git-subtree approach, 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.

This repo accomplishes a few other things:

  • Named cli args
  • Publish it to npm so I can use it as a devDep in projects


I normally use it like this:

cd project/ # Assumes a git directory with a package.json
echo _build >> .gitignore
npm install git-directory-deploy --save-dev
touch build.js # For however you want to build your static files

Then add these scripts to package.json:

"scripts": {
  "build": "node build.js", // should write files to _build/
  "deploy": "npm run build && git-directory-deploy --directory _build/"

Then: npm run deploy!

Check out npm-v0-finder for an example.


For global use:

npm install -g git-directory-deploy

cd projects/i-want-to-deploy/

git-directory-deploy --directory _dist --branch gh-pages

Or for use in via npm run-script:

npm install git-directory-deploy --save-dev

and then use it in your package.json likes this:

"scripts": {
    "deploy": "git-directory-deploy --directory _dist --branch gh-pages"


git-directory-deploy [args]

--directory [_site]

The subdirectory to deploy. Defaults to _site/.

--branch [gh-pages]

The branch that will receive the deploy. Defaults to gh-pages.

--repo [origin]

The repo to push the deploy to. Defaults to origin.

--username [git config]

The username that will be associated with the deploy commit. This will always be set to the current from git config, but if that is not set, then it can be set via this flag.

--email [git config]

The email that will be associated with the deploy commit. This will always be set to the current from git config, but if that is not set, then it can be set via this flag.


Append something to the commit message. The message will look like this:


generated from commit $COMMIT_HASH


Be louder.


Allow the --directory to be empty.


Deploy will not override files that are in the remote repo but not in the deploy directory.



The script at bin/ is Copyright Daniel Smith. See the file for terms.


Kind Requirements Latest Stable Latest Release Licenses
git-validate development ^2.1.4 2.2.2 2.2.2 MIT
lodash runtime ^4.14.2 4.17.4 4.17.4 MIT
minimist runtime ^1.1.0 1.2.0 1.2.0 MIT
standard development ^7.1.2 10.0.2 10.0.2 MIT
tap-spec development ^4.1.1 4.1.1 4.1.1 MIT
tape development ^4.6.0 4.6.3 4.6.3 MIT

Project Statistics

Sourcerank 11
Size 20.5 KB
Stars 28
Forks 5
Watchers 2
Open issues 0
Dependencies 6
Contributors 4
Tags 9
Last updated
Last pushed

Top Contributors See all

Luke Karrys Keith Cirkel Mikey Daniel Schmidt

Projects Referencing this Repo

git-directory-deploy 1.5.1
Deploy a git directory to a branch.
npm - Shell - MIT - Updated - 28 stars

Tags See all

v1.5.1 August 08, 2016
v1.5.0 March 02, 2016
v1.4.0 January 05, 2016
v1.3.0 October 08, 2015
v1.2.1 August 28, 2015
v1.2.0 August 27, 2015
v1.1.0 February 12, 2015
v1.0.1 February 12, 2015
v1.0.0 February 08, 2015

Something wrong with this page? Make a suggestion

Last synced: 2016-08-08 19:34:07 UTC