ghsync

This is a cli tool to sync local git repository and remote GitHub repository automatically.

For example, if your tech team and biz team share some codebase, tech team wants to manage it with git (and GitHub) but biz team wants to edit files directly via FTP, right?

You can resolve this problem with ghsync.

At first, initialize your codebase on the FTP server as a local git repository and push them to GitHub.
Let ghsync observe your local git repository and remote GitHub repository by starting ghsync server.
if your biz team edits files directly, ghsync automatically git add, git commit and git push.
if your tech team pushes some commits to GitHub, ghsync catches the webhook and automatically git pull.

Additionally, if some auto-push and auto-pull conflict, ghsync stops observing and sends you a notification email. So you don't have to worry about that ghsync destroys your codebase.

Requirements

This tool requires local git version 1.7.9.6 or later for using --no-edit option for git pull.

Installation

$ npm install -g ghsync

If you install with sudo --unsafe-perm is required to generate config file after installation automatically.

$ sudo npm install -g ghsync --unsafe-perm

Configuration

$ vi ~/.ghsync/config/default.json

Required properties

Remote GitHub repository's name
Local git repository directory's path
GitHub webhook secret

Optional properties

Some local sub directories' paths you want to ignore in observing
Port number for catching GitHub webhook
Commit interval (When many files are directly edited at one time, ghsync waits a moment to git commit so that prevents creating many commits uselessly)
Email notification related settings

Usage

At first, configure webhook on GitHub.

And start ghsync server on your server.

$ ghsync

That's it.

When local git repository are directly edited ghsync commits it with message "Automatically committed". And When remote GitHub repository is updated ghsync pulls it soon.

Daemonize

You may want to run ghsync background. It's an easy way for that to use forever.

# install forever
$ npm install -g forever

# run ghsync via forever
$ NODE_CONFIG_DIR=~/.ghsync/config forever start $(which ghsync)

# confirm process is running
$ forever list
info:    Forever processes running
data:        uid  command             script                forever pid   id logfile                      uptime
data:    [0] H7wO /usr/local/bin/node /usr/local/bin/ghsync 59716   59726    /home/user/.forever/H7wO.log 0:0:0:2.636

You can stop daemon by like below.

$ forever stop 0

Please learn more at forever GitHub repository.

Email notification

If some auto-push and auto-pull conflict, ghsync stops observing and sends you a notification email like below.

Subject: [ghsync] Error occurred in auto git-pull

[path]
/path/to/local/repo

[stdout]
Auto-merging 1
CONFLICT (content): Merge conflict in 1
Automatic merge failed; fix conflicts and then commit the result.

[stderr]
From github.com:owner/repo
 * branch            master     -> FETCH_HEAD
   1c35585..759c171  master     -> origin/master

Then you should go to your server and resolve conflict by hand, and commit and push it.

After you push it, auto-pull runs because remote GitHub repository is updated just now by you, and this pull will get successful. Then, ghsync starts observing again automatically.

hirokishirai/ghsync