gulp plugin to publish contents to Github pages
npm install gulp-gh-pages-will
gulp plugin to publish contents to Github pages
``sh`
npm install --save-dev gulp-gh-pages
Define a deploy task in your gulpfile.js (as below) which can be used to push to gh-pages going forward.
`javascript
var gulp = require('gulp');
var ghPages = require('gulp-gh-pages');
gulp.task('deploy', function() {
return gulp.src('./dist/*/')
.pipe(ghPages());
});
`
Now, you should be able to call your task by doing:
`she`
gulp deploy
`javascript`
var ghPages = require('gulp-gh-pages');
options: Object Object
Return: (stream.Transform)
#### options.remoteUrl
Type: String
Default: URL for the remote of the current dir (assumes a git repository)
By default gulp-gh-pages assumes the current working directory is a git repository and uses its remote url. If your gulpfile.js is not in a git repository, or if you want to push to a different remote url, you can specify it. Ensure you have write access to the repository.
#### options.origin
Type: String "origin"
Default:
Git remote.
#### options.branch
Type: String "gh-pages"
Default:
The branch where deploy will by done. Change to "master" for username.github.io projects.
#### options.cacheDir
Type: String .publish
Default:
Set the directory path to keep a cache of the repository. If it doesn't exist, gulp-gh-pages automatically create it.
#### options.push
Type: Boolean true
Default:
Allow you to make a build on the defined branch without pushing it to master. Useful for dry run.
#### options.force
Type: Boolean false
Default:
Force adding files to the gh-pages branch, even if they are ignored by .gitignore or .gitignore_global.
#### options.message
Type: String "Update [timestamp]"`
Default:
Edit commit message.
Copyright (c) 2014 Micheal Benedict, 2015 Shinnosuke Watanabe
Licensed under the MIT License.