Git Sync

Local application that discovers all git repositories within given base folder and performs git pull on each of them.

Prerequisites

• python 3.6
• (pip install gitpython)
• (pip install logging)
• no password has to be required to access git repositories otherwise git pull will fail

How to configure git repositories for no password?

• each repository should be cloned using ssh protocol instead of https. For existing repositories this can be updated e.g. in SourceTree.
  • Example: git@github.com:msolanikova/gitsync.git
• new ssh keys have to be generated
  • use puttygen.exe
  • or SourceTree (Tools -> Create or Import SSH keys)
• store private key on disk
  • don't forget to protect it with a password - Key passphrase
• copy public key part and import it to git provider
  • SSH keys are located in user profile / manage account section
• start pageant.exe and load previously generated private key

[Note] windows users neeed to create new user environment variable called GIT_SSH where value needs to be path to plink.exe

[Note] pageant.exe with loaded keys needs to be running when syncing git repositories

[Note] when using multiple accounts to same git provider (e.g. multiple github accounts), configure sessions in putty with related ssh keys, but name them differenty. E.g. github.com and github-private. Use the proper session name in the remote url when cloning repo, e.g. git@github-private:msolanikova/gitsync.git

How to use it

CMD arguments

• --baseDir - base directory from which to start searching for git repositories
  • in case baseDir is repo directory, no other git repos will be searched
• --blacklistPath - path to a blacklist file (including file name) containing all repositories which should not be synced
  • default value: ./blacklist.txt
  • comparison to blacklist is case insensitive
• --searchDepth - depth of search for git repositories from base directory
  • default value: 2
  • if searchDepth = 0 - all git repos listed directly in baseDir (e.g. baseDir\repoDir)
  • if searchDepth = 1 - all git repos listed in subdirectories of baseDir (e.g. baseDir\subdir\repoDir)
  • ...

Example:

python GitSyncRunner.py --baseDir c:\Development\GitRepos --blacklistPath c:\Development\GitRepos\blacklist.txt

Blacklist

There might be some repositories which given user does not own and doesn't have possibility to upload keys there. In that case such repository cannot be updated by this sync and git pull will fail. In order to avoid these failures it is possible to add given local repository to a blacklist file.

By default, system will try to load blacklist.txt located at the same directory as GitSyncRunner.py. Each line represents a path to a repository to be blacklisted. Empty lines and lines starting with # will be excluded.

In following example, two repository folders will be blacklisted:

# list of all git repositories folders NOT to sync
c:\all-my-other-git-repos\somefolder\git-repo-folder
c:\all-my-other-git-repos\somefolder\other-git-repo-folder

It's also possible to blacklist whole folder by adding DIR to the beginning of the line:

# list of directories NOT to sync
DIR c:\all-my-private-git-repos\