NAME

Git::Bunch - Manage gitbunch directory (directory which contain git repos)

VERSION

version 0.32

SYNOPSIS

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

DESCRIPTION

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.

FUNCTIONS

check_bunch(%args) -> [status, msg, result, meta]

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.

Arguments ('*' denotes required arguments):

• exclude_files => bool

  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.

• exclude_non_git_dirs => bool

  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.

• exclude_repos => array

  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.

• exclude_repos_pat => str

  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.

• include_repos => array

  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.

• include_repos_pat => str

  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.

• sort => str (default: "-mtime")

  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.

• source* => str

  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.

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.

exec_bunch(%args) -> [status, msg, result, meta]

Execute a command for each repo in the bunch.

For each git repository in the bunch, will chdir to it and execute specified command.

Arguments ('*' denotes required arguments):

• command* => str

  Execute a command for each repo in the bunch.

  For each git repository in the bunch, will chdir to it and execute specified command.

• exclude_files => bool

  Execute a command for each repo in the bunch.

  For each git repository in the bunch, will chdir to it and execute specified command.

• exclude_non_git_dirs => bool

  Execute a command for each repo in the bunch.

  For each git repository in the bunch, will chdir to it and execute specified command.

• exclude_repos => array

  Execute a command for each repo in the bunch.

  For each git repository in the bunch, will chdir to it and execute specified command.

• exclude_repos_pat => str

  Execute a command for each repo in the bunch.

  For each git repository in the bunch, will chdir to it and execute specified command.

• include_repos => array

  Execute a command for each repo in the bunch.

  For each git repository in the bunch, will chdir to it and execute specified command.

• include_repos_pat => str

  Execute a command for each repo in the bunch.

  For each git repository in the bunch, will chdir to it and execute specified command.

• sort => str (default: "-mtime")

  Execute a command for each repo in the bunch.

  For each git repository in the bunch, will chdir to it and execute specified command.

• source* => str

  Execute a command for each repo in the bunch.

  For each git repository in the bunch, will chdir to it and execute specified command.

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.

sync_bunch(%args) -> [status, msg, result, meta]

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.

Arguments ('*' denotes required arguments):

• backup => bool

  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.

• create_bare_target => bool

  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)

  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.

• exclude_files => bool

  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.

• exclude_non_git_dirs => bool

  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.

• exclude_repos => array

  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.

• exclude_repos_pat => str

  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.

• include_repos => array

  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.

• include_repos_pat => str

  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.

• rsync_opt_maintain_ownership => bool (default: 0)

  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.

• sort => str (default: "-mtime")

  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.

• source* => str

  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.

• target* => str

  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.

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.

FAQ

TODO

• Can't handle bare source repos

• Sync-ing to bare repos (e.g. with --backup) still produces error messages

  Although the sync process succeeds, the error messages (like fatal: Not a git repository) might be confusing.

SEE ALSO

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.

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/Git-Bunch.

SOURCE

Source repository is at https://github.com/sharyanto/perl-Git-Bunch.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Git-Bunch

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

AUTHOR

Steven Haryanto <stevenharyanto@gmail.com>

COPYRIGHT AND LICENSE

This software is copyright (c) 2014 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.

cpanm Git::Bunch

perl -MCPAN -e shell
install Git::Bunch