# git-auto-pull

> Little javascript utility to automatically do a 'git pull' on a server when something new is pushed to the git repository

Latest version **1.0.9** (published 2016-08-02) · MIT license · 0 weekly downloads

## Install

```sh
npm install git-auto-pull
pnpm add git-auto-pull
yarn add git-auto-pull
bun add git-auto-pull
```

## 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.0.9 |
| Published | 2016-08-02 |
| First published | 2016-07-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 67 |
| Maintainers | henauxg |
| Keywords | git |

## Links

- npm: https://www.npmjs.com/package/git-auto-pull
- Repository: https://github.com/Keenpoint/git-auto-pull
- Homepage: https://github.com/Keenpoint/git-auto-pull#readme
- Issues: https://github.com/Keenpoint/git-auto-pull/issues
- npm.io page: https://npm.io/package/git-auto-pull

## Dependencies (1)

- [async](https://npm.io/package/async.md) ^2.0.0

## Recent versions

- 1.0.9 (latest) — 2016-08-02
- 1.0.8 — 2016-08-02
- 1.0.7 — 2016-08-02
- 1.0.6 — 2016-08-02
- 1.0.5 — 2016-07-25
- 1.0.4 — 2016-07-22
- 1.0.3 — 2016-07-21
- 1.0.2 — 2016-07-21
- 1.0.1 — 2016-07-21
- 1.0.0 — 2016-07-21

## README

# Git-auto-pull

## What is it ?


In short, git-auto-pull is a little javascript utility to automatically do a 'git pull'  on a server when something new is pushed to the git repository.


## Usage

#### Get it

```
npm install git-auto-pull
```

or

```
git clone https://github.com/Keenpoint/git-auto-pull
```

#### Prepare it

You should create a git post-receive hook (see https://git-scm.com/book/it/v2/Customizing-Git-Git-Hooks) in the hook directory of your git repository. It could be like this:

```sh
#!/bin/sh

curl here.the.ip.of.the.machine:1337
```
`here.the.ip.of.the.machine` being the ip of the machine containing the project to update and 1337 is the port listened by git-auto-pull (by default).

Or if you have multiple branches and you just want to update the server when a change occurs on master:

```sh
#!/bin/bash
while read oldrev newrev refname
do
    branch=$(git rev-parse --symbolic --abbrev-ref $refname)
    if [ "master" == "$branch" ]; then
        curl here.the.ip.of.the.machine:1337
    fi
done
```
(As found on: http://stackoverflow.com/questions/7351551/writing-a-git-post-receive-hook-to-deal-with-a-specific-branch by Pauljz)

#### Run it

```sh
node git-auto-pull.js relative/Path/To/Your/Project [cmds]
```

[**cmds**] : Optionnal parameters.
You can add some commands to be executed in the given order after the git pull.
The commands are executed from the given `relative/Path/To/Your/Project` project directory.

*Ex:*
```sh
node git-auto-pull.js ../myProject "gulp build"
```
Here, the script will execute git pull in your project and then build it with gulp.

## License

This project is licensed under the terms of the MIT license.

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