gulp-gh-pages v0.5.4
gulp-gh-pages
gulp plugin to publish contents to Github pages
Installation
npm install --save-dev gulp-gh-pages
Usage
Define a deploy
task in your gulpfile.js
(as below) which can be used to push to gh-pages
going forward.
const gulp = require('gulp');
const ghPages = require('gulp-gh-pages');
gulp.task('deploy', () => gulp.src('./dist/**/*').pipe(ghPages()));
Now, you should be able to call your task by doing:
gulp deploy
API
const ghPages = require('gulp-gh-pages');
ghPages(options)
options: 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
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: .publish
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
Default: true
Allow you to make a build on the defined branch without pushing it to master. Useful for dry run.
options.force
Type: boolean
Default: false
Force adding files to the gh-pages
branch, even if they are ignored by .gitignore
or .gitignore_global
.
options.message
Type: String
Default: "Update [timestamp]"
Edit commit message.
License
MIT License © 2014 Micheal Benedict, 2015 - 2018 Shinnosuke Watanabe
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago