Version 4.0.0

Version 4.0.0 is finally there and includes various bug-fixes, improvements and some changes that can be considered as potential breaking changes :-)

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

Potential breaking changes:

• initial effort for modularisation (mainly splitting the project into a maven and a core-project) -- #441 (initial idea #228)
• runOnlyOnce coupled with Maven's --projects parameter makes plugin not run at all -- #387, #443

New Features / Bug-Fixes:

• make injectAllReactorProjects slightly less verbose -- #431
• allow to override useNativeGit from command line via -Dmaven.gitcommitid.nativegit=true -- #433
• add support for git.branch and git.build.number for Azure DevOps -- #439
• add support for git.branch and git.build.number for CircleCI -- #449
• use maven's PluginParameterExpressionEvaluator to allow replacements with values that contain unresolved variables. E.g. allows to specify the git.branch in sonar's project version:

<replacementProperties>
   <replacementProperty>
      <property>sonar.projectVersion</property>
      <token>^.*$</token>
      <value>${project.version}-${git.branch}</value>
      <regex>false</regex>
   </replacementProperty>
</replacementProperties>

See #444 for further details.

• update dependencies -- #437, #451
• added tests for java 8, java 9, java 10, java 11, java 12 and java 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.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 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
• For some (undetermined) reason the plugin might fail with org.eclipse.jgit.api.errors.TransportException: USERAUTH fail under java 13 (I can't reproduce the issue), however a workaround would be specifying <offline>true</offline> or using the native git implementation with <useNativeGit>true</useNativeGit>.

Reporting Problems

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

Version 3.0.1

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

• Added a new setting to control if the plugin should operate in offline mode -- #424 (by default the plugin will assume an 'online' mode and since version 3.0 will perform a git fetch operation to determine the properties git.local.branch.ahead and git.local.branch.behind. If the plugin is operating in 'offline' mode both those properties will only reflect the view of the local clone and thus might be off from the actual repository. Note this 'offline' mode is also respected when one set's the maven "-o" offline switch).
• Removed the org.apache.httpcomponents:httpclient dependency -- #425
• Since version 3.0.0 this plugin will now only ask for properties that are essential (proposal from #185). With this version the same technique is now also used when retrieving git.build.time since the TimeZone.getTimeZone() may also have an impact upon performance -- #428.
• Property caching now works properly for reactor builds using property caching when using injectAllReactorProjects -- #429.

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

Version 3.0.0

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

• Java 1.7 is no longer supported with this version and at least Java 8 is required - #346
• Introduced a more reliable way to deal with incremental builds for eclipse IDE - #385 / #366 / #269
• Added a new property for setting if branch name should be taken from build environment or not (e.g. set <useBranchNameFromBuildEnvironment>false</useBranchNameFromBuildEnvironment>). This behaviour might be useful in combination with the JGitflow maven plugin #393.
• Moved the project to a new git-commit-id organization account #384
• Fixed a problem where the plugin hangs on windows under certain conditions and when there are too many changes in the git-repo #396 / #336
• Allow the value of an replacementProperty to be empty #400 / #389
• Introduced the new properties git.local.branch.ahead and git.local.branch.behind that provide some information if the local branch is either ahead or behind the remote. Note that using this property will perform a git fetch operation and may have a performance impact on the overall execution of the plugin. #395
• Instead of determine all properties and then exclude properties, this plugin will now only ask for properties that are essential (proposal from #185). For a detailed performance comparison refer to the latest benchmark. Note: For users who want to avoid the the git fetch operation performed when gathering the properties git.local.branch.ahead and git.local.branch.behind simply exclude those to avoid that step:

<excludeProperties>
  <excludeProperty>^git.local.branch.*$</excludeProperty>
</excludeProperties>

• Cleanup readme & Introduce coveralls #380 / #401 / #405
• The plugin tried to extract the Bamboo build variables with the wrong case #410
• Setting evaluateOnCommit to anything besides the default HEAD resulted only in the commit-id. in case users want to evaluateOnCommit on any commit or branch that is not the default HEAD, please be advised that this plugin will run git branch --points-at that may or may not result in a git.branch property that has multiple branches that are comma separated. If evaluateOnCommit is kept as the default HEAD the git.branch property still may fallback to the commit-id. #403
• Have travis finally automatically deploy the snapshot version of the plugin #344 (see below how to get it)
• Setting injectAllReactorProjects to true for multi-modules project now stores the computed properties in the project context. If the properties are present in the project context this plugin will essentially reuse those properties from a previously computed version (kudus to #411, implemented in #414)

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

Version 2.2.6 is a security update for a potential issue within the jackson-databind dependency. As usual you can checkout the detailed list of bug-fixes :-)

New Features / Bug-Fixes:

The main key-aspects is a security update for a potential issue within the jackson-databind dependency. This specific dependency was updated to v2.9.8 in response to FasterXML/jackson-databind#2186 (CVE-2018-19360, CVE-2018-19361, CVE-2018-19362). Even though by default an user of this plugin does not seem to be affected by this potential issue, it is highly recommended to adopt the latest version at your earliest convenience. Similar to version 2.2.5 this version provides full support for Java 7, Java 8, Java 9, Java 10 and Java 11 (and is potentially also working for any higher version).

Am I affected? (technical details)

The specific issues that have been fixed with the update of jackson-databind dependency are:

• CVE-2018-19360: FasterXML jackson-databind 2.x before 2.9.8 might allow attackers to have unspecified impact by leveraging failure to block the axis2-transport-jms class from polymorphic deserialization.
• CVE-2018-19361: FasterXML jackson-databind 2.x before 2.9.8 might allow attackers to have unspecified impact by leveraging failure to block the openjpa class from polymorphic deserialization.
• CVE-2018-19362: FasterXML jackson-databind 2.x before 2.9.8 might allow attackers to have unspecified impact by leveraging failure to block the jboss-common-core class from polymorphic deserialization.

This plugin uses the jackson-databind dependency for dumping the git information (serialization) to the generated properties file and determining if the generated json properties are up-to-date (deserialization). As of now it appears that only user who generate json properties via <format>json</format> may be affected by those issues. This specific configuration is set to <format>properties</format> by default and hence by default it appears that those issues are out of scope. Only when this configuration is altered a user may need to consider the linked CVE's as potential security problem.
In general I would be unsure if this ever even could be considered a true attack vector of this plugin, since the generated json file would need to contain data that would trigger this specific bug in the dependency. If an adversary has access to the content to the location where the generated file is residing, I would assume he can also modify the any local file (including project files) and hence would not need to go through the pain and exploit this problem....

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>2.2.6</version>
</dependency>

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)

Reporting Problems

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

Version 2.2.5

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

• most likely the last release that supports Java 1.7
• Full support for Java 7, Java 8, Java 9, Java 10 and Java 11 (potentially also working for any higher version)
• add build number support (git.build.number and git.build.number.unique) for Bamboo, Hudson, Jenkins, TeamCity, Travis, Gitlab CI - #353 / #369
• add git.branch support for GitlabCI - #368
• add total commit count property via 'rev-list --count' -- #357
• fixed a bug where the plugin fails when bamboo generates an unsupported gitRemoteString (the plugin now also never fails when this happens, it will simply log an exception and populate an empty string) -- #352 / #356
• various dependency updates including support for java 10 (I think that should have worked before, but its now also tested with that version) -- #347 / #372

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>2.2.5</version>
</dependency>

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)

Reporting Problems

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

Version 2.2.4

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

• Fixing an issue where -Dmaven.gitcommitid.skip=true does not skip the plugin execution when the configuration in the POM includes a <skip>false</skip> - #315
• Support for all Maven 3.X versions - #316
• The runningOnBuildServer check for detecting the branch name on Jenkins / Hudson is now using 'HUDSON_HOME' and 'JENKINS_HOME' as well - #326
• The in-built replacement of properties (only for properties generated by the plugin) now can also change the casing of the properties that the user wants to replace (e.g. lower case VS upper case). This behaviour can be achieved by defining a list of transformationRules for the property where those rules should take effect. Each transformationRule consist of two required fields apply and action. The apply-tag controls when the rule should be applied and can be set to BEFORE to have the rule being applied before or it can be set to AFTER to have the rule being applied after the replacement. The action-tag determines the string conversion rule that should be applied. Currenlty supported is LOWER_CASE and UPPER_CASE. Potential candidates in the feature are CAPITALIZATION and INVERT_CASE (open a ticket if you need them...).

<replacementProperties>
  <!-- example: apply replacement only to the specific property git.branch and replace '/' with '-' -->
  <replacementProperty>
    <property>git.branch</property>
    <!-- will not overwrite the existing property and generate a new `git.branch.something` -->
    <propertyOutputSuffix>something</propertyOutputSuffix>
    <token>^([^\/]*)\/([^\/]*)$</token>
    <value>$1-$2</value>
    <regex>true</regex>
    <transformationRules>
      <transformationRule>
        <apply>BEFORE</apply>
        <action>UPPER_CASE</action>
      </transformationRule>
      <transformationRule>
        <apply>AFTER</apply>
        <action>LOWER_CASE</action>
      </transformationRule>
    </transformationRules>
  </replacementProperty>
</replacementProperties>

See #317 for more details on a use-case.

• Release-Notes (available as RSS-Feed https://github.com/ktoso/maven-git-commit-id-plugin/releases.atom) - #324 :-)
• The code style access this project will now be verified with checkstyle rules (initial idea #214). A contributer can verify the code style either by installing the codestyle plugin in his IDE or simply run checkstyle via maven and execute mvn clean verify -Pcheckstyle -Dmaven.test.skip=true -B for java 7 and java 8. For java9 one may want to run mvn clean verify -Pcheckstyle -Dcheckstyle.version=8.2 -Dmaven.test.skip=true -B that uses a more recent checkstyle version. Feel free to check out our FAQ-Section in the Readme that contains a small write up on how you can integrate checkstyle into your IDE.
• The output properties git.closest.tag.name and git.closest.tag.count now will be determined based on properties configured inside the git-describe command (#221). Example:

<gitDescribe>
<tags>true</tags>
</gitDescribe>

will cause that lightweight tags are also included for the closest tags

Also the pattern used inside the gitDescribe might have an impact on the resulting git.closest.tag.name and git.closest.tag.count

• this project now has an Issue Template that is being used for every new issue by default - #337
• Under certain conditions the JGit implementation yielded wrong results inside the exposed git.tags property (basically it wasn't reporting all tags of a given commit) - #339
• A new option to allow to tell the plugin what commit should be used as reference to generate the properties from (#338). By default this property is simply set to HEAD which should reference to the latest commit in your repository. In general this property can be set to something generic like HEAD^1 or point to a branch or tag-name. To support any kind or use-case this configuration can also be set to an entire commit-hash or it's abbreviated version. Please note that for security purposes not all references might be allowed as configuration.
  The configuration can be used in the following:

<evaluateOnCommit>HEAD</evaluateOnCommit>

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>2.2.4</version>
</dependency>

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)

Reporting Problems

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

Version 2.2.3

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

• full Java 7, Java 8 and Java 9 support
• fixed an issue with the new Validation feature - #276
• ability to skip the plugin via commandline -Dmaven.gitcommitid.skip=true - #268
• alphabetically sort properties in generated file - #284
• M2E Lifecycle Mapping defaults now to runOnIncremental=false - #269
• a new method to replace certain characters with regular expressions (only applies for properties generated by the plugin) - #138
• ISO 8601 as default date format - #288
• git-commit-id-plugin removed project properties generated by other plugins - #310

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>2.2.3</version>
</dependency>

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)

Reporting Problems

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

Version 2.2.2

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

• add a new feature to ensure that properties meet certain criteria (e.g. fail the build when the version number contains -SNAPSHOT or git repository is dirty) - #106

<plugin>
    <groupId>pl.project13.maven</groupId>
    <artifactId>git-commit-id-plugin</artifactId>
    <version>2.2.2</version>
    <!-- optional to change the phases of the individual mojo's -->
    <executions>
        <execution>
            <id>get-the-git-infos</id>
            <goals>
                <goal>revision</goal>
            </goals>
        </execution>
        <execution>
            <id>validate-the-git-infos</id>
            <goals>
                <goal>validateRevision</goal>
            </goals>
            <!-- default phase is validate -->
            <phase>package</phase>
        </execution>
    </executions>
    <configuration>
        <validationProperties>
            <validationProperty>
                <value>${project.version}</value>
                <regex>^\Q${git.commit.id.describe}\E$|.*-SNAPSHOT$</regex>
            </validationProperty>
            <validationProperty>
                <value>${git.dirty}</value>
                <regex>false</regex>
            </validationProperty>
            <failIfNoMatch>true</failIfNoMatch>
        </validationProperties>
    </configuration>
</plugin>

• Inconsistency in dirty state (#234 and #236)
• Support GIT_LOCAL_BRANCH in Jenkins / Hudson - #248
• Update jgit to the latest Version 4.3.1.201605051710-r - #252
• Pretty-Print json in generated git file - #265

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>2.2.2</version>
</dependency>

Reporting Problems

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

Version 2.2.1

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

• fixed the ugly way of misusing slf4j (#202 and #230)
• update jgit version to v4.0.1.201506240215-r - #216
• Passwords had been exposed with git.remote.origin.url when HTTPS URIs are used - #240

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>2.2.1</version>
</dependency>

Reporting Problems

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

Version 2.2.0

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

• Java 1.6 is no longer supported with this version - #205
• updated jgit 4.0.0.201506090130-r (needs Java 1.7 and fixed an IOException on windows while building) - #205 and #203
• add the ability to set the timezone along with dateFormat with <dateFormatTimeZone>${user.timezone}</dateFormatTimeZone> - #204
• the generateGitPropertiesFilename from the README was adjusted to make it clearer that properties should be placed inside the target folder and not inside the source-Folder (e.g. use ${project.build.outputDirectory}/git.properties) - #217
• in previous versions the plugin is generating the properties commit.id and commit.id.abbrev. However those can not be put into a JSON structure (#122). If you want to populate values into a JSON structure I would recommend to checkout the new switch <commitIdGenerationMode>full</commitIdGenerationMode> which will store the commit.id as git.commit.id.full and thus allowing you to populate the values into a JSON structure. By default this switch is turned off and thus will generate the properties the old fashioned way to ensure backwards compatibility.

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>2.2.0</version>
</dependency>

Reporting Problems

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