Git::Bunch - Manage gitbunch directory (directory which contain git repos)
version 0.24
To check the status of bunch (will do a 'git status' for each git repo inside the bunch and report which repos are 'unclean', e.g. needs commit, has untracked files, etc):
% gitbunch check ~/repos
To synchronize bunch to another (will do a 'git pull/push' for each git repo, and do an rsync for everything else):
% gitbunch sync ~/repos /mnt/laptop/repos
To backup bunch (will only rsync .git/ for each git repo to destination, and rsync everything else in full):
% gitbunch backup ~/repos /media/flashdisk
A gitbunch or bunch directory is just a term I coined to refer to a directory which contains, well, a bunch of git repositories. It can also contain other stuffs like files and non-git repositories (but they must be dot-dirs). Example:
repos/ -> a gitbunch dir proj1/ -> a git repo proj2/ -> ditto perl-Git-Bunch/ -> ditto ... .foo/ -> a non-git dir README.txt -> file
A little bit of history: after git got popular, in 2008 I started using it for software projects, replacing Subversion and Bazaar. Soon, I moved everything to git: notes & writings, Emacs .org agenda files, configuration, even temporary downloads/browser-saved HTML files. Currently, except large media files, all my personal data resides in git repositories. I put them all in ~/repos (and add symlinks to various places for convenience). This setup makes it easy to sync to laptops, backup to disk, etc. Git::Bunch is the library/script I wrote to do this.
See also File::RsyBak, which I wrote to backup everything else.
None of the functions are exported by default, but they are exportable.
Can't handle bare source repos
mr, http://joeyh.name/code/mr/ . You probably want to use this instead. mr supports other control version software aside from git, doesn't restrict you to put all your repos in one directory, supports more operations, and has been developed since 2007. Had I known about mr, I probably wouldn't have started Git::Bunch. On the other hand, Git::Bunch is simpler (I think), doesn't require any config file, and can copy/sync files/directories not under source control. I mainly use Git::Bunch to quickly: 1) check whether there are any of my repositories which have uncommitted changes; 2) synchronize (pull/push) to other locations. I put all my data in one big gitbunch directory; I find it simpler. Git::Bunch works for me and I use it daily.
This module has Rinci metadata.
None are exported by default, but they are exportable.
Backup bunch directory to another directory using rsync.
NOTE: This function is deprecated. If you want space-efficient backup of your bunch, sync-ing with --use_bare option is now the recommended way.
Simply uses rsync to copy bunch directory to another, except that for all git projects, only .git/ will be rsync-ed. This utilizes the fact that .git/ contains the whole project's data, the working copy can be checked out from .git/.
Will run check_bunch first and require all repos to be clean before running the backup, unless 'check' is turned off.
Note: Saving only .git/ subdirectory saves disk space, but will not save uncommited changes, untracked files, or .gitignore'd files. Make sure you have committed everything to git before doing backup. Also note that if you need to restore files, they will be checked out from the repository, and the original ctime/mtime information is not preserved. backup_bunch() does store this information for you by saving the output of 'ls -laR' command, but have *not* implemented routine to restore this data into restored files.
Arguments ('*' denotes required arguments):
backup => bool (default: 1)
Whether to do actual backup/rsync.
You can set backup=0 and index=1 to only run indexing, for example.
check => bool (default: 0)
Whether to check bunch first before doing backup.
delete_excluded => bool
Delete excluded repos in target.
exclude_files => bool
Exclude files from processing.
This only applies to 'backupbunch' and 'syncbunch' operations. Operations like 'checkbunch' and 'execbunch' already ignore these and only operate on git repos.
exclude_non_git_dirs => bool
Exclude non-git dirs from processing.
exclude_repos => array
Exclude some repos from processing.
exclude_repos_pat => str
Specify regex pattern of repos to exclude.
extra_rsync_opts => array
Pass extra options to rsync command.
Extra options to pass to rsync command. Note that the options will be shell quoted, , so you should pass it unquoted, e.g. ['--exclude', '/Program Files'].
include_repos => array
Specific git repos to sync, if not specified all repos in the bunch will be processed.
include_repos_pat => str
Specify regex pattern of repos to include.
index => bool (default: 1)
Whether to do "ls -laR" after backup.
sort => str (default: "-mtime")
Order entries in bunch.
source => str
Directory to check.
target => str
Destination bunch.
Return value:
Returns an enveloped result (an array). First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (result) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
Check status of git repositories inside gitbunch directory.
Will perform a 'git status' for each git repositories inside the bunch and report which repositories are clean/unclean.
Will die if can't chdir into bunch or git repository.
Execute a command for each repo in the bunch.
For each git repository in the bunch, will chdir to it and execute specified command.
command => str (default: 0)
Command to execute.
Synchronize bunch to another bunch.
For each git repository in the bunch, will perform a 'git pull/push' for each branch. If repository in destination doesn't exist, it will be rsync-ed first from source. When 'git pull' fails, will exit to let you fix the problem manually.
For all other non-git repos, will simply synchronize by one-way rsync.
delete_branch => bool (default: 0)
Whether to delete branches in dest repos not existing in source repos.
rsync_opt_maintain_ownership => bool (default: 0)
Whether or not, when rsync-ing from source, we use -a (= -rlptgoD) or -rlptD (-a minus -go).
Sometimes using -a results in failure to preserve permission modes on sshfs-mounted filesystem, while -rlptD succeeds, so by default we don't maintain ownership. If you need to maintain ownership (e.g. you run as root and the repos are not owned by root), turn this option on.
use_bare => bool (default: 0)
Whether to create bare git repo instead of copying repo when target does not exist.
When target repo does not exist, gitbunch can either copy the source repo using rsync, or it can create target repo with git init --bare.
rsync
git init --bare
Non-repos will still be copied/rsync-ed.
Steven Haryanto <stevenharyanto@gmail.com>
This software is copyright (c) 2012 by Steven Haryanto.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
To install Git::Bunch, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Git::Bunch
CPAN shell
perl -MCPAN -e shell install Git::Bunch
For more information on module installation, please visit the detailed CPAN module installation guide.