Skip to content

jblack10101/grgit

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

121 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

grgit

The Groovy way to use Git.

Build Status

What is this?

Grgit is a way to interact with Git repositories with a fairly fluent Groovy API. JGit can get pretty tedious to use, especially in a scripting context.

Grgit will also be the base for a rewrite of the gradle-git plugin.

Where do I get it from?

Grgit is published on JCenter and Maven Central. As of 3/30/2014, not all dependencies are in JCenter.

repositories {
	jcenter()
	mavenCentral()
}

dependencies {
	compile 'org.ajoberstar:grgit:<version>'
}

How do I use it?

Start at the main entry point class Grgit. This should link to all of the ways to call different operations.

For authentication, see AuthConfig.

The documentation home is here.

Where's feature X?

I've added most of the core operations so far, and you can see the issue tracker for planned features.

If an existing operation is missing an option, it most likely means one of the following things:

  • I don't have a use case for it.
  • I wasn't able to put together a test that could describe/validate the behavior of the option.
  • JGit doesn't support it.

If you're interested in a change, please submit an issue (or even better a pull request with tests).

Release Notes

0.2.1

  • Added close() method to Grgit to release resources.
  • Support system properties for hardcoded credentials.
  • Fix for some JNA issues when using ssh-agent.

0.2.0

  • Added a bunch of new operations. See the Groovydoc for details.

0.1.0

  • Initial release!

About

The Groovy way to use Git.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages

  • Groovy 96.6%
  • Shell 3.4%