Using git-commit-id-plugin in maven works in package-phase but not in install-phase

Question

I'm using the git-commit-id-plugin (see https://github.com/ktoso/maven-git-commit-id-plugin). It packages correctly when I'm setting up an annotated tag like e.g. v1.0.0, meaning the target-directory has a jar file named deploy-test-Test-v1.0.0.jar. The problem is, that the maven install phase creates the following files in my local .m2-directory:

Test-${git.closest.tag.name}
|-   deploy-test-Test-${git.closest.tag.name}.jar
|-    deploy-test-Test-${git.closest.tag.name}.pom
|-    _remote.repositories

I've tested this with the example pom.xml.
What can I do to get the same name (deploy-test-Test-v1.0.0.jar)?

<project xmlns="http://maven.apache.org/POM/4.0.0"  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"   xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.mytest</groupId>
<artifactId>deploy-test</artifactId>
<packaging>jar</packaging>
<version>Test-${git.closest.tag.name}</version>
<properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <revision>Test-${git.closest.tag.name}</revision>
</properties>
<dependencies/>
<build>
    <plugins>
        <plugin>
            <groupId>pl.project13.maven</groupId>
            <artifactId>git-commit-id-plugin</artifactId>
            <version>2.2.4</version>
            <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>
                    <!-- *NOTE*: The default phase of validateRevision is verify, but in case you want to change it, you can do so by adding the phase here -->
                    <phase>package</phase>
                </execution>                    
            </executions>
            <configuration>
                <!-- If you'd like to tell the plugin where your .git directory is, use this setting, otherwise we'll perform a search trying to figure out the right directory. It's better to add it explicitly IMHO. -->
                <dotGitDirectory>${project.basedir}/.git</dotGitDirectory>
                <prefix>git</prefix>
                <dateFormat>yyyy-MM-dd'T'HH:mm:ssZ</dateFormat>
                <dateFormatTimeZone>${user.timezone}</dateFormatTimeZone>
                <verbose>false</verbose>
                <generateGitPropertiesFile>true</generateGitPropertiesFile>
                <generateGitPropertiesFilename>${project.build.outputDirectory}/git.properties</generateGitPropertiesFilename>
                <format>properties</format>
                <skipPoms>true</skipPoms>
                <injectAllReactorProjects>false</injectAllReactorProjects>
                <failOnNoGitDirectory>true</failOnNoGitDirectory>
                <failOnUnableToExtractRepoInfo>true</failOnUnableToExtractRepoInfo>
                <skip>false</skip>
                <runOnlyOnce>false</runOnlyOnce>
                <useNativeGit>false</useNativeGit>
                <abbrevLength>7</abbrevLength>
                <commitIdGenerationMode>flat</commitIdGenerationMode>
                <gitDescribe>
                    <skip>false</skip>
                    <always>false</always>
                    <abbrev>7</abbrev>
                    <dirty>-dirty</dirty>
                    <match>*</match>
                    <tags>false</tags>
                    <forceLongFormat>false</forceLongFormat>
                </gitDescribe>
                <validationProperties>
                    <validationProperty>
                        <name>validating project version</name>
                        <value>${project.version}</value>
                        <shouldMatchTo>
                            <![CDATA[^.*(?<!-SNAPSHOT)$]]>
                        </shouldMatchTo>
                    </validationProperty>
                </validationProperties>
                <validationShouldFailIfNoMatch>true</validationShouldFailIfNoMatch>
                <evaluateOnCommit>HEAD</evaluateOnCommit>
            </configuration>
        </plugin>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <configuration>
                <source>1.8</source>
                <target>1.8</target>
            </configuration>
        </plugin>
    </plugins>
</build>

score 3 · Answer 1 · edited Feb 13 '19 at 08:45

To incorporate git-commit-id plugin into the version number for the entire maven build cycle (till deploy)

<properties>
  <java.version>1.8</java.version>
  <snapshot.string>-SNAPSHOT</snapshot.string>
  <!-- Snapshot Version Number -->
  <!-- <version.number>${git.commit.time}.${git.commit.id.abbrev}${s`enter code here`napshot.string}</version.number> -->
  <!-- Release Version Number -->
  <version.number>${git.commit.time}.${git.commit.id.abbrev}</version.number>
  <release.repo.key>libs-release-local</release.repo.key>
  <snapshot.repo.key>libs-snapshot-local</snapshot.repo.key>
  <artifactory.url>http://xxx.xxx.x.xxx:yyyy/artifactory</artifactory.url>
  <release.repository.url>${artifactory.url}/${release.repo.key}</release.repository.url>
  <snapshot.repository.url>${artifactory.url}/${snapshot.repo.key}</snapshot.repository.url>
</properties>


<build>
  <plugins>
    <plugin>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-maven-plugin</artifactId>
    </plugin>
    <plugin>
      <groupId>pl.project13.maven</groupId>
      <artifactId>git-commit-id-plugin</artifactId>
      <executions>
        <execution>
          <phase>validate</phase>
          <goals>
            <goal>revision</goal>
          </goals>
        </execution>
      </executions>
      <configuration>
        <dateFormat>yyyyMMdd.HHmmss</dateFormat>
        <dotGitDirectory>${project.basedir}/.git</dotGitDirectory>
        <generateGitPropertiesFile>false</generateGitPropertiesFile>
        <injectAllReactorProjects>true</injectAllReactorProjects>
      </configuration>
    </plugin>
    <plugin>
      <groupId>org.codehaus.gmavenplus</groupId>
      <artifactId>gmavenplus-plugin</artifactId>
      <version>1.6</version>
      <executions>
        <execution>
          <id>change-version</id>
          <phase>validate</phase>
          <goals>
            <goal>execute</goal>
          </goals>
          <configuration>
            <scripts>
              <script>
                < ![CDATA[
                  import org.apache.maven.artifact.versioning.VersionRange; git_revision = '${version.number}'
                  if (!project.properties['revision'] ? .trim()) {
                    println 'Change `version` to ' + git_revision
                    System.properties['revision'] = git_revision
                    project.properties['revision'] = git_revision
                    project.properties['project.version'] = git_revision
                    project.properties['git.build.version'] = git_revision
                    project.version = git_revision
                    project.artifact.version = git_revision
                    project.artifact.versionRange = VersionRange.createFromVersion(git_revision)
                  }
                ]] >
              </script>
            </scripts>
          </configuration>
        </execution>
      </executions>
      <dependencies>
        <dependency>
          <groupId>org.codehaus.groovy</groupId>
          <artifactId>groovy-all</artifactId>
          <version>2.4.14</version>
          <scope>runtime</scope>
        </dependency>
      </dependencies>
    </plugin>
  </plugins>
</build>
<distributionManagement>
  <repository>
    <uniqueVersion>false</uniqueVersion>
    <id>release</id>
    <name>local-releases</name>
    <url>${release.repository.url}</url>
  </repository>
  <snapshotRepository>
    <uniqueVersion>true</uniqueVersion>
    <id>snapshots</id>
    <name>local-snapshots</name>
    <url>${snapshot.repository.url}</url>
  </snapshotRepository>
</distributionManagement>

Also refer to this to work around the "plugin execution not covered by lifecycle" error in Eclipse/SpringToolSuite

see: How to solve "Plugin execution not covered by lifecycle configuration" for Spring Data Maven Builds

score 0 · Answer 2 · answered Aug 15 '18 at 09:19

I've found a solution that worked fine for me. Just added the gmaven-plugin like in the pom-snippet below and the versions will be adapted to the last git-tag.

<plugin>
<groupId>org.codehaus.gmaven</groupId>
<artifactId>groovy-maven-plugin</artifactId>
<version>2.0</version>
<executions>
    <execution>
        <phase>install</phase>
        <goals>
            <goal>execute</goal>
        </goals>
        <configuration>
            <source>project.artifact.version='${git.closest.tag.name}';</source>
        </configuration>
    </execution>
</executions>

score 0 · Answer 3 · answered Jul 29 '19 at 10:13

I've also used groovy-maven-plugin to update project.properties. Without this pom.xml was generated with variables that have not been parsed.

project properties

<properties>
    <gitClosestTagName>${git.closest.tag.name}</gitClosestTagName>
    <gitClosestTagCommitCount>${git.closest.tag.commit.count}</gitClosestTagCommitCount>
</properties>

build final name atteribute

<finalName>${project.artifactId}-${gitClosestTagName}.${gitClosestTagCommitCount}</finalName>

plugin definition

<plugin>
<groupId>org.codehaus.gmaven</groupId>
<artifactId>groovy-maven-plugin</artifactId>
<version>2.0</version>
<executions>
    <execution>
        <id>update-finalname</id>
        <phase>validate</phase>
        <goals>
            <goal>execute</goal>
        </goals>
        <configuration>
            <source>
                project.build.finalName="${project.artifactId}-${gitClosestTagName}.${gitClosestTagCommitCount}";
                project.properties['gitClosestTagName']=${git.closest.tag.name};
                project.properties['gitClosestTagCommitCount']=${git.closest.tag.commit.count};
                println("project.build.finalName=${project.build.finalName}");
            </source>
        </configuration>
    </execution>
</executions>

Using git-commit-id-plugin in maven works in package-phase but not in install-phase

3 Answers3