Skip to content

2.0.0

Compare
Choose a tag to compare
@ajoberstar ajoberstar released this 06 Aug 16:05
· 261 commits to main since this release

This is a breaking release to clean up some outstanding deprecated items, require Java 8 (to be able to use the latest JGit), incorporate the org.ajoberstar.grgit Gradle plugin, and a few miscellaneous features.

All documentation has also been revised and migrated to a site that should be a little more friendly.

Breaking Changes

  • #180 Require Java 8
  • #67 Removed deprecated methods:
    • Grgit.open(String)
    • Grgit.open(String, Credentials)
    • Grgit.open(File)
    • Grgit.open(File, Credentials)
    • branch field on grgit.branch.status(...)

Enhancements

  • #187 The org.ajoberstar.grgit plugin was added to this project (migrated from gradle-git)
    • After all tasks have finished the grgit instance will be closed
    • Plugin will warn you if you apply the plugin in a way that causes one project to overwrite another's grgit property.
  • #85 Methods on Grgit are now generated by an AST transformation, so they should be visible in IDE completion.
  • #174 grgit.describe(...) now supports a longDescr option to force it to always output the more verbose format (thanks to Frank Vennemeyer)
  • #172 grgit.describe(...) now supports a commit option to choose an alternate target to describe than HEAD (thanks to Frank Vennemeyer)
  • Introduced grgit.branch.current() to replace the now deprecated grgit.branch.getCurrent(). These have identical functionality.

Fixes

  • #171 Safer selection of Jsch agent for authentication

Deprecations

  • grgit.branch.current / grgit.branch.getCurrent() has been deprecated in favor of grgit.branch.current()

Compatibility

Java: requires 8 or higher
Gradle: tested against 3.0, 3.1, 3.2, 3.2.1, 3.3, 3.4, 3.5, 3.5.1, 4.0, 4.0.1, 4.0.2, 4.1-rc-1