do not execute for non root

Author: lazer-dev

lib/src/main/java/com/diffplug/spotless/GitPrePushHookInstaller.java

@@ -82,6 +82,9 @@ public void install() throws Exception {
 			return;
 		}
 
+		// Since hook installation is a manual task triggered by the user,
+		// using synchronized locking is acceptable. It ensures thread safety
+		// without affecting overall performance, and provides a simple and reliable solution.
 		synchronized (LOCK) {
 			if (installing) {
 				logger.warn("Parallel Spotless Git pre-push hook installation detected, skipping installation");

plugin-gradle/CHANGES.md

@@ -3,6 +3,7 @@
 We adhere to the [keepachangelog](https://keepachangelog.com/en/1.0.0/) format (starting after version `3.27.0`).
 
 ## [Unreleased]
+* Fixed `spotlessInstallGitPrePushHook` task: now compatible with Gradle configuration cache and safe for parallel execution.
 ### Changed
 * **BREAKING** Bump the required Gradle to `7.3` and required Java to `17`. ([#2375](https://github.com/diffplug/spotless/issues/2375), [#2540](https://github.com/diffplug/spotless/pull/2540))
 * Bump JGit from `6.10.1` to `7.3.0` ([#2257](https://github.com/diffplug/spotless/pull/2257))

plugin-gradle/src/main/java/com/diffplug/gradle/spotless/SpotlessExtensionImpl.java

@@ -42,6 +42,7 @@ public SpotlessExtensionImpl(Project project) {
 			task.setGroup(BUILD_SETUP_TASK_GROUP);
 			task.setDescription(INSTALL_GIT_PRE_PUSH_HOOK_DESCRIPTION);
 			task.getRootDir().set(project.getRootDir());
+			task.getIsRootExecution().set(project.equals(project.getRootProject()));
 		});
 
 		project.afterEvaluate(unused -> {

plugin-gradle/src/main/java/com/diffplug/gradle/spotless/SpotlessInstallPrePushHookTask.java

@@ -39,6 +39,12 @@ public abstract class SpotlessInstallPrePushHookTask extends DefaultTask {
 	@Internal
 	abstract Property<File> getRootDir();
 
+	/**
+	 * Determines whether this task is being executed from the root project.
+	 */
+	@Internal
+	abstract Property<Boolean> getIsRootExecution();
+
 	/**
 	 * Executes the task to install the Git pre-push hook.
 	 *
@@ -50,6 +56,12 @@ public abstract class SpotlessInstallPrePushHookTask extends DefaultTask {
 	 */
 	@TaskAction
 	public void performAction() throws Exception {
+		// if is not root project, skip it
+		if (!getIsRootExecution().get()) {
+			getLogger().debug("Skipping Spotless pre-push hook installation because it is not being executed from the root project.");
+			return;
+		}
+
 		final var logger = new GitPreHookLogger() {
 			@Override
 			public void info(String format, Object... arguments) {

plugin-maven/CHANGES.md

@@ -3,6 +3,7 @@
 We adhere to the [keepachangelog](https://keepachangelog.com/en/1.0.0/) format (starting after version `1.27.0`).
 
 ## [Unreleased]
+* Improved support for multi-module projects: Git pre-push hook is now always installed in the root `.git/hooks` directory by resolving the top-level project base directory.
 ### Changes
 * **BREAKING** Bump the required Java to `17`. ([#2375](https://github.com/diffplug/spotless/issues/2375), [#2540](https://github.com/diffplug/spotless/pull/2540))
 * Bump JGit from `6.10.1` to `7.3.0` ([#2257](https://github.com/diffplug/spotless/pull/2257))

plugin-maven/src/main/java/com/diffplug/spotless/maven/SpotlessInstallPrePushHookMojo.java

@@ -15,13 +15,12 @@
  */
 package com.diffplug.spotless.maven;
 
-import java.io.File;
-
 import org.apache.maven.plugin.AbstractMojo;
 import org.apache.maven.plugin.MojoExecutionException;
 import org.apache.maven.plugin.MojoFailureException;
 import org.apache.maven.plugins.annotations.Mojo;
 import org.apache.maven.plugins.annotations.Parameter;
+import org.apache.maven.project.MavenProject;
 
 import com.diffplug.spotless.GitPrePushHookInstaller.GitPreHookLogger;
 import com.diffplug.spotless.GitPrePushHookInstallerMaven;
@@ -37,12 +36,8 @@
 @Mojo(name = AbstractSpotlessMojo.GOAL_PRE_PUSH_HOOK, threadSafe = true)
 public class SpotlessInstallPrePushHookMojo extends AbstractMojo {
 
-	/**
-	 * The base directory of the Maven project where the Git pre-push hook will be installed.
-	 * This parameter is automatically set to the root directory of the current project.
-	 */
-	@Parameter(defaultValue = "${project.basedir}", readonly = true, required = true)
-	private File baseDir;
+	@Parameter(defaultValue = "${project}", readonly = true, required = true)
+	private MavenProject project;
 
 	/**
 	 * Executes the Mojo, installing the Git pre-push hook for the Spotless plugin.
@@ -56,6 +51,12 @@ public class SpotlessInstallPrePushHookMojo extends AbstractMojo {
 	 */
 	@Override
 	public void execute() throws MojoExecutionException, MojoFailureException {
+		// if is not root project, skip it
+		if (!project.isExecutionRoot()) {
+			getLog().debug("Skipping Spotless pre-push hook installation for non-root project: " + project.getName());
+			return;
+		}
+
 		final var logger = new GitPreHookLogger() {
 			@Override
 			public void info(String format, Object... arguments) {
@@ -74,7 +75,7 @@ public void error(String format, Object... arguments) {
 		};
 
 		try {
-			final var installer = new GitPrePushHookInstallerMaven(logger, baseDir);
+			final var installer = new GitPrePushHookInstallerMaven(logger, project.getBasedir());
 			installer.install();
 		} catch (Exception e) {
 			throw new MojoExecutionException("Unable to install pre-push hook", e);

testlib/src/test/java/com/diffplug/spotless/GitPrePushHookInstallerTest.java

@@ -54,6 +54,11 @@ public void error(String format, Object... arguments) {
 	@BeforeEach
 	public void beforeEach() {
 		System.setProperty("os.name", "linux");
+
+		final var hookFile = newFile(".git/hooks/pre-push");
+		if (hookFile.exists()) {
+			hookFile.delete();
+		}
 	}
 
 	@AfterEach