Skip to content

Releases: git-commit-id/git-commit-id-maven-plugin

Version 8.0.2

18 Mar 20:33
Compare
Choose a tag to compare

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

New Features / Bug-Fixes:

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

  • bump jakarta.xml.bind:jakarta.xml.bind-api from 4.0.1 to 4.0.2

  • bump org.mockito:mockito-core from 5.10.0 to 5.11.0

  • #718/#721: replace junit:junit:4.13.2:test with org.junit.jupiter:junit-jupiter-*:5.10.2:test

  • #717/#720: update org.sonatype.plexus:plexus-build-api:0.0.7 to org.codehaus.plexus:plexus-build-api:1.2.0

  • bump org.apache.maven.plugins:maven-gpg-plugin from 3.1.0 to 3.2.0

  • bump org.apache.maven.plugins:maven-assembly-plugin from 3.6.0 to 3.7.0

  • #717: Update maven-plugin-api.version from 3.9.2 to 3.9.6

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.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:

  • 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

Version 8.0.1

09 Mar 16:01
Compare
Choose a tag to compare

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

New Features / Bug-Fixes:

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

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.1</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

Version 8.0.0

04 Mar 20:44
Compare
Choose a tag to compare

Version 8.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:

  • #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 from 3.9.0 to 3.11.0
    • bump org.apache.maven.plugins:maven-dependency-plugin from 3.6.0 to 3.6.1
    • bump org.apache.maven.plugins:maven-surefire-plugin from 3.1.2 to 3.2.5
    • bump org.apache.maven.plugins:maven-checkstyle-plugin from 3.3.0 to 3.3.1
    • bump org.apache.maven.plugins:maven-clean-plugin from 3.3.1 to 3.3.2
    • bump org.apache.maven.plugins:maven-javadoc-plugin from 3.6.0 to 3.6.3
    • bump org.codehaus.mojo:exec-maven-plugin from 3.1.0 to 3.2.0
    • bump org.jacoco:jacoco-maven-plugin from 0.8.10 to 0.8.11
    • bump org.apache.maven.plugins:maven-compiler-plugin from 3.11.0 to 3.12.1
  • bump several dependencies
    • bump commons-io:commons-io from 2.14.0 to 2.15.1
    • bump org.mockito:mockito-core from 5.6.0 to 5.10.0
    • bump jakarta.xml.bind:jakarta.xml.bind-api from 2.3.3 to 4.0.1
    • bump org.slf4j:slf4j-simple from 2.0.9 to 2.0.12
    • bump org.assertj:assertj-core from 3.24.2 to 3.25.3
    • bump com.puppycrawl.tools:checkstyle from 8.25 to 10.13.0
    • bump actions/setup-java from 3 to 4
    • bump actions/cache from 3 to 4

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

Version 7.0.0

21 Oct 09:54
Compare
Choose a tag to compare

Version 7.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:

  • Drop support for Maven 3.1.0-alpha-1 ⚠️
    • minimal required maven version is now Maven 3.2.5 (to support Maven 4.0.0)

New Features / Bug-Fixes:

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

  • #639 / #642: Resolve worktree .git files to repository .git directory
  • Update several plugins
    • updated git-commit-id-plugin-core from 6.0.0-rc.5 to 6.0.0-rc.6, that update brings
      • git-commit-id/git-commit-id-plugin-core#57: Stop relying on javax.json 1.1.4
        • the dependency for javax.json:javax.json-api:1.1.4 was replaced with jakarta.json:jakarta.json-api:2.1.2
        • the dependency for org.glassfish:javax.json:1.1.4 was replaced with org.eclipse.parsson:parsson:1.1.4
      • bump jgit from 6.5.0.202303070854-r to 6.7.0.202309050840-r
      • bump commons-io:commons-io from 2.11.0 to 2.14.0
      • bump org.slf4j:slf4j-simple from 2.0.7 to 2.0.9
    • bump several maven plugins
      • bump maven-plugin-api from 3.1.0-alpha-1 to 3.9.2
      • bump maven-plugin-plugin from 3.6.0 to 3.9.0
      • bump maven-assembly-plugin from 3.4.2 to 3.6.0
      • bump maven-dependency-plugin from 3.5.0 to 3.6.0
      • bump maven-release-plugin from 3.0.0-M7 to 3.0.1
      • bump maven-enforcer-plugin from 3.2.1 to 3.4.1
      • bump maven-compiler-plugin from 3.8.1 to 3.11.0
      • bump maven-gpg-plugin from 3.1.0
      • bump maven-clean-plugin from 3.1.0 to 3.3.1
      • bump maven-resources-plugin from 3.1.0 to 3.3.1
      • bump maven-jar-plugin from 3.2.0 to 3.3.0
      • bump maven-surefire-plugin from 2.22.2 to 3.1.2
      • bump maven-install-plugin from 2.5.2 to 3.1.1
      • bump maven-javadoc-plugin from 3.2.0 to 3.6.0
      • bump maven-source-plugin from 3.2.1 to 3.3.0
    • Bump or replace various plugins for testing
      • bump commons-io:commons-io from 2.11.0 to 2.14.0 (test dependency)
      • bump org.slf4j:slf4j-simple from 2.0.7 to 2.0.9 (test dependency)
      • replace org.eluder.coveralls:coveralls-maven-plugin:4.3.0 with io.jsonwebtoken.coveralls:coveralls-maven-plugin:4.4.1 (test dependency)

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>7.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

Version 5.0.1

24 May 17:27
Compare
Choose a tag to compare

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

New Features / Bug-Fixes:

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

  • #630: Backport the fix for #615 that yields Maven 3.9.2 warnings to 5.x and declare org.apache.maven:maven-plugin-api and org.apache.maven:maven-core as <scope>provided</scope>

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>5.0.1</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

Version 6.0.0

16 May 18:54
Compare
Choose a tag to compare

Version 6.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:

  • externalized the git directories used for integration tests as git submodule

New Features / Bug-Fixes:

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

  • modernized the issue templates
  • added dependabot to automatically update dependencies
  • added tests for java 11 - java 20
  • git-commit-id/git-commit-id-plugin-core#18: added the ability to generate XML and YML files (see above)

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>6.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

Version 4.9.10 (The continued relocation saga)

01 Aug 22:36
Compare
Choose a tag to compare

Where should I start....this release should not exists.
Ideally the entire 4.9.9 "relocation" release was just intended to inform that the plugin moved to a new artifactId/groupId combination.

As outlined in #571 or https://issues.apache.org/jira/browse/MNG-7204 there seems to be a problem where Maven will not forward the correct settings when you use the old coordinates with the 4.9.9 version.
Since the 4.9.9 release contains relocation information it essentially became unusable triggering this "fix".
Please note that the plugin is still moving to it's new coordinates.
This 4.9.10 release is just a follow up to avoid any silent configuration issues being present somewhere....

TLDR:
If you can use:

<groupId>io.github.git-commit-id</groupId>
<artifactId>git-commit-id-maven-plugin</artifactId>
<version>5.0.0</version>

Version 4.9.9 (Relocation Release)

15 Jul 18:29
Compare
Choose a tag to compare

This is a special release and should function in the same way as v4.0.5.

⚠️ WARNING
Based on the issue outlined in #571 it is discouraged to use the old coordinates, since the plugin configuration might not be correctly applied to the plugin. Feel free to follow https://issues.apache.org/jira/browse/MNG-7204 for further informations.

Initially this release was just intended to inform that the plugin moved to a new artifactId/groupId combination, but to avoid having published a release that might be considered broken I decided to just "fix" it.
Currently the 4.9.9 release works only when using the new coordinates

<groupId>io.github.git-commit-id</groupId>
<artifactId>git-commit-id-maven-plugin</artifactId>
<version>4.9.9</version>

Version 5.0.0

10 Jul 08:12
Compare
Choose a tag to compare

Version 5.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:

  • #559 / #557:
    Drop support for Java 8, Java 9 and Java 10
  • #562 / #563
    Reorganize Project-Structure (birth of https://github.com/git-commit-id/git-commit-id-plugin-core)
  • #458 / #561: Have the plugin operate in "offline mode" by default
  • #565 / #465
    Relocation of the group-id and artifact-id
    Before:
    <groupId>pl.project13.maven</groupId>
    <artifactId>git-commit-id-plugin</artifactId>
    Now:
    <groupId>io.github.git-commit-id</groupId>
    <artifactId>git-commit-id-maven-plugin</artifactId>

New Features / Bug-Fixes:

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

  • N/A

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>5.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

Version 4.0.5

09 Jun 17:42
Compare
Choose a tag to compare

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

New Features / Bug-Fixes:

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

  • #547 / #540: add org.eclipse.jgit:org.eclipse.jgit.ssh.jsch as dependency
  • #548 / #549: Plugin breaks if git config log.showSignature is 'true'
  • #556: update dependencies

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>pl.project13.maven</groupId>
    <artifactId>git-commit-id-plugin</artifactId>
    <version>4.0.5</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 travis:

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

Even though travis 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