Version 6.0.0-rc.3
Pre-releaseVersion 6.0.0-rc.3 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 :-)
Potential Breaking changes:
The main key-aspects that might cause a breakage when migrating to the new version:
- Interface changes in
GitCommitIdPlugin
- For
getPropertiesOutputFormat
require now anEnum
(CommitIdPropertiesOutputFormat
) instead of aString
- Replace
getGenerateGitPropertiesFilename
that was requiring aString
withgetGenerateGitPropertiesFile
that requires aFile
- For
New Features / Bug-Fixes:
The main key-aspects that have been improved or being worked on are the following:
- None
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.3</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