Andrew Lalis 5b06f30df9 | ||
---|---|---|
src | ||
.gitignore | ||
LICENSE | ||
README.md | ||
pom.xml |
README.md
DistribuGit
Tool for performing operations on many git repositories at once. It works by cloning a set of repositories, and applying an action to each repository.
The simplest way to get started is to get the latest release JAR file, and run it in the command line.
java -jar distribugit-1.2.0.jar -t abc -s org-repo-prefix:concord/Java_ -a "ls"
The above command simply gets all repositories from the corcord
GitHub organization which begin with "Java_"
, and executes the ls
command in each repository.
In addition to the CLI, you can include DistribuGit as a dependency in your Java project. You can get this project from jitpack.io.
Here's an example of how one might use DistribuGit to run mvn test
on many repositories:
public static void main(String[] args) throws IOException {
new DistribuGit.Builder()
.selector(RepositorySelector.from(
"https://github.com/andrewlalis/RandomHotbar.git",
"https://github.com/andrewlalis/CoyoteCredit.git"
))
.action(RepositoryAction.ofCommand("mvn", "test"))
.build()
.doActions();
}
In short, we need to specify the following things in order to use the tool:
- The
RepositorySelector
provides a list of URIs that we can use to clone the repositories. Make sure that the URI format matches the type of credentials you plan to use, i.e. HTTPS should begin withhttps://
, and SSH should begin withgit@
. This component is mandatory. - The
RepositoryAction
is the action you want to perform on each repository. TheofCommand
method can be used as a convenience to execute a command for each repository. Note that the script is executed within the repository's directory, which itself is in DistribuGit's working directory. Hence, use../../
to point to a script in the directory from your main method was started. This component is mandatory. - The
GitCredentials
are used to provide credentials in case you're trying to perform actions that only an authenticated user can. If you're using a GitHub personal access token, you can provide it as a username, with no password. By default, no credentials are provided. - The
StatusListener
is a component that's used to send log output and occasional progress updates as DistribuGit runs. By default, this just outputs information toSystem.out
. workingDir
denotes the directory in which DistribuGit will run. This directory may be completely deleted. By default, it is set to.distribugit_tmp
in the current directory.strictFail
determines if we should quit as soon as any error occurs. If this is false, then we will continue the operations even if some repositories encounter errors. By default, this is set to true.cleanup
determines if we should remove all repository files after DistribuGit is finished. By default, this is set to false.