Set description for generated Gradle projects

YangSiJun528 · mhalbritter · commit 67ca24989b55 · 2025-08-14T09:18:35.000+02:00
See gh-1684 Signed-off-by: sijun-yang <yangsijun5528@gmail.com>
diff --git a/initializr-generator-spring/src/main/java/io/spring/initializr/generator/spring/build/gradle/GradleProjectGenerationConfiguration.java b/initializr-generator-spring/src/main/java/io/spring/initializr/generator/spring/build/gradle/GradleProjectGenerationConfiguration.java
@@ -86,7 +86,9 @@ private GradleBuild createGradleBuild(BuildItemResolver buildItemResolver,
 
 	@Bean
 	public BuildCustomizer<GradleBuild> defaultGradleBuildCustomizer(ProjectDescription description) {
-		return (build) -> build.settings().sourceCompatibility(description.getLanguage().jvmVersion());
+		return (build) -> build.settings()
+			.sourceCompatibility(description.getLanguage().jvmVersion())
+			.description(description.getDescription());
 	}
 
 	@Bean
diff --git a/initializr-generator-spring/src/test/java/io/spring/initializr/generator/spring/build/gradle/GradleKtsProjectGenerationConfigurationTests.java b/initializr-generator-spring/src/test/java/io/spring/initializr/generator/spring/build/gradle/GradleKtsProjectGenerationConfigurationTests.java
@@ -190,4 +190,14 @@ void junitPlatformIsConfiguredWithCompatibleVersion() {
 			.containsSequence("tasks.withType<Test> {", "    useJUnitPlatform()", "}");
 	}
 
+	@Test
+	void descriptionIsWrittenWhenBuildingGradleProject() {
+		MutableProjectDescription description = new MutableProjectDescription();
+		description.setDescription("Test Project");
+		description.setPlatformVersion(Version.parse("2.4.0"));
+		description.setLanguage(new JavaLanguage());
+		ProjectStructure project = this.projectTester.generate(description);
+		assertThat(project).textFile("build.gradle.kts").contains("description = \"Test Project\"");
+	}
+
 }
diff --git a/initializr-generator-spring/src/test/java/io/spring/initializr/generator/spring/build/gradle/GradleProjectGenerationConfigurationTests.java b/initializr-generator-spring/src/test/java/io/spring/initializr/generator/spring/build/gradle/GradleProjectGenerationConfigurationTests.java
@@ -213,4 +213,14 @@ void gradleAnnotationProcessorScopeCustomizerIsContributed() {
 				(context) -> assertThat(context).hasSingleBean(GradleAnnotationProcessorScopeBuildCustomizer.class));
 	}
 
+	@Test
+	void descriptionIsWrittenWhenBuildingGradleProject() {
+		MutableProjectDescription description = new MutableProjectDescription();
+		description.setDescription("Test Project");
+		description.setPlatformVersion(Version.parse("2.4.0"));
+		description.setLanguage(new JavaLanguage());
+		ProjectStructure project = this.projectTester.generate(description);
+		assertThat(project).textFile("build.gradle").contains("description = 'Test Project'");
+	}
+
 }
diff --git a/initializr-generator-spring/src/test/resources/project/gradle/annotation-processor-dependency-build.gradle.gen b/initializr-generator-spring/src/test/resources/project/gradle/annotation-processor-dependency-build.gradle.gen
@@ -6,6 +6,7 @@ plugins {
 
 group = 'com.example'
 version = '0.0.1-SNAPSHOT'
+description = 'Demo project for Spring Boot'
 
 java {
 	toolchain {
diff --git a/initializr-generator-spring/src/test/resources/project/gradle/annotation-processor-dependency-build.gradle.kts.gen b/initializr-generator-spring/src/test/resources/project/gradle/annotation-processor-dependency-build.gradle.kts.gen
@@ -6,6 +6,7 @@ plugins {
 
 group = "com.example"
 version = "0.0.1-SNAPSHOT"
+description = "Demo project for Spring Boot"
 
 java {
 	toolchain {
diff --git a/initializr-generator-spring/src/test/resources/project/gradle/bom-ordering-build.gradle.gen b/initializr-generator-spring/src/test/resources/project/gradle/bom-ordering-build.gradle.gen
@@ -6,6 +6,7 @@ plugins {
 
 group = 'com.example'
 version = '0.0.1-SNAPSHOT'
+description = 'Demo project for Spring Boot'
 
 java {
 	toolchain {
diff --git a/initializr-generator-spring/src/test/resources/project/gradle/bom-ordering-build.gradle.kts.gen b/initializr-generator-spring/src/test/resources/project/gradle/bom-ordering-build.gradle.kts.gen
@@ -6,6 +6,7 @@ plugins {
 
 group = "com.example"
 version = "0.0.1-SNAPSHOT"
+description = "Demo project for Spring Boot"
 
 java {
 	toolchain {
diff --git a/initializr-generator-spring/src/test/resources/project/gradle/bom-property-build.gradle.gen b/initializr-generator-spring/src/test/resources/project/gradle/bom-property-build.gradle.gen
@@ -6,6 +6,7 @@ plugins {
 
 group = 'com.example'
 version = '0.0.1-SNAPSHOT'
+description = 'Demo project for Spring Boot'
 
 java {
 	toolchain {
diff --git a/initializr-generator-spring/src/test/resources/project/gradle/bom-property-build.gradle.kts.gen b/initializr-generator-spring/src/test/resources/project/gradle/bom-property-build.gradle.kts.gen
@@ -6,6 +6,7 @@ plugins {
 
 group = "com.example"
 version = "0.0.1-SNAPSHOT"
+description = "Demo project for Spring Boot"
 
 java {
 	toolchain {
diff --git a/initializr-generator-spring/src/test/resources/project/gradle/compile-only-dependency-build.gradle.gen b/initializr-generator-spring/src/test/resources/project/gradle/compile-only-dependency-build.gradle.gen
@@ -6,6 +6,7 @@ plugins {
 
 group = 'com.example'
 version = '0.0.1-SNAPSHOT'
+description = 'Demo project for Spring Boot'
 
 java {
 	toolchain {
diff --git a/initializr-generator-spring/src/test/resources/project/gradle/compile-only-dependency-build.gradle.kts.gen b/initializr-generator-spring/src/test/resources/project/gradle/compile-only-dependency-build.gradle.kts.gen
@@ -6,6 +6,7 @@ plugins {
 
 group = "com.example"
 version = "0.0.1-SNAPSHOT"
+description = "Demo project for Spring Boot"
 
 java {
 	toolchain {
diff --git a/initializr-generator-spring/src/test/resources/project/gradle/kotlin-java11-build.gradle.gen b/initializr-generator-spring/src/test/resources/project/gradle/kotlin-java11-build.gradle.gen
@@ -7,6 +7,7 @@ plugins {
 
 group = 'com.example'
 version = '0.0.1-SNAPSHOT'
+description = 'Demo project for Spring Boot'
 
 java {
 	toolchain {
diff --git a/initializr-generator-spring/src/test/resources/project/gradle/kotlin-java11-build.gradle.kts.gen b/initializr-generator-spring/src/test/resources/project/gradle/kotlin-java11-build.gradle.kts.gen
@@ -7,6 +7,7 @@ plugins {
 
 group = "com.example"
 version = "0.0.1-SNAPSHOT"
+description = "Demo project for Spring Boot"
 
 java {
 	toolchain {
diff --git a/initializr-generator-spring/src/test/resources/project/gradle/repositories-build.gradle.gen b/initializr-generator-spring/src/test/resources/project/gradle/repositories-build.gradle.gen
@@ -6,6 +6,7 @@ plugins {
 
 group = 'com.example'
 version = '0.0.1-SNAPSHOT'
+description = 'Demo project for Spring Boot'
 
 java {
 	toolchain {
diff --git a/initializr-generator-spring/src/test/resources/project/gradle/repositories-build.gradle.kts.gen b/initializr-generator-spring/src/test/resources/project/gradle/repositories-build.gradle.kts.gen
@@ -6,6 +6,7 @@ plugins {
 
 group = "com.example"
 version = "0.0.1-SNAPSHOT"
+description = "Demo project for Spring Boot"
 
 java {
 	toolchain {
diff --git a/initializr-generator-spring/src/test/resources/project/gradle/repositories-milestone-build.gradle.gen b/initializr-generator-spring/src/test/resources/project/gradle/repositories-milestone-build.gradle.gen
@@ -6,6 +6,7 @@ plugins {
 
 group = 'com.example'
 version = '0.0.1-SNAPSHOT'
+description = 'Demo project for Spring Boot'
 
 java {
 	toolchain {
diff --git a/initializr-generator-spring/src/test/resources/project/gradle/repositories-milestone-build.gradle.kts.gen b/initializr-generator-spring/src/test/resources/project/gradle/repositories-milestone-build.gradle.kts.gen
@@ -6,6 +6,7 @@ plugins {
 
 group = "com.example"
 version = "0.0.1-SNAPSHOT"
+description = "Demo project for Spring Boot"
 
 java {
 	toolchain {
diff --git a/initializr-generator-spring/src/test/resources/project/gradle/version-override-build.gradle.gen b/initializr-generator-spring/src/test/resources/project/gradle/version-override-build.gradle.gen
@@ -6,6 +6,7 @@ plugins {
 
 group = 'com.example'
 version = '0.0.1-SNAPSHOT'
+description = 'Demo project for Spring Boot'
 
 java {
 	toolchain {
diff --git a/initializr-generator-spring/src/test/resources/project/gradle/version-override-build.gradle.kts.gen b/initializr-generator-spring/src/test/resources/project/gradle/version-override-build.gradle.kts.gen
@@ -6,6 +6,7 @@ plugins {
 
 group = "com.example"
 version = "0.0.1-SNAPSHOT"
+description = "Demo project for Spring Boot"
 
 java {
 	toolchain {
diff --git a/initializr-generator-spring/src/test/resources/project/groovy/next/build.gradle.gen b/initializr-generator-spring/src/test/resources/project/groovy/next/build.gradle.gen
@@ -6,6 +6,7 @@ plugins {
 
 group = 'com.example'
 version = '0.0.1-SNAPSHOT'
+description = 'Demo project for Spring Boot'
 
 java {
 	toolchain {
diff --git a/initializr-generator-spring/src/test/resources/project/groovy/next/build.gradle.kts.gen b/initializr-generator-spring/src/test/resources/project/groovy/next/build.gradle.kts.gen
@@ -6,6 +6,7 @@ plugins {
 
 group = "com.example"
 version = "0.0.1-SNAPSHOT"
+description = "Demo project for Spring Boot"
 
 java {
 	toolchain {
diff --git a/initializr-generator-spring/src/test/resources/project/groovy/standard/build.gradle.gen b/initializr-generator-spring/src/test/resources/project/groovy/standard/build.gradle.gen
@@ -6,6 +6,7 @@ plugins {
 
 group = 'com.example'
 version = '0.0.1-SNAPSHOT'
+description = 'Demo project for Spring Boot'
 
 java {
 	toolchain {
diff --git a/initializr-generator-spring/src/test/resources/project/groovy/standard/build.gradle.kts.gen b/initializr-generator-spring/src/test/resources/project/groovy/standard/build.gradle.kts.gen
@@ -6,6 +6,7 @@ plugins {
 
 group = "com.example"
 version = "0.0.1-SNAPSHOT"
+description = "Demo project for Spring Boot"
 
 java {
 	toolchain {
diff --git a/initializr-generator-spring/src/test/resources/project/groovy/standard/war-build.gradle.gen b/initializr-generator-spring/src/test/resources/project/groovy/standard/war-build.gradle.gen
@@ -7,6 +7,7 @@ plugins {
 
 group = 'com.example'
 version = '0.0.1-SNAPSHOT'
+description = 'Demo project for Spring Boot'
 
 java {
 	toolchain {
diff --git a/initializr-generator-spring/src/test/resources/project/groovy/standard/war-build.gradle.kts.gen b/initializr-generator-spring/src/test/resources/project/groovy/standard/war-build.gradle.kts.gen
@@ -7,6 +7,7 @@ plugins {
 
 group = "com.example"
 version = "0.0.1-SNAPSHOT"
+description = "Demo project for Spring Boot"
 
 java {
 	toolchain {
diff --git a/initializr-generator-spring/src/test/resources/project/java/standard/build.gradle.gen b/initializr-generator-spring/src/test/resources/project/java/standard/build.gradle.gen
@@ -6,6 +6,7 @@ plugins {
 
 group = 'com.example'
 version = '0.0.1-SNAPSHOT'
+description = 'Demo project for Spring Boot'
 
 java {
 	toolchain {
diff --git a/initializr-generator-spring/src/test/resources/project/java/standard/build.gradle.kts.gen b/initializr-generator-spring/src/test/resources/project/java/standard/build.gradle.kts.gen
@@ -6,6 +6,7 @@ plugins {
 
 group = "com.example"
 version = "0.0.1-SNAPSHOT"
+description = "Demo project for Spring Boot"
 
 java {
 	toolchain {
diff --git a/initializr-generator-spring/src/test/resources/project/java/standard/war-build.gradle.gen b/initializr-generator-spring/src/test/resources/project/java/standard/war-build.gradle.gen
@@ -7,6 +7,7 @@ plugins {
 
 group = 'com.example'
 version = '0.0.1-SNAPSHOT'
+description = 'Demo project for Spring Boot'
 
 java {
 	toolchain {
diff --git a/initializr-generator-spring/src/test/resources/project/java/standard/war-build.gradle.kts.gen b/initializr-generator-spring/src/test/resources/project/java/standard/war-build.gradle.kts.gen
@@ -7,6 +7,7 @@ plugins {
 
 group = "com.example"
 version = "0.0.1-SNAPSHOT"
+description = "Demo project for Spring Boot"
 
 java {
 	toolchain {
diff --git a/initializr-generator-spring/src/test/resources/project/kotlin/standard/build.gradle.gen b/initializr-generator-spring/src/test/resources/project/kotlin/standard/build.gradle.gen
@@ -7,6 +7,7 @@ plugins {
 
 group = 'com.example'
 version = '0.0.1-SNAPSHOT'
+description = 'Demo project for Spring Boot'
 
 java {
 	toolchain {
diff --git a/initializr-generator-spring/src/test/resources/project/kotlin/standard/build.gradle.kts.gen b/initializr-generator-spring/src/test/resources/project/kotlin/standard/build.gradle.kts.gen
@@ -7,6 +7,7 @@ plugins {
 
 group = "com.example"
 version = "0.0.1-SNAPSHOT"
+description = "Demo project for Spring Boot"
 
 java {
 	toolchain {
diff --git a/initializr-generator-spring/src/test/resources/project/kotlin/standard/war-build.gradle.gen b/initializr-generator-spring/src/test/resources/project/kotlin/standard/war-build.gradle.gen
@@ -8,6 +8,7 @@ plugins {
 
 group = 'com.example'
 version = '0.0.1-SNAPSHOT'
+description = 'Demo project for Spring Boot'
 
 java {
 	toolchain {
diff --git a/initializr-generator-spring/src/test/resources/project/kotlin/standard/war-build.gradle.kts.gen b/initializr-generator-spring/src/test/resources/project/kotlin/standard/war-build.gradle.kts.gen
@@ -8,6 +8,7 @@ plugins {
 
 group = "com.example"
 version = "0.0.1-SNAPSHOT"
+description = "Demo project for Spring Boot"
 
 java {
 	toolchain {
diff --git a/initializr-generator/src/main/java/io/spring/initializr/generator/buildsystem/gradle/GradleBuildSettings.java b/initializr-generator/src/main/java/io/spring/initializr/generator/buildsystem/gradle/GradleBuildSettings.java
@@ -33,10 +33,13 @@ public class GradleBuildSettings extends BuildSettings {
 
 	private final List<PluginMapping> pluginMappings;
 
+	private final String description;
+
 	protected GradleBuildSettings(Builder builder) {
 		super(builder);
 		this.sourceCompatibility = builder.sourceCompatibility;
 		this.pluginMappings = new ArrayList<>(builder.pluginMappings);
+		this.description = builder.description;
 	}
 
 	/**
@@ -55,6 +58,14 @@ public List<PluginMapping> getPluginMappings() {
 		return this.pluginMappings;
 	}
 
+	/**
+	 * Return a human-readable description of the project.
+	 * @return the description of the project or {@code null}
+	 */
+	public String getDescription() {
+		return this.description;
+	}
+
 	/**
 	 * Builder for {@link GradleBuildSettings}.
 	 */
@@ -64,6 +75,8 @@ public static class Builder extends BuildSettings.Builder<Builder> {
 
 		private final List<PluginMapping> pluginMappings = new ArrayList<>();
 
+		private String description;
+
 		/**
 		 * Set the java version compatibility to use when compiling Java source.
 		 * @param sourceCompatibility java version compatibility
@@ -89,6 +102,16 @@ public Builder mapPlugin(String id, Dependency pluginDependency) {
 			return this;
 		}
 
+		/**
+		 * Set a human-readable description of the project.
+		 * @param description the description of the project
+		 * @return this for method chaining
+		 */
+		public Builder description(String description) {
+			this.description = description;
+			return this;
+		}
+
 		/**
 		 * Build a {@link GradleBuildSettings} with the current state of this builder.
 		 * @return a {@link GradleBuildSettings}
diff --git a/initializr-generator/src/main/java/io/spring/initializr/generator/buildsystem/gradle/GradleBuildWriter.java b/initializr-generator/src/main/java/io/spring/initializr/generator/buildsystem/gradle/GradleBuildWriter.java
@@ -67,6 +67,7 @@ public final void writeTo(IndentingWriter writer, GradleBuild build) {
 		writePlugins(writer, build);
 		writeProperty(writer, "group", settings.getGroup());
 		writeProperty(writer, "version", settings.getVersion());
+		writeProperty(writer, "description", settings.getDescription());
 		writer.println();
 		writeJavaSourceCompatibility(writer, settings);
 		writeToolchain(writer, settings);
diff --git a/initializr-generator/src/test/java/io/spring/initializr/generator/buildsystem/gradle/GroovyDslGradleBuildWriterTests.java b/initializr-generator/src/test/java/io/spring/initializr/generator/buildsystem/gradle/GroovyDslGradleBuildWriterTests.java
@@ -611,6 +611,14 @@ void shouldCustomizeExtensions() {
 				}""");
 	}
 
+	@Test
+	void gradleBuildWithDescription() {
+		GradleBuild build = new GradleBuild();
+		build.settings().description("Demo for test");
+		String written = write(build);
+		assertThat(written).contains("description = 'Demo for test'");
+	}
+
 	protected String write(GradleBuild build) {
 		return write(new GroovyDslGradleBuildWriter(), build);
 	}
diff --git a/initializr-generator/src/test/java/io/spring/initializr/generator/buildsystem/gradle/KotlinDslGradleBuildWriterTests.java b/initializr-generator/src/test/java/io/spring/initializr/generator/buildsystem/gradle/KotlinDslGradleBuildWriterTests.java
@@ -620,6 +620,14 @@ void shouldCustomizeExtensions() {
 				}""");
 	}
 
+	@Test
+	void gradleBuildWithDescription() {
+		GradleBuild build = new GradleBuild();
+		build.settings().description("Demo for test");
+		String written = write(build);
+		assertThat(written).contains("description = \"Demo for test\"");
+	}
+
 	protected String write(GradleBuild build) {
 		return write(new KotlinDslGradleBuildWriter(), build);
 	}

Original file line number	Diff line number	Diff line change
`@@ -86,7 +86,9 @@ private GradleBuild createGradleBuild(BuildItemResolver buildItemResolver,`
`86`	`86`
`87`	`87`	`@Bean`
`88`	`88`	`public BuildCustomizer<GradleBuild> defaultGradleBuildCustomizer(ProjectDescription description) {`
`89`		`- return (build) -> build.settings().sourceCompatibility(description.getLanguage().jvmVersion());`
	`89`	`+ return (build) -> build.settings()`
	`90`	`+ .sourceCompatibility(description.getLanguage().jvmVersion())`
	`91`	`+ .description(description.getDescription());`
`90`	`92`	`}`
`91`	`93`
`92`	`94`	`@Bean`
Original file line number	Diff line number	Diff line change
`@@ -190,4 +190,14 @@ void junitPlatformIsConfiguredWithCompatibleVersion() {`
`190`	`190`	`.containsSequence("tasks.withType<Test> {", " useJUnitPlatform()", "}");`
`191`	`191`	`}`
`192`	`192`
	`193`	`+ @Test`
	`194`	`+ void descriptionIsWrittenWhenBuildingGradleProject() {`
	`195`	`+ MutableProjectDescription description = new MutableProjectDescription();`
	`196`	`+ description.setDescription("Test Project");`
	`197`	`+ description.setPlatformVersion(Version.parse("2.4.0"));`
	`198`	`+ description.setLanguage(new JavaLanguage());`
	`199`	`+ ProjectStructure project = this.projectTester.generate(description);`
	`200`	`+ assertThat(project).textFile("build.gradle.kts").contains("description = \"Test Project\"");`
	`201`	`+ }`
	`202`	`+`
`193`	`203`	`}`
Original file line number	Diff line number	Diff line change
`@@ -213,4 +213,14 @@ void gradleAnnotationProcessorScopeCustomizerIsContributed() {`
`213`	`213`	`(context) -> assertThat(context).hasSingleBean(GradleAnnotationProcessorScopeBuildCustomizer.class));`
`214`	`214`	`}`
`215`	`215`
	`216`	`+ @Test`
	`217`	`+ void descriptionIsWrittenWhenBuildingGradleProject() {`
	`218`	`+ MutableProjectDescription description = new MutableProjectDescription();`
	`219`	`+ description.setDescription("Test Project");`
	`220`	`+ description.setPlatformVersion(Version.parse("2.4.0"));`
	`221`	`+ description.setLanguage(new JavaLanguage());`
	`222`	`+ ProjectStructure project = this.projectTester.generate(description);`
	`223`	`+ assertThat(project).textFile("build.gradle").contains("description = 'Test Project'");`
	`224`	`+ }`
	`225`	`+`
`216`	`226`	`}`