Enable stable config cache (#1588)

Author: nedtwigg

.github/workflows/ci.yml

@@ -6,6 +6,8 @@ on:
   pull_request:
   push:
     branches: [main]
+  workflow_dispatch:
+
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: true

CHANGES.md

@@ -10,6 +10,8 @@ This document is intended for Spotless developers.
 We adhere to the [keepachangelog](https://keepachangelog.com/en/1.0.0/) format (starting after version `1.27.0`).
 
 ## [Unreleased]
+### Changes
+* We are now opting in to Gradle's new stable configuration cache. ([#1591](https://github.com/diffplug/spotless/pull/1591))
 
 ## [2.36.0] - 2023-02-27
 ### Added

_ext/gradle/p2-fat-jar-setup.gradle

@@ -12,7 +12,7 @@ ext {
 		p2Dependencies = "p2Dependencies not defined in project"
 	}
 
-	// Some JARs may include JARs themselfs, which shall be unpacked and added to the embedded class folder. 
+	// Some JARs may include JARs themselfs, which shall be unpacked and added to the embedded class folder.
 	if (!project.hasProperty('internalJars')) {
 		internalJars = []
 	}
@@ -35,13 +35,13 @@ ext {
 			'META-INF/*.SF', // ... so all signatures are filtered
 		]
 	}
-	
+
 	// Map fat-JAR resources path if JAR file name does not correspond to plugin package name (e.g. required for internal plugins)
 	if (!project.hasProperty('fatJarResourcesMap')) {
 		fatJarResourcesMap = [:]
 	}
-	  
-	
+
+
 	// The directory contains all external classes for the fat-jar
 	embeddedClassesDirName = 'build/embeddedClasses'
 	embeddedClassesDir = project.file(embeddedClassesDirName)
@@ -163,3 +163,7 @@ apply plugin: 'idea'
 // Encure that the dependent classes are preovided for compilation if project is build via Eclipse instead of command line
 tasks.idea.dependsOn(unjarEmbeddedClasses)
 
+tasks.named('ideaModule') {
+	notCompatibleWithConfigurationCache("https://github.com/gradle/gradle/issues/13480")
+}
+

gradle.properties

@@ -1,5 +1,9 @@
 # To fix metaspace errors
-org.gradle.jvmargs=-Xmx2g -XX:MaxMetaspaceSize=1024m -Dfile.encoding=UTF-8
+org.gradle.jvmargs=-Xmx4g -XX:MaxMetaspaceSize=1024m -Dfile.encoding=UTF-8
+org.gradle.parallel=true
+org.gradle.caching=true
+org.gradle.unsafe.configuration-cache=true
+
 name=spotless
 description=Spotless - keep your code spotless with Gradle
 org=diffplug

gradle/java-publish.gradle

@@ -200,6 +200,10 @@ if (System.env['JITPACK'] == 'true' || version.endsWith('-SNAPSHOT')) {
 	}
 }
 
+tasks.withType(Sign).configureEach {
+	notCompatibleWithConfigurationCache("https://github.com/gradle/gradle/issues/13470")
+}
+
 tasks.withType(AbstractArchiveTask).configureEach {
 	preserveFileTimestamps = false
 	reproducibleFileOrder = true

gradle/java-setup.gradle

@@ -30,6 +30,7 @@ tasks.withType(com.github.spotbugs.snom.SpotBugsTask).configureEach {
 	reports {
 		html.enabled = true
 	}
+	notCompatibleWithConfigurationCache("https://github.com/spotbugs/spotbugs-gradle-plugin/issues/670")
 }
 
 tasks.named('spotbugsMain') {

plugin-gradle/build.gradle

@@ -73,8 +73,10 @@ gradlePlugin {
 		}
 	}
 }
-if (version.endsWith('-SNAPSHOT')) {
-	publishPlugins.enabled = false
+
+tasks.named("publishPlugins") {
+	enabled = !version.endsWith('-SNAPSHOT')
+	notCompatibleWithConfigurationCache("https://github.com/gradle/gradle/issues/21283")
 }
 
 // have to apply java-publish after setting up the pluginBundle

plugin-maven/build.gradle

@@ -1,3 +1,6 @@
+import de.benediktritter.maven.plugin.development.task.GenerateHelpMojoSourcesTask
+import de.benediktritter.maven.plugin.development.task.GenerateMavenPluginDescriptorTask
+
 plugins {
 	// https://www.benediktritter.de/maven-plugin-development/#release-history
 	id 'de.benediktritter.maven-plugin-development' version '0.4.1'
@@ -10,13 +13,19 @@ version = spotlessChangelog.versionNext
 apply from: rootProject.file("gradle/java-setup.gradle")
 apply from: rootProject.file('gradle/spotless-freshmark.gradle')
 
-apply plugin: 'de.benediktritter.maven-plugin-development'
 mavenPlugin {
 	name = 'Spotless Maven Plugin'
 	artifactId = project.artifactIdMaven
 	description = project.description
 }
 
+tasks.withType(GenerateMavenPluginDescriptorTask).configureEach {
+	notCompatibleWithConfigurationCache('https://github.com/britter/maven-plugin-development/issues/8')
+}
+tasks.withType(GenerateHelpMojoSourcesTask).configureEach {
+	notCompatibleWithConfigurationCache('https://github.com/britter/maven-plugin-development/issues/8')
+}
+
 String VER_MAVEN_API = '3.0'
 String VER_ECLIPSE_AETHER = '1.1.0'
 String VER_PLEXUS_RESOURCES = '1.2.0'

settings.gradle

@@ -68,6 +68,8 @@ gradleEnterprise {
 	}
 }
 
+enableFeaturePreview("STABLE_CONFIGURATION_CACHE")
+
 rootProject.name = 'spotless'
 
 include 'lib'		// reusable library with no dependencies