Version 8.0.0
Version 8.0.0 is finally there and includes various bug-fixes and improvements :-)
Potential Breaking changes:
The main key-aspects that might cause a breakage when migrating to the new version:
- #674/#699: change default timeformat/dateformat from RFC822 to ISO 8601 to support maven's reproducible build feature
⚠️
New Features / Bug-Fixes:
The main key-aspects that have been improved or being worked on are the following:
- #701/#705: Fix an issue where running with submodules using the native git executable was causing a
fatal: this operation must be run in a work tree
- #700: Only injects properties into every reactor project once
- #683: [pom] Add encoding to pom and correct maven xsd location
- make use of git-commit-id-plugin-core:6.0.0-rc.7 (move the GitDirLocator related logic to git-commit-id-plugin-core)
- bump org.eclipse.parsson:parsson from 1.1.4 to 1.1.5
- bump org.mockito:mockito-core from 5.6.0 to 5.10.0
- bump commons-io:commons-io from 2.14.0 to 2.15.1
- bump jgit.version from 6.7.0.202309050840-r to 6.8.0.202311291450-r
- bump jakarta.json:jakarta.json-api from 2.1.2 to 2.1.3
- bump org.yaml:snakeyaml from 2.0 to 2.2
- bump org.assertj:assertj-core from 3.24.2 to 3.25.3
- bump org.slf4j:slf4j-simple from 2.0.9 to 2.0.12
- bump joda-time:joda-time from 2.12.5 to 2.12.7
- bump several maven plugins
- bump
maven-plugin-plugin.version
from3.9.0
to3.11.0
- bump
org.apache.maven.plugins:maven-dependency-plugin
from3.6.0
to3.6.1
- bump
org.apache.maven.plugins:maven-surefire-plugin
from3.1.2
to3.2.5
- bump
org.apache.maven.plugins:maven-checkstyle-plugin
from3.3.0
to3.3.1
- bump
org.apache.maven.plugins:maven-clean-plugin
from3.3.1
to3.3.2
- bump
org.apache.maven.plugins:maven-javadoc-plugin
from3.6.0
to3.6.3
- bump
org.codehaus.mojo:exec-maven-plugin
from3.1.0
to3.2.0
- bump
org.jacoco:jacoco-maven-plugin
from0.8.10
to0.8.11
- bump
org.apache.maven.plugins:maven-compiler-plugin
from3.11.0
to3.12.1
- bump
- bump several dependencies
- bump
commons-io:commons-io
from2.14.0
to2.15.1
- bump
org.mockito:mockito-core
from5.6.0
to5.10.0
- bump
jakarta.xml.bind:jakarta.xml.bind-api
from2.3.3
to4.0.1
- bump
org.slf4j:slf4j-simple
from2.0.9
to2.0.12
- bump
org.assertj:assertj-core
from3.24.2
to3.25.3
- bump
com.puppycrawl.tools:checkstyle
from8.25
to10.13.0
- bump
actions/setup-java
from3
to4
- bump
actions/cache
from3
to4
- bump
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-maven-plugin</artifactId>
<version>8.0.0</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:
- This plugin is unfortunately not working with Heroku which is due to the fact how Heroku works. In summary Heroku does not copy over the .git-repository but in order to determine the git properties this plugin relies on the fact that it has access to the git-repository. A somewhat workaround to get some information is outlined in #279 (comment)
- Using maven's plugin prefix resolution (e.g.
mvn com.test.plugins:myPlugin:myMojo
) might result in unresolved properties even with<injectAllReactorProjects>true</injectAllReactorProjects>
. Please refer to #287 or #413 (comment) for details and potential workarounds
Reporting Problems
If you find any problem with this plugin, feel free to report it here