gulp-gh-pages

gulp-gh-pages

Gulp plugin to publish to Github pages.

Usage

First, install gulp-gh-pages as a development dependency

npm install --save-dev gulp-gh-pages

If your repository does not have a gh-pages branch, it is advised that you create one first. I used git subtree push --prefix <dist folder> origin gh-pages.

Then define a deploy task in your gulpfile.js (as below) which can be used to push to gh-pages going forward.

var deploy = require("gulp-gh-pages");

gulp.task('deploy', function () {
	gulp.src("./dist/**/*")
		.pipe(deploy(gitRemoteUrl, remote));
});

API

Two different signatures are supported.

deploy(remoteUrl, remote)

remoteUrl

Type: String Required: true

Your git remote url. Ensure you have write access to the repository.

remote

Type: String Default: "origin"

Git remote.

---

deploy(options)

options.remoteUrl

Type: String Default: undefined Required: true

Your git remote url. Ensure you have write access to the repository.

options.origin

Type: String Default: "origin"

Git remote.

options.branch

Type: String Default: "gh-pages"

The branch where deploy will by done. Change to "master" for username.github.io projects.

options.cacheDir

Type: String Default: a temporary folder

Useful to keep a cache of the repo to avoid fresh clone all the time.

options.push

Type: Boolean Default: true

Allow you to make a build on the defined branch without pushing it to master. Useful for dry run.

License

MIT License