# gulp-git-deploy

> Run deploy tasks with gulp if there are any changes on the Git repo.

Latest version **1.5.2** (published 2015-06-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install gulp-git-deploy
pnpm add gulp-git-deploy
yarn add gulp-git-deploy
bun add gulp-git-deploy
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.5.2 |
| Published | 2015-06-30 |
| First published | 2015-05-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Agualbbus |
| Maintainers | agualbbus |
| Keywords | gulp, git, deploy, gitdeploy, gulpgit, gulpplugin, gulp-plugin |

## Links

- npm: https://www.npmjs.com/package/gulp-git-deploy
- Repository: git@github.com:agualbbus/gulp-git-deploy
- Homepage: https://github.com/agualbbus/gulp-git-deploy
- Issues: https://github.com/agualbbus/gulp-git-deploy/issues
- npm.io page: https://npm.io/package/gulp-git-deploy

## Dependencies (3)

- [gulp-util](https://npm.io/package/gulp-util.md) ^3.0.1
- [exec-chainable](https://npm.io/package/exec-chainable.md) 0.0.3
- [any-shell-escape](https://npm.io/package/any-shell-escape.md) ^0.1.1

## Recent versions

- 1.5.2 (latest) — 2015-06-30
- 1.5.1 — 2015-06-30
- 1.5.0 — 2015-06-30
- 1.4.1 — 2015-05-28
- 1.4.0 — 2015-05-28
- 1.3.1 — 2015-05-28
- 1.3.0 — 2015-05-28
- 1.2.2 — 2015-05-26
- 1.2.1 — 2015-05-26
- 1.2.0 — 2015-05-26
- 1.1.3 — 2015-05-26
- 1.1.2 — 2015-05-26
- 1.1.1 — 2015-05-26
- 1.1.0 — 2015-05-26
- 1.0.1 — 2015-05-26
- … 1 more at https://npm.io/package/gulp-git-deploy/versions

## README

# gulp-git-deploy

CirlceCI:[![Circle CI](https://circleci.com/gh/agualbbus/gulp-git-deploy/tree/master.svg?style=shield)](https://circleci.com/gh/agualbbus/gulp-git-deploy/tree/master)
DroneIO:[![Build Status](https://drone.io/github.com/agualbbus/gulp-git-deploy/status.png)](https://drone.io/github.com/agualbbus/gulp-git-deploy/latest)
BadgeFuryIO:[![npm version](https://badge.fury.io/js/gulp-git-deploy.svg)](http://badge.fury.io/js/gulp-git-deploy)

<table>
<tr>
<td>Package</td><td>gulp-git-deploy</td>
</tr>
<tr>
<td>Description</td>
<td>Run deploy tasks with gulp if there are any changes on the Git repo. (gulpjs.com)</td>
</tr>
<tr>
<td>Node Version</td>
<td>>= 0.9</td>
</tr>
<tr>
<td>Gulp Version</td>
<td>3.x</td>
</tr>
</table>

## Usage

### Install

    npm install gulp-git-deploy --save

## Example

```javascript
var gulp = require('gulp');
var gitDeploy = require('gulp-git-deploy');


gulp.task('build', function(){
 //your build stuff.
})

gulp.task('deploy',function(){

  return gitDeploy({remote: 'origin', name: 'master'}, function(){
    //put here whatever you want to do after merging, usually a build task.
    gulp.start('build')
  });

})


```

## Options

### remote

Set the git remote

Type: `string`

Default:`'origin'`

### name

Set the branch name

Type: `string`

Default: `'master'`

### reset

Reset head position(discards any change to your branch).

Type: `boolean`

Default: `true`

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