Join 10350+ others. No spamming.
I promise!

Follow us at github.



ajoberstar/gradle-git

460

ajoberstar / gradle-git

Groovy

Git plugin for Gradle


READ ME

gradle-git

Bintray Travis GitHub license

Project Status

gradle-git has been around since 2012 and has evolved quite a bit from the original release. In order to continue to evolve these features, this project is being broken up into multiple repositories. As such:

  • gradle-git will no longer be enhanced
  • gradle-git may make some fix releases, as issues are identified, presuming they don't break compatibility
feature replacement maturity comments
org.ajoberstar.grgit grgit stable Grgit has been an independent project since 2013 and has been stable for quite a while. Version 2.0 removes some deprecated features, but otherwise is fully compatible with existing usage. It does integrate the org.ajoberstar.grgit plugin directly into the project.
org.ajoberstar.github-pages gradle-git-publish stable org.ajoberstar.git-publish is a more robust version of the old plugin. It is functionally equivalent (or better), but does require porting configuration over as noted in the README. While it was only introduced in early 2017, I plan to cut 1.0 soon after grgit 2.0 is finalized.
org.ajoberstar.release-* reckon development Reckon focuses solely on determining your project version (and assisting with tagging and pushing that tag). It will not pretend to be a full-featured release plugin. It also will not pretend to meet anyone's general version inference needs, instead providing an opinionated model of how to apply semantic versioning. There are still some details being worked out in how the algorithm will address some problems gradle-git had (such as parallel development).

Why do you care?

Git is immensely popular and being able to interact with it as part of a build process can be very valuable to provide a more powerful and consistent result.

What is it?

gradle-git is a set of Gradle plugins:

  • org.ajoberstar.grgit - provides a Grgit instance, allowing interaction with the Git repository the Gradle project is contained in
  • org.ajoberstar.github-pages - publishes files to the gh-pages branch of a Github repository
  • org.ajoberstar.release-base - general structure for inferring a project version and releasing it
  • org.ajoberstar.release-opinion - opinionated defaults for org.ajoberstar.release-base

See Grgit for details on the Git library used underneath, including configuration for authentication.

Usage

NOTE: gradle-git modules require Java 7 (or higher).

Questions, Bugs, and Features

Please use the repo's issues for all questions and bug reports.

Contributing

Non-breaking bug fixes are welcome via pull requests.

I am no longer accepting feature contributions. See the Project Status section above for details.

Acknowledgements

Thanks to all of the contributors.

Credit goes to Peter Ledbrook for the initial idea for the org.ajoberstar.github-pages plugin.

Thanks to Zafar Khaja for the very helpful java-semver library.