refactor: prevent cluttering version logs

Author: qoomon

build.gradle

@@ -12,7 +12,7 @@ plugins {
 }
 
 group 'me.qoomon'
-version '6.4.3'
+version '6.4.4'
 sourceCompatibility = JavaVersion.VERSION_11
 targetCompatibility = JavaVersion.VERSION_11
 

src/main/java/me/qoomon/gradle/gitversioning/GitVersioningPluginExtension.java

@@ -35,13 +35,12 @@
 import static java.util.Collections.emptyList;
 import static java.util.Collections.singletonList;
 import static java.util.Comparator.comparing;
-import static java.util.Objects.requireNonNull;
 import static java.util.stream.Collectors.toList;
 import static me.qoomon.gitversioning.commons.GitRefType.*;
 import static me.qoomon.gitversioning.commons.StringUtil.*;
 import static org.apache.commons.lang3.StringUtils.*;
-import static org.eclipse.jgit.lib.Constants.HEAD;
 
+@SuppressWarnings("StringConcatenationArgumentToLogCall")
 public abstract class GitVersioningPluginExtension {
 
     private static final Pattern VERSION_PATTERN = Pattern.compile(".*?(?<version>(?<core>(?<major>\\d+)(?:\\.(?<minor>\\d+)(?:\\.(?<patch>\\d+))?)?)(?:-(?<label>.*))?)|");
@@ -80,7 +79,7 @@ public void apply(GitVersioningPluginConfig config) throws IOException {
     }
 
     private void apply() throws IOException {
-        // check if extension is disabled by command option
+        // check if the extension is disabled by command option
         final String commandOptionDisable = getCommandOption(OPTION_NAME_DISABLE);
         if (commandOptionDisable != null) {
             boolean disabled = parseBoolean(commandOptionDisable);
@@ -89,7 +88,7 @@ private void apply() throws IOException {
                 return;
             }
         } else {
-            // check if extension is disabled by config option
+            // check if the extension is disabled by config option
             if (config.disable) {
                 project.getLogger().warn("skip - versioning is disabled by config option");
                 return;
@@ -126,25 +125,25 @@ private void apply() throws IOException {
 
         project.getLogger().lifecycle("matching ref: " + gitVersionDetails.getRefType().name() + " - " + gitVersionDetails.getRefName());
         final RefPatchDescription patchDescription = gitVersionDetails.getPatchDescription();
-        project.getLogger().lifecycle("ref configuration: " + gitVersionDetails.getRefType().name() + " - pattern: " + patchDescription.pattern);
+        project.getLogger().lifecycle("  ref configuration: " + gitVersionDetails.getRefType().name() + " - pattern: " + patchDescription.pattern);
+        if (patchDescription.version != null) {
+            project.getLogger().lifecycle("    version: " + patchDescription.version);
+        }
+        if (!patchDescription.properties.isEmpty()) {
+            project.getLogger().lifecycle("    properties:");
+            patchDescription.properties.forEach((key, value) -> project.getLogger().lifecycle("    " + key + ": " + value));
+        }
         if (patchDescription.describeTagPattern != null) {
-            project.getLogger().lifecycle("  describeTagPattern: " + patchDescription.describeTagPattern);
+            project.getLogger().lifecycle("    describeTagPattern: " + patchDescription.describeTagPattern);
             gitSituation.setDescribeTagPattern(patchDescription.getDescribeTagPattern());
         }
         if (patchDescription.describeTagFirstParent != null) {
-            project.getLogger().info("  describeTagFirstParent: " + patchDescription.describeTagFirstParent);
+            project.getLogger().lifecycle("    describeTagFirstParent: " + patchDescription.describeTagFirstParent);
             gitSituation.setFirstParent(patchDescription.describeTagFirstParent);
         }
-        if (patchDescription.version != null) {
-            project.getLogger().lifecycle("  version: " + patchDescription.version);
-        }
-        if (!patchDescription.properties.isEmpty()) {
-            project.getLogger().lifecycle("  properties:");
-            patchDescription.properties.forEach((key, value) -> project.getLogger().lifecycle("    " + key + ": " + value));
-        }
         boolean updateGradleProperties = getUpdateGradlePropertiesOption(patchDescription);
         if (updateGradleProperties) {
-            project.getLogger().lifecycle("  updateGradleProperties: " + updateGradleProperties);
+            project.getLogger().lifecycle("    updateGradleProperties: true");
         }
 
         globalFormatPlaceholderMap = generateGlobalFormatPlaceholderMap(gitSituation, gitVersionDetails, project);
@@ -157,7 +156,11 @@ private void apply() throws IOException {
             final String versionFormat = patchDescription.version;
             if (versionFormat != null) {
                 updateVersion(project, versionFormat);
-                project.getLogger().lifecycle("project version: " + project.getVersion());
+                if(project == project.getRootProject()) {
+                    project.getLogger().lifecycle("project version: " + project.getVersion());
+                } else if (!project.getVersion().equals(project.getRootProject().getVersion())) {
+                    project.getLogger().lifecycle(project.getName()+ " > project version: " + project.getVersion());
+                }
             }
 
             final Map<String, String> propertyFormats = patchDescription.properties;
@@ -312,7 +315,7 @@ private void handleEnvironment(Repository repository) throws IOException {
                     }
                 }
 
-                // --- try getting branch and tag situation from environment ---
+                // --- try getting the branch and tag situation from environment ---
                 // skip if we are on a branch
                 if (repository.getBranch() == null) {
                     return;
@@ -400,6 +403,7 @@ private void handleEnvironment(Repository repository) throws IOException {
                     } else if (!isBlank(commitTag)) {
                         addTag(commitTag);
                     }
+                    //noinspection UnnecessaryReturnStatement
                     return;
                 }
             }
@@ -678,11 +682,7 @@ private boolean getUpdateGradlePropertiesOption(final RefPatchDescription gitRef
             return parseBoolean(updateGradlePropertiesOption);
         }
 
-        if (gitRefConfig.updateGradleProperties != null) {
-            return gitRefConfig.updateGradleProperties;
-        }
-
-        return false;
+        return Objects.requireNonNullElse(gitRefConfig.updateGradleProperties, false);
     }
 
 

src/test/resources/testProjects/multiModuleProject/build.gradle

@@ -1,5 +1,5 @@
 plugins {
-    id 'me.qoomon.git-versioning' version '6.4.3'
+    id 'me.qoomon.git-versioning' version '6.4.4'
 }
 
 gitVersioning.apply {

src/test/resources/testProjects/standardProject/build.gradle

@@ -1,5 +1,5 @@
 plugins {
-    id 'me.qoomon.git-versioning' version '6.4.2'
+    id 'me.qoomon.git-versioning' version '6.4.4'
 }
 
 gitVersioning.apply {

src/test/resources/testProjects/standardProjectKotlinDSL/build.gradle.kts

@@ -3,7 +3,7 @@ import kotlin.reflect.full.declaredMemberProperties
 import kotlin.reflect.full.declaredMembers
 
 plugins {
-    id("me.qoomon.git-versioning") version "6.4.2"
+    id("me.qoomon.git-versioning") version "6.4.4"
 }
 
 gitVersioning.apply {