git-commit-id/git-commit-id-plugin-core#247 / #136 / #535: Add support for perModuleVersions

Author: TheSnoozer

pom.xml

@@ -63,7 +63,7 @@
             <dependency>
                 <groupId>${project.groupId}</groupId>
                 <artifactId>git-commit-id-plugin-core</artifactId>
-                <version>6.0.0</version>
+                <version>6.1.5</version>
             </dependency>
             <dependency>
                 <groupId>com.google.code.findbugs</groupId>

src/main/java/pl/project13/maven/git/GitCommitIdMojo.java

@@ -130,6 +130,31 @@ public class GitCommitIdMojo extends AbstractMojo {
   @Parameter(defaultValue = "false")
   boolean injectAllReactorProjects;
 
+  /**
+   * Configuration to enable per-module version generation.
+   * When enabled, the plugin will only consider commits affecting paths within the current module.
+   *
+   * <p>By default this option is disabled (set to {@code false})
+   *
+   * <p>This is useful in multi-module builds where you want to track module-specific changes
+   * rather than the entire repository's commit history.
+   *
+   * <p>Example:
+   *
+   * <pre>{@code
+   * <perModuleVersions>true</perModuleVersions>
+   * }</pre>
+   *
+   * See
+   * - https://github.com/git-commit-id/git-commit-id-plugin-core/pull/247
+   * - https://github.com/git-commit-id/git-commit-id-maven-plugin/issues/136
+   * - https://github.com/git-commit-id/git-commit-id-maven-plugin/pull/535
+   *
+   * @since 9.1.0
+   */
+  @Parameter(defaultValue = "false")
+  boolean perModuleVersions;
+
   /**
    * Configuration to tell the git-commit-id-maven-plugin to print some more verbose information
    * during the build (e.g. a summary of all collected properties when it's done).
@@ -1404,6 +1429,11 @@ public boolean shouldPropertiesEscapeUnicode() {
             public boolean shouldFailOnNoGitDirectory() {
               return failOnNoGitDirectory;
             }
+
+            @Override
+            public boolean isPerModuleVersions() {
+              return perModuleVersions;
+            }
           };
 
       GitCommitIdPlugin.runPlugin(cb, properties);

src/test/java/pl/project13/maven/git/AvailableGitTestRepo.java

@@ -124,6 +124,28 @@ public enum AvailableGitTestRepo {
    */
   WITH_THREE_COMMITS_AND_TWO_TAGS_CURRENTLY_ON_COMMIT_WITHOUT_TAG(
       "src/test/resources/_git_three_commits_and_two_tags_currently_on_commit_without_tag"),
+  /**
+   * <pre>
+   * $  git log --name-only --pretty=format:"%H '%an' '%aD' '%s' %d" --date=short
+   * 2ed2ea209fb99c360cd8434eb2d82b929da6b908 'TheSnoozer' 'Fri, 27 Mar 2026 17:40:36 +0100' 'a change in the root pom'  (HEAD -> master)
+   * pom.xml
+   *
+   * 70a13b95591dac76ce92dd9087d557fca539f98a 'submodule-two Author' 'Fri, 27 Mar 2026 17:39:59 +0100' 'a change in submodule-two'  (tag: tag-submodule-two)
+   * submodule-two/pom.xml
+   *
+   * 91e49245092c089624d3e770d902cfc8bc53a852 'submodule-one Author' 'Fri, 27 Mar 2026 17:39:23 +0100' 'a change in submodule-one'  (tag: tag-submodule-one)
+   * submodule-one/pom.xml
+   *
+   * 9c5d2e13d042b0acb71c48232a9c408e42da87f7 'TheSnoozer' 'Fri, 27 Mar 2026 17:38:16 +0100' 'new repo for testing (based on git-commit-id-maven-debugging)'
+   * [snip]
+   * </pre>
+   * and dirty:
+   * <pre>
+   * $ git status -s
+   * M submodule-two/pom.xml
+   * </pre>
+   */
+  WITH_SUBMODULES_AND_MULTIPLE_COMMITS("src/test/resources/_git_with_submodules_and_multiple_commits"),
   // TODO: Why do the tests get stuck when we use .git??
   MAVEN_GIT_COMMIT_ID_PLUGIN("src/test/resources/_git_one_commit_with_umlaut");
 

src/test/java/pl/project13/maven/git/GitCommitIdMojoIntegrationTest.java

@@ -1716,6 +1716,90 @@ public void shouldGeneratePropertiesWithMultiplePrefixesAndReactorProject(boolea
     }
   }
 
+  static Stream<Arguments> useNativeGitWithSubmoduleName() {
+    return useNativeGit().flatMap(arg ->
+      Stream.of(
+        "submodule-one",
+        "submodule-two"
+      ).map(str ->
+        Arguments.of(arg.get()[0], str)
+      )
+    );
+  }
+
+  @ParameterizedTest
+  @MethodSource("useNativeGitWithSubmoduleName")
+  public void shouldGiveCommitIdForEachFolderWhenPerModuleVersionsEnabled(boolean useNativeGit, String submoduleName) throws Exception {
+    // given
+    mavenSandbox
+            .withParentProject("my-pom-project", "pom")
+            .withGitRepoInParent(AvailableGitTestRepo.WITH_SUBMODULES_AND_MULTIPLE_COMMITS)
+            .withChildProject(submoduleName, "jar")
+            .create();
+    MavenProject targetProject = mavenSandbox.getChildProject();
+
+    setProjectToExecuteMojoIn(targetProject);
+
+    GitDescribeConfig gitDescribeConfig = createGitDescribeConfig(false, 7);
+
+    mojo.gitDescribe = gitDescribeConfig;
+    mojo.useNativeGit = useNativeGit;
+    mojo.perModuleVersions = true;
+    mojo.dateFormatTimeZone = "CET";
+
+    // when
+    mojo.execute();
+    // then
+    Properties properties = targetProject.getProperties();
+    assertGitPropertiesPresentInProject(properties);
+
+    // setup expectations
+    Map<String, Object> expectedValues = new HashMap<>();
+    expectedValues.put("git.commit.id.full", null);
+    expectedValues.put("git.closest.tag.name", "tag-" + submoduleName);
+    expectedValues.put("git.closest.tag.commit.count", null);
+    expectedValues.put("git.dirty", null);
+    expectedValues.put("git.commit.message.full", "a change in " + submoduleName);
+    expectedValues.put("git.commit.user.name", submoduleName + " Author");
+    expectedValues.put("git.commit.user.email", submoduleName + "@example.com");
+    expectedValues.put("git.commit.time", null);
+    expectedValues.put("git.commit.author.time", null);
+    expectedValues.put("git.commit.committer.time", null);
+
+    if (submoduleName.equals("submodule-one")) {
+      expectedValues.put("git.commit.id.full", "91e49245092c089624d3e770d902cfc8bc53a852");
+      expectedValues.put("git.closest.tag.commit.count", 0);
+      expectedValues.put("git.dirty", true); // Really?
+      // date -d @$(git log -1 --pretty=format:%ct 91e4924) "+%Y-%m-%dT%H:%M:%S%z"
+      expectedValues.put("git.commit.time", "2026-03-28T11:47:51+0100");
+      // date -d @$(git log -1 --pretty=format:%at 91e4924) "+%Y-%m-%dT%H:%M:%S%z"
+      expectedValues.put("git.commit.author.time", "2026-03-27T17:39:23+0100");
+      // date -d @$(git log -1 --pretty=format:%ct 91e4924) "+%Y-%m-%dT%H:%M:%S%z"
+      expectedValues.put("git.commit.committer.time", "2026-03-28T11:47:51+0100");
+    } else if (submoduleName.equals("submodule-two")) {
+      expectedValues.put("git.commit.id.full", "70a13b95591dac76ce92dd9087d557fca539f98a");
+      expectedValues.put("git.closest.tag.commit.count", 0);
+      expectedValues.put("git.dirty", true);
+      // date -d @$(git log -1 --pretty=format:%ct 70a13b9) "+%Y-%m-%dT%H:%M:%S%z"
+      expectedValues.put("git.commit.time", "2026-03-28T11:48:17+0100");
+      // date -d @$(git log -1 --pretty=format:%at 70a13b9) "+%Y-%m-%dT%H:%M:%S%z"
+      expectedValues.put("git.commit.author.time", "2026-03-27T17:39:59+0100");
+      // date -d @$(git log -1 --pretty=format:%ct 70a13b9) "+%Y-%m-%dT%H:%M:%S%z"
+      expectedValues.put("git.commit.committer.time", "2026-03-28T11:48:17+0100");
+    }
+
+    // Assertions
+    for (Map.Entry<String, Object> entry : expectedValues.entrySet()) {
+      String key = entry.getKey();
+      Object expectedValue = entry.getValue();
+
+      assertThat(expectedValue).isNotNull();
+      assertThat(properties.getProperty(key))
+              .as("useNativeGit=%s,submoduleName=%s,key=%s", useNativeGit, submoduleName, key)
+              .isEqualTo(String.valueOf(expectedValue));
+    }
+  }
+
   private GitDescribeConfig createGitDescribeConfig(boolean forceLongFormat, int abbrev) {
     GitDescribeConfig gitDescribeConfig = new GitDescribeConfig();
     gitDescribeConfig.setTags(true);