girror v0.2.11

girror - Efficient mirrorring of git remotes

girror maintains mirrors of git repositories on the local system using a bare repository cache. This makes it especially useful to handle post-commit triggers and automatically pull changes from a remote.

$ npm install -g girror
$ girror --remote git@github.com/eladb/node-girror --worktree /tmp/node-girror-master
$ girror --remote git@github.com/eladb/node-girror --worktree /tmp/node-girror-branch1 --branch branch1

Command line tool

$ girror --help

  Usage: girror [options]

  Options:

    -h, --help             output usage information
    -r, --remote <url>     git remote url (required)
    -w, --worktree <path>  path to worktree (required)
    -b, --branch <branch>  branch to mirror (default: master)
    -v, --verbose          verbose output

API

girror(remote, worktree, options, callback)

• remote - the URL of the git remote
• worktree - path to local working directory (where you want files to be checked out into)
• options.branch - branch to checkout (default is master)
• options.cachedir - where to store the bare repo cache that makes girror so awesome (default is $GIRROR_CACHE || ($TMP || $TEMP || /tmp)/girror-cache)
• options.logger - optional alternative to console.

Using girror for continuous deployment

girror was built to enable automatic deployment from source control:

1. Set up a post-commit HTTP trigger on your favorite source control that will POST into some endpoint on your servers.
2. Invoke girror to sync from the remote repository into the local filesystem. girror will do it as efficiently and painlessly as possible (no merges, no cleanups, only clean diffs).
3. You can also use it to sync multiple branches into your production servers and use them as staging environments (yeah!).

I will create a "girror-middleware" for express so you can just plug it in and have all this automated.

License

MIT