auto-git-pull

Schedules fetching all repos in a working folder from Git, and optionally pulls changes if there are no conflicts.

auto-git-pull relies on the Git command line tools being installed and runable without interaction. If you can run 'git pull' in a command window, you can run this.

It's frustrating to try to push code to git, only to be told that your version isn't up to date and you must pull changes first. This script automates that pulling so you are always up to date.

Installation

$ npm install -g auto-git-pull

Tell auto-git-pull where your repos are:

$ auto-git-pull --set-projects-directory ./

or

$ auto-git-pull --set-projects-directory /absolute/path/to/projects

Usage

Available commands:

--set-projects-directory  | -spd    <PATH>

--fetch                   | -f
--fetch-silent            | -fs
--pull                    | -p
--pull-silent             | -ps
--status                  | -s

--schedule-fetch-task     | -ft
--schedule-pull-task      | -pt

--add-include             | -ai     <PATH>
--remove-include          | -ri     <PATH>
--show-includes           | -si
--clear-includes          | -ci

--add-exclude             | -ax     <PATH>
--remove-exclude          | -rx     <PATH>
--show-excludes           | -sx
--clear-excludes          | -cx

--show-logs               | -sl

--help                    | -h

Example usage:

$ auto-git-pull -spd /Users/you/Documents/GitHub
$ auto-git-pull -p
$ auto-git-pull -pt

Notes:

• You must set a projects directory before fetching or pulling.

  This should be the root folder of your Git projects.

• The 'Pull' command performs a fetch & pull.

• 'Pull' will only attempt to pull changes if there are no conflicts or changes to the local tree.

• The more out of date a repo is, the longer it will take to fetch and pull.

• To fetch from only a subset of projects,

  either add each project using --add-include <PATH>

  (which means the main projects directory will be ignored),

  or exclude paths from the main projects directory using --add-exclude <PATH>

• To automate the process, use --schedule-pull-task to schedule a recurring pull task every 2 minutes.

• A log of operations is kept in the logs directory at the root of the project.

• To see the most recent logs, use the --show-logs switch

Tests

$ npm test

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code.

Release History

• 0.1.0 Initial release.
• 0.1.2 Fix bug in git where folder isn't a true repo
• 0.2.0 Show recent logs
• 0.2.1 Update logging dependency