# gulp-gh-pages

> gulp plugin to publish contents to Github pages

Latest version **0.5.4** (published 2015-10-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install gulp-gh-pages
pnpm add gulp-gh-pages
yarn add gulp-gh-pages
bun add gulp-gh-pages
```

## Health

**Score 23/100 (F)** — status: abandoned.

Positive: has types package; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.5.4 |
| Published | 2015-10-20 |
| First published | 2014-03-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/gulp-gh-pages) |
| Module format | CommonJS |
| Dependencies | 6 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 605 |
| Author | Micheal Benedict |
| Maintainers | rowoot, shinnn |
| Keywords | git, push, commit, branch, deploy, deployment, publish, site, website, gulp, gulpplugin, gh-pages, dist, github |

## Links

- npm: https://www.npmjs.com/package/gulp-gh-pages
- Repository: https://github.com/shinnn/gulp-gh-pages
- Homepage: https://github.com/shinnn/gulp-gh-pages#readme
- Issues: https://github.com/shinnn/gulp-gh-pages/issues
- npm.io page: https://npm.io/package/gulp-gh-pages

## Dependencies (6)

- [gift](https://npm.io/package/gift.md) ^0.6.1
- [rimraf](https://npm.io/package/rimraf.md) ^2.4.3
- [vinyl-fs](https://npm.io/package/vinyl-fs.md) ^2.2.1
- [gulp-util](https://npm.io/package/gulp-util.md) ^3.0.7
- [wrap-promise](https://npm.io/package/wrap-promise.md) ^1.0.1
- [readable-stream](https://npm.io/package/readable-stream.md) ^2.0.2

## Recent versions

- 0.5.4 (latest) — 2015-10-20
- 0.6.0-6 (next) — 2018-08-14
- 0.6.0-5 — 2018-08-07
- 0.6.0-4 — 2018-08-07
- 0.6.0-3 — 2018-08-02
- 0.6.0-2 — 2018-07-31
- 0.6.0-1 — 2018-07-13
- 0.6.0-0 — 2018-07-13
- 0.5.3 — 2015-10-10
- 0.5.2 — 2015-06-03
- 0.5.1 — 2015-04-17
- 0.5.0 — 2015-03-13
- 0.4.0 — 2014-10-06
- 0.3.4 — 2014-09-08
- 0.3.3 — 2014-06-30
- … 10 more at https://npm.io/package/gulp-gh-pages/versions

## README

# gulp-gh-pages

[![NPM version](http://img.shields.io/npm/v/gulp-gh-pages.svg)](https://www.npmjs.com/package/gulp-gh-pages)
[![Build Status](https://travis-ci.org/shinnn/gulp-gh-pages.svg?branch=master)](https://travis-ci.org/shinnn/gulp-gh-pages)
[![Build status](https://ci.appveyor.com/api/projects/status/iskj8sml9luhkm21?svg=true)](https://ci.appveyor.com/project/ShinnosukeWatanabe/gulp-gh-pages)
[![Coverage Status](https://img.shields.io/coveralls/shinnn/gulp-gh-pages.svg)](https://coveralls.io/r/shinnn/gulp-gh-pages)
[![Dependency Status](https://img.shields.io/david/shinnn/gulp-gh-pages.svg?label=deps)](https://david-dm.org/shinnn/gulp-gh-pages)
[![devDependency Status](https://img.shields.io/david/dev/shinnn/gulp-gh-pages.svg?label=devDeps)](https://david-dm.org/shinnn/gulp-gh-pages#info=devDependencies)

[gulp](http://gulpjs.com/) plugin to publish contents to [Github pages](https://pages.github.com/)

## Installation

[Use npm](https://docs.npmjs.com/cli/install).

```sh
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.

```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
```

## API

```javascript
var ghPages = require('gulp-gh-pages');
```

### ghPages([*options*])

*options*: `Object`  
Return: `Object` ([stream.Transform](https://nodejs.org/api/stream.html#stream_class_stream_transform_1))

#### 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

Copyright (c) 2014 [Micheal Benedict](https://github.com/rowoot), 2015 [Shinnosuke Watanabe](https://github.com/shinnn)

Licensed under [the MIT License](./LICENSE).

---
_Source: https://npm.io/package/gulp-gh-pages · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._