Skip to content

Version 6.0.0-rc.2

Pre-release
Pre-release
Compare
Choose a tag to compare
@TheSnoozer TheSnoozer released this 12 Apr 18:43
· 341 commits to master since this release
6.0.0-rc.2
a07c98f

Version 6.0.0-rc.2 is finally there and includes various bug-fixes and improvements.
Note that this library was previously part of the git-commit-id-maven-plugin so you might want relevant changes in the issues listed there too :-)

⚠️ This is a potentially breaking release. Read the release-notes carefully. As of now this is only a release candidate. Future release candidates and the final 6.0.0 version may contain further breaking changes ⚠️

Potential Breaking changes:

The main key-aspects that might cause a breakage when migrating to the new version:

  • Reorganize Project-Structure
    • #6: replace pl.project13.core.log.LoggerBridge with pl.project13.core.log.LogInterface
    • a failure in the native command execution will now throw a GitCommitIdExecutionException
      instead of RuntimeException
    • #3: replace org.sonatype.plexus.build.incremental.BuildContext with pl.project13.core.util.BuildFileChangeListener that acts as call-back when the generatedProperties-File has been altered. Users of the core-plugin are thus expected to propagate those notifications further (e.g. to the plexus BuildContext)

New Features / Bug-Fixes:

The main key-aspects that have been improved or being worked on are the following:

  • #8: get file store attr async to improve jgit startup performance
  • #11 / #10: Add parameter in function maybeGeneratePropertiesFile in order to choose to escape unicode or not
  • various dependency updates

Getting the latest release

The plugin is available from Maven Central (see here), so you don't have to configure any additional repositories to use this plugin. All you need to do is to configure it inside your project as dependency:

<dependency>
    <groupId>io.github.git-commit-id</groupId>
    <artifactId>git-commit-id-plugin-core</artifactId>
    <version>6.0.0-rc.2</version>
</dependency>

Getting the latest snapshot (build automatically)

If you can't wait for the next release, you can also get the latest snapshot version from sonatype, that is being deployed automatically by github actions:

<pluginRepositories>
    <pluginRepository>
        <id>sonatype-snapshots</id>
        <name>Sonatype Snapshots</name>
        <url>https://s01.oss.sonatype.org/content/repositories/snapshots/</url>
    </pluginRepository>
</pluginRepositories>

Even though the github actions will only deploy a new snapshot once all tests have finished, it is recommended to rely on the released and more stable version.

Known Issues / Limitations:

  • N/A

Reporting Problems

If you find any problem with this plugin, feel free to report it here

Assets 2
Loading