maven git commit id plugin Files

Version 9.0.0 is finally there and includes various bug-fixes and improvements :-)

⚠️ This is a potentially breaking release. Read the release-notes carefully ⚠️

Potential Breaking changes:

The main key-aspects that might cause a breakage when migrating to the new version: * [#737] / [#710]: Require Maven 3.6.3 ⚠️

New Features / Bug-Fixes:

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

• Use javac --release instead of -source & -target
• Delete BigDiffTest
• bump several maven plugins
• bump org.apache.maven.plugins:maven-assembly-plugin from 3.7.0 to 3.7.1
• bump org.apache.maven.plugins:maven-gpg-plugin from 3.2.0 to 3.2.4
• bump maven-plugin-plugin.version from 3.11.0 to 3.12.0
• bump org.apache.maven.plugins:maven-source-plugin from 3.3.0 to 3.3.1
• bump org.jacoco:jacoco-maven-plugin from 0.8.11 to 0.8.12
• bump org.apache.maven.plugins:maven-compiler-plugin from 3.12.1 to 3.13.0
• bump org.apache.maven.plugins:maven-jar-plugin from 3.3.0 to 3.4.1
• bump org.apache.maven.plugins:maven-install-plugin from 3.1.1 to 3.1.2
• bump org.apache.maven.plugins:maven-deploy-plugin from 3.1.1 to 3.1.2
• bump maven-plugin-plugin.version from 3.12.0 to 3.13.0
• bump org.codehaus.mojo:exec-maven-plugin from 3.2.0 to 3.3.0
• bump maven-plugin-plugin.version from 3.13.0 to 3.13.1
• bump org.apache.maven.plugins:maven-javadoc-plugin from 3.6.3 to 3.7.0

• bump org.apache.maven.plugins:maven-enforcer-plugin from 3.4.1 to 3.5.0

• bump several dependencies

• bump commons-io:commons-io from 2.15.1 to 2.16.1
• bump org.slf4j:slf4j-simple from 2.0.12 to 2.0.13 (tests)
• bump org.mockito:mockito-core from 5.11.0 to 5.12.0 (tests)
• bump org.assertj:assertj-core from 3.25.3 to 3.26.0 (tests)

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:

:::xml
<dependency>
    <groupId>io.github.git-commit-id</groupId>
    <artifactId>git-commit-id-maven-plugin</artifactId>
    <version>9.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:

:::xml
<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 https://github.com/ktoso/maven-git-commit-id-plugin/issues/279#issuecomment-301284022
• 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 https://github.com/git-commit-id/maven-git-commit-id-plugin/issues/287 or https://github.com/git-commit-id/maven-git-commit-id-plugin/issues/413#issuecomment-487952607 for details and potential workarounds

Reporting Problems

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