predeclareDepsFromBuildscript - Mutating configuration container for buildscript of root project has been deprecated.

[simon-spinner]

Summary:
Gradle shows a deprecation warning when Spotless is used in a multi-module build with:

spotless {
    predeclareDepsFromBuildscript()
}

Warning:
Mutating configuration container for buildscript of root project 'xy' using create(String) has been deprecated.
This will fail with an error in Gradle 9.0.

Gradle: 8.12
Spotless: 7.0.1

[nedtwigg]

Does spotlessPredeclare trigger this same behavior? Seems that Gradle has been moving away from the buildscript model in general, possible that we'll have to lose it.

[simon-spinner]

If I leave out predeclareDepsFromBuildscript so that the dependencies are pulled from the root project, the deprecation warning does not show up. We are using the legacy behavior as a workaround, because the maven repository definition in the projects apply content filters. As the name of the configuration that spotless uses to download dependencies is dynamic, I cannot whitelist it.

[nedtwigg]

Roger. So we either need to:

• figure out a way around the deprecation
• make the configuration names friendlier

Here is the relevant code, PRs welcome

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

Lines 103 to 144 in f77aead

	static Provisioner forProject(Project project) {
	return forConfigurationContainer(project, project.getConfigurations(), project.getDependencies());
	}
	static Provisioner forRootProjectBuildscript(Project project) {
	Project rootProject = project.getRootProject();
	ScriptHandler buildscript = rootProject.getBuildscript();
	return forConfigurationContainer(rootProject, buildscript.getConfigurations(), buildscript.getDependencies());
	}
	private static Provisioner forConfigurationContainer(Project project, ConfigurationContainer configurations, DependencyHandler dependencies) {
	return (withTransitives, mavenCoords) -> {
	try {
	Configuration config = configurations.create("spotless"
	+ new Request(withTransitives, mavenCoords).hashCode());
	mavenCoords.stream()
	.map(dependencies::create)
	.forEach(config.getDependencies()::add);
	config.setDescription(mavenCoords.toString());
	config.setTransitive(withTransitives);
	config.setCanBeConsumed(false);
	config.setVisible(false);
	config.attributes(attr -> {
	attr.attribute(Category.CATEGORY_ATTRIBUTE, project.getObjects().named(Category.class, Category.LIBRARY));
	attr.attribute(Bundling.BUNDLING_ATTRIBUTE, project.getObjects().named(Bundling.class, Bundling.EXTERNAL));
	// TODO: This is a copy-paste from org.gradle.api.attributes.java.TargetJvmEnvironment which is added in Gradle 7.0, remove this once we drop support for Gradle 6.x.
	// Add this attribute for resolving Guava dependency, see https://github.com/google/guava/issues/6801.
	attr.attribute(Attribute.of("org.gradle.jvm.environment", String.class), "standard-jvm");
	});
	return config.resolve();
	} catch (Exception e) {
	String projName = project.getPath().substring(1).replace(':', '/');
	if (!projName.isEmpty()) {
	projName = projName + "/";
	}
	throw new GradleException(String.format(
	"You need to add a repository containing the '%s' artifact in '%sbuild.gradle'.%n" +
	"E.g.: 'repositories { mavenCentral() }'",
	mavenCoords, projName), e);
	}
	};
	}

[simon-spinner]

Why does it include a hashcode in the configuration name? Can there be multiple such configurations in the same project?

[nedtwigg]

There can be multiple spotless configurations, yeah. But there is only one for each step. Easiest would be to change the name to be based on the maven coordinate of the first jar, could be with or without the version string.

• spotless-com.google.googlejavaformat:google-java-format:1.25.2
• spotless-com.google.googlejavaformat:google-java-format

Could also remove the group, which would make it just

• spotless-google-java-format

Which configuration naming convention would work best for you?

[simon-spinner]

If we can leave out the version number from the name, that would be great. I don't have an opinion whether the group id should be included or not. Works both for me.