Releases: git-commit-id/git-commit-id-maven-plugin
Version 5.0.1
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-apiandorg.apache.maven:maven-coreas<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
Version 6.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:
- updates several plugins used by the project
- updated git-commit-id-plugin-core from 5.0.0 to 6.0.0-rc.5, that update brings
- updated joda-time.joda-time from 2.10.10 to 2.12.5
- git-commit-id/git-commit-id-plugin-core#18: added org.yaml:snakeyaml version 2.0
- git-commit-id/git-commit-id-plugin-core#18: added the ability to generate XML and YML files
- integrated more common code from git-commit-id-maven-plugin into git-commit-id-plugin-core
- git-commit-id/git-commit-id-plugin-core#17: the AzureDevOpsBuildServerData now uses BUILD_SOURCEBRANCH instead of BUILD_SOURCEBRANCHNAME
- git-commit-id/git-commit-id-plugin-core#6: dropped LoggerBridge and replaced it with LogInterface
- introduced a GenericFileManager that allows to read / write properties in all formats (properties, json, xml, yml, ...)
- property files are now UTF-8 encoded instead of using ISO_8859_1
- git-commit-id/git-commit-id-plugin-core#8: get file store attr async to improve jgit startup performance
- git-commit-id/git-commit-id-plugin-core#11 / git-commit-id/git-commit-id-plugin-core#10: Add parameter in function maybeGeneratePropertiesFile in order to choose to escape unicode or not
various dependency updates - #615: set the org.apache.maven:maven-plugin-api and org.apache.maven:maven-core as scope=provided
- updated commons-io:commons-io from 2.9.0 to 2.11.0
- 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)
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)
This is a special release and should function in the same way as v4.0.5.
| 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
Version 5.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:
- #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:Now:<groupId>pl.project13.maven</groupId> <artifactId>git-commit-id-plugin</artifactId>
<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
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
Version 4.0.4
Version 4.0.4 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:
- #531 / #532: fix a
NullPointerExceptionwhensession.getProjectDependencyGraph()might benullwhen running the plugin from eclipse - #523 / #534: Avoid illegal reflective access warning in JDK11
- #539: Support Bitbucket Pipelines CI for build number and branch
- #544: add support for author and commiter times (properties will be exposed as
git.commit.author.time,git.commit.committer.time) - #529: 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.4</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
Version 4.0.3
Version 4.0.3 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:
- #525 / #524: Update JGit dependency to 5.9.0.202009080501 (which fixes java.util.concurrent.RejectedExecutionException when using JGit concurrently in the same application -- see here for further details)
- #519 / #520: made the plugin slightly smarter in terms of stripping the password from remote git urls that contain special characters. Note that this problem still can resurface when the url does not follow rfc2396. If processing fails the plugin will continue to print an error, but will avoid exposing the url in any generated properties (similar behaviour as before)
- #501 / #517: replace jackson-databind with lightweight javax.json to fix broken JSON format
- #527: fix javadoc generation for java 12/13
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.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 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
Version 4.0.2
Version 4.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:
- #469 / #511 / #512: Fix a condition where the plugin is not thread save when using
injectAllReactorProjects - #509 / #513: Allow initial
git.build.timefromproject.build.outputTimestampto support reproducible builds - #514: Update dependencies
jgit 5.8.1.202007141445-r,jackson-databind 2.11.2,joda-time 2.10.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>pl.project13.maven</groupId>
<artifactId>git-commit-id-plugin</artifactId>
<version>4.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 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
Version 4.0.1
Version 4.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:
- #454: add support for
git.branchandgit.build.numberfor GitHub Actions - #457 / #460: Add a
forceValueEvaluation-switch to thereplacementPropertyto tell the plugin that the value needs to be regenerated for every project. Note that this will make the plugin run for every project (e.g. which might be needed for sonar that requires unique keys for the sonar) - #459 / #460: the git execution no longer fails on remote repository url's that don't follow a correct url-syntax (e.g.
https://:@git.server.com/pathToRepo.git) - #472 / #502: prevent header timestamp in git.properties to allow for reproducible builds
- #493: remove dependency on google guava
- #496: add support for
git.branchandgit.build.numberfor AWS CodeBuild - #503: upgrade to jackson 2.11.1
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.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 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