Use configuration avoidance APIs in Gradle plugin's docs

Closes gh-30056
spring-projects · Mar 3, 2022 · e7566e9 · e7566e9
1 parent 58e2adb
commit e7566e9
Show file tree

Hide file tree

Showing 60 changed files with 135 additions and 135 deletions.
diff --git a/...ools/spring-boot-gradle-plugin/src/docs/gradle/getting-started/typical-plugins.gradle.kts b/...ools/spring-boot-gradle-plugin/src/docs/gradle/getting-started/typical-plugins.gradle.kts
@@ -7,7 +7,7 @@ plugins {
 apply(plugin = "io.spring.dependency-management")
 // end::apply[]
 
-task("verify") {
+tasks.register("verify") {
 	doLast {
 		project.plugins.getPlugin(JavaPlugin::class)
 		project.plugins.getPlugin(io.spring.gradle.dependencymanagement.DependencyManagementPlugin::class)

diff --git a/...spring-boot-gradle-plugin/src/docs/gradle/managing-dependencies/custom-version.gradle.kts b/...spring-boot-gradle-plugin/src/docs/gradle/managing-dependencies/custom-version.gradle.kts
@@ -26,7 +26,7 @@ the<DependencyManagementExtension>().apply {
 	}
 }
 
-task("slf4jVersion") {
+tasks.register("slf4jVersion") {
 	doLast {
 		println(project.the<DependencyManagementExtension>().managedVersions["org.slf4j:slf4j-api"])
 	}

diff --git a/...tools/spring-boot-gradle-plugin/src/docs/gradle/packaging/boot-build-image-builder.gradle b/...tools/spring-boot-gradle-plugin/src/docs/gradle/packaging/boot-build-image-builder.gradle
@@ -3,18 +3,18 @@ plugins {
 	id 'org.springframework.boot' version '{gradle-project-version}'
 }
 
-bootJar {
+tasks.named("bootJar") {
 	mainClass = 'com.example.ExampleApplication'
 }
 
 // tag::builder[]
-bootBuildImage {
+tasks.named("bootBuildImage") {
 	builder = "mine/java-cnb-builder"
 	runImage = "mine/java-cnb-run"
 }
 // end::builder[]
 
-task bootBuildImageBuilder {
+tasks.register("bootBuildImageBuilder") {
 	doFirst {
 		println("builder=${tasks.bootBuildImage.builder}")
 		println("runImage=${tasks.bootBuildImage.runImage}")

diff --git a/...s/spring-boot-gradle-plugin/src/docs/gradle/packaging/boot-build-image-builder.gradle.kts b/...s/spring-boot-gradle-plugin/src/docs/gradle/packaging/boot-build-image-builder.gradle.kts
@@ -6,12 +6,12 @@ plugins {
 	id("org.springframework.boot") version "{gradle-project-version}"
 }
 
-tasks.getByName<BootJar>("bootJar") {
+tasks.named<BootJar>("bootJar") {
 	mainClass.set("com.example.ExampleApplication")
 }
 
 // tag::builder[]
-tasks.getByName<BootBuildImage>("bootBuildImage") {
+tasks.named<BootBuildImage>("bootBuildImage") {
 	builder = "mine/java-cnb-builder"
 	runImage = "mine/java-cnb-run"
 }

diff --git a/...ls/spring-boot-gradle-plugin/src/docs/gradle/packaging/boot-build-image-buildpacks.gradle b/...ls/spring-boot-gradle-plugin/src/docs/gradle/packaging/boot-build-image-buildpacks.gradle
@@ -4,12 +4,12 @@ plugins {
 }
 
 // tag::buildpacks[]
-bootBuildImage {
+tasks.named("bootBuildImage") {
 	buildpacks = ["file:///path/to/example-buildpack.tgz", "urn:cnb:builder:paketo-buildpacks/java"]
 }
 // end::buildpacks[]
 
-task bootBuildImageBuildpacks {
+tasks.register("bootBuildImageBuildpacks") {
 	doFirst {
 		bootBuildImage.buildpacks.each { reference -> println "$reference" }
 	}

diff --git a/...pring-boot-gradle-plugin/src/docs/gradle/packaging/boot-build-image-buildpacks.gradle.kts b/...pring-boot-gradle-plugin/src/docs/gradle/packaging/boot-build-image-buildpacks.gradle.kts
@@ -6,7 +6,7 @@ plugins {
 }
 
 // tag::buildpacks[]
-tasks.getByName<BootBuildImage>("bootBuildImage") {
+tasks.named<BootBuildImage>("bootBuildImage") {
 	buildpacks = listOf("file:///path/to/example-buildpack.tgz", "urn:cnb:builder:paketo-buildpacks/java")
 }
 // end::buildpacks[]

diff --git a/...ng-boot-gradle-plugin/src/docs/gradle/packaging/boot-build-image-docker-auth-token.gradle b/...ng-boot-gradle-plugin/src/docs/gradle/packaging/boot-build-image-docker-auth-token.gradle
@@ -3,12 +3,12 @@ plugins {
 	id 'org.springframework.boot' version '{gradle-project-version}'
 }
 
-bootJar {
+tasks.named("bootJar") {
 	mainClass = 'com.example.ExampleApplication'
 }
 
 // tag::docker-auth-token[]
-bootBuildImage {
+tasks.named("bootBuildImage") {
 	docker {
 		builderRegistry {
 			token = "9cbaf023786cd7..."
@@ -17,7 +17,7 @@ bootBuildImage {
 }
 // end::docker-auth-token[]
 
-task bootBuildImageDocker {
+tasks.register("bootBuildImageDocker") {
 	doFirst {
 		println("token=${tasks.bootBuildImage.docker.builderRegistry.token}")
 	}

diff --git a/...oot-gradle-plugin/src/docs/gradle/packaging/boot-build-image-docker-auth-token.gradle.kts b/...oot-gradle-plugin/src/docs/gradle/packaging/boot-build-image-docker-auth-token.gradle.kts
@@ -6,12 +6,12 @@ plugins {
 	id("org.springframework.boot") version "{gradle-project-version}"
 }
 
-tasks.getByName<BootJar>("bootJar") {
+tasks.named<BootJar>("bootJar") {
 	mainClass.set("com.example.ExampleApplication")
 }
 
 // tag::docker-auth-token[]
-tasks.getByName<BootBuildImage>("bootBuildImage") {
+tasks.named<BootBuildImage>("bootBuildImage") {
 	docker {
 		builderRegistry {
 			token = "9cbaf023786cd7..."

diff --git a/...ing-boot-gradle-plugin/src/docs/gradle/packaging/boot-build-image-docker-auth-user.gradle b/...ing-boot-gradle-plugin/src/docs/gradle/packaging/boot-build-image-docker-auth-user.gradle
@@ -3,12 +3,12 @@ plugins {
 	id 'org.springframework.boot' version '{gradle-project-version}'
 }
 
-bootJar {
+tasks.named("bootJar") {
 	mainClass = 'com.example.ExampleApplication'
 }
 
 // tag::docker-auth-user[]
-bootBuildImage {
+tasks.named("bootBuildImage") {
 	docker {
 		builderRegistry {
 			username = "user"
@@ -20,7 +20,7 @@ bootBuildImage {
 }
 // end::docker-auth-user[]
 
-task bootBuildImageDocker {
+tasks.register("bootBuildImageDocker") {
 	doFirst {
 		println("username=${tasks.bootBuildImage.docker.builderRegistry.username}")
 		println("password=${tasks.bootBuildImage.docker.builderRegistry.password}")

diff --git a/...boot-gradle-plugin/src/docs/gradle/packaging/boot-build-image-docker-auth-user.gradle.kts b/...boot-gradle-plugin/src/docs/gradle/packaging/boot-build-image-docker-auth-user.gradle.kts
@@ -6,12 +6,12 @@ plugins {
 	id("org.springframework.boot") version "{gradle-project-version}"
 }
 
-tasks.getByName<BootJar>("bootJar") {
+tasks.named<BootJar>("bootJar") {
 	mainClass.set("com.example.ExampleApplication")
 }
 
 // tag::docker-auth-user[]
-tasks.getByName<BootBuildImage>("bootBuildImage") {
+tasks.named<BootBuildImage>("bootBuildImage") {
 	docker {
 		builderRegistry {
 			username = "user"

diff --git a/...s/spring-boot-gradle-plugin/src/docs/gradle/packaging/boot-build-image-docker-host.gradle b/...s/spring-boot-gradle-plugin/src/docs/gradle/packaging/boot-build-image-docker-host.gradle
@@ -3,12 +3,12 @@ plugins {
 	id 'org.springframework.boot' version '{gradle-project-version}'
 }
 
-bootJar {
+tasks.named("bootJar") {
 	mainClass = 'com.example.ExampleApplication'
 }
 
 // tag::docker-host[]
-bootBuildImage {
+tasks.named("bootBuildImage") {
 	docker {
 		host = "tcp://192.168.99.100:2376"
 		tlsVerify = true
@@ -17,7 +17,7 @@ bootBuildImage {
 }
 // end::docker-host[]
 
-task bootBuildImageDocker {
+tasks.register("bootBuildImageDocker") {
 	doFirst {
 		println("host=${tasks.bootBuildImage.docker.host}")
 		println("tlsVerify=${tasks.bootBuildImage.docker.tlsVerify}")

diff --git a/...ring-boot-gradle-plugin/src/docs/gradle/packaging/boot-build-image-docker-host.gradle.kts b/...ring-boot-gradle-plugin/src/docs/gradle/packaging/boot-build-image-docker-host.gradle.kts
@@ -6,12 +6,12 @@ plugins {
 	id("org.springframework.boot") version "{gradle-project-version}"
 }
 
-tasks.getByName<BootJar>("bootJar") {
+tasks.named<BootJar>("bootJar") {
 	mainClass.set("com.example.ExampleApplication")
 }
 
 // tag::docker-host[]
-tasks.getByName<BootBuildImage>("bootBuildImage") {
+tasks.named<BootBuildImage>("bootBuildImage") {
 	docker {
 		host = "tcp://192.168.99.100:2376"
 		isTlsVerify = true

diff --git a/...ols/spring-boot-gradle-plugin/src/docs/gradle/packaging/boot-build-image-env-proxy.gradle b/...ols/spring-boot-gradle-plugin/src/docs/gradle/packaging/boot-build-image-env-proxy.gradle
@@ -4,15 +4,15 @@ plugins {
 }
 
 // tag::env[]
-bootBuildImage {
+tasks.named("bootBuildImage") {
 	environment = [
 			"HTTP_PROXY" : "http://proxy.example.com",
 			"HTTPS_PROXY": "https://proxy.example.com"
 	]
 }
 // end::env[]
 
-task bootBuildImageEnvironment {
+tasks.register("bootBuildImageEnvironment") {
 	doFirst {
 		bootBuildImage.environment.each { name, value -> println "$name=$value" } 		
 	}

diff --git a/...spring-boot-gradle-plugin/src/docs/gradle/packaging/boot-build-image-env-proxy.gradle.kts b/...spring-boot-gradle-plugin/src/docs/gradle/packaging/boot-build-image-env-proxy.gradle.kts
@@ -6,7 +6,7 @@ plugins {
 }
 
 // tag::env[]
-tasks.getByName<BootBuildImage>("bootBuildImage") {
+tasks.named<BootBuildImage>("bootBuildImage") {
 	environment = mapOf("HTTP_PROXY" to "http://proxy.example.com",
 						"HTTPS_PROXY" to "https://proxy.example.com")
 }

diff --git a/...s/spring-boot-gradle-plugin/src/docs/gradle/packaging/boot-build-image-env-runtime.gradle b/...s/spring-boot-gradle-plugin/src/docs/gradle/packaging/boot-build-image-env-runtime.gradle
@@ -3,20 +3,20 @@ plugins {
 	id 'org.springframework.boot' version '{gradle-project-version}'
 }
 
-bootJar {
+tasks.named("bootJar") {
 	mainClass = 'com.example.ExampleApplication'
 }
 
 // tag::env-runtime[]
-bootBuildImage {
+tasks.named("bootBuildImage") {
 	environment = [
 			"BPE_DELIM_JAVA_TOOL_OPTIONS" : " ",
 			"BPE_APPEND_JAVA_TOOL_OPTIONS" : "-XX:+HeapDumpOnOutOfMemoryError"
 	]
 }
 // end::env-runtime[]
 
-task bootBuildImageEnvironment {
+tasks.register("bootBuildImageEnvironment") {
 	doFirst {
 		bootBuildImage.environment.each { name, value -> println "$name=$value" }
 	}

diff --git a/...ring-boot-gradle-plugin/src/docs/gradle/packaging/boot-build-image-env-runtime.gradle.kts b/...ring-boot-gradle-plugin/src/docs/gradle/packaging/boot-build-image-env-runtime.gradle.kts
@@ -6,7 +6,7 @@ plugins {
 }
 
 // tag::env-runtime[]
-tasks.getByName<BootBuildImage>("bootBuildImage") {
+tasks.named<BootBuildImage>("bootBuildImage") {
 	environment = mapOf(
 		"BPE_DELIM_JAVA_TOOL_OPTIONS" to " ",
 		"BPE_APPEND_JAVA_TOOL_OPTIONS" to "-XX:+HeapDumpOnOutOfMemoryError"

diff --git a/...oot-tools/spring-boot-gradle-plugin/src/docs/gradle/packaging/boot-build-image-env.gradle b/...oot-tools/spring-boot-gradle-plugin/src/docs/gradle/packaging/boot-build-image-env.gradle
@@ -4,12 +4,12 @@ plugins {
 }
 
 // tag::env[]
-bootBuildImage {
+tasks.named("bootBuildImage") {
 	environment = ["BP_JVM_VERSION" : "8.*"]
 }
 // end::env[]
 
-task bootBuildImageEnvironment {
+tasks.register("bootBuildImageEnvironment") {
 	doFirst {
 		bootBuildImage.environment.each { name, value -> println "$name=$value" }
 	}

diff --git a/...tools/spring-boot-gradle-plugin/src/docs/gradle/packaging/boot-build-image-env.gradle.kts b/...tools/spring-boot-gradle-plugin/src/docs/gradle/packaging/boot-build-image-env.gradle.kts
@@ -6,7 +6,7 @@ plugins {
 }
 
 // tag::env[]
-tasks.getByName<BootBuildImage>("bootBuildImage") {
+tasks.named<BootBuildImage>("bootBuildImage") {
 	environment = mapOf("BP_JVM_VERSION" to "8.*")
 }
 // end::env[]

diff --git a/...ot-tools/spring-boot-gradle-plugin/src/docs/gradle/packaging/boot-build-image-name.gradle b/...ot-tools/spring-boot-gradle-plugin/src/docs/gradle/packaging/boot-build-image-name.gradle
@@ -4,13 +4,13 @@ plugins {
 }
 
 // tag::image-name[]
-bootBuildImage {
+tasks.named("bootBuildImage") {
 	imageName = "example.com/library/${project.name}"
 }
 // end::image-name[]
 
-task bootBuildImageName {
-    doFirst {
-        println(tasks.bootBuildImage.imageName)
-    }
+tasks.register("bootBuildImageName") {
+	doFirst {
+		println(tasks.bootBuildImage.imageName)
+	}
 }
diff --git a/...ools/spring-boot-gradle-plugin/src/docs/gradle/packaging/boot-build-image-name.gradle.kts b/...ools/spring-boot-gradle-plugin/src/docs/gradle/packaging/boot-build-image-name.gradle.kts
@@ -6,13 +6,13 @@ plugins {
 }
 
 // tag::image-name[]
-tasks.getByName<BootBuildImage>("bootBuildImage") {
+tasks.named<BootBuildImage>("bootBuildImage") {
 	imageName = "example.com/library/${project.name}"
 }
 // end::image-name[]
 
 tasks.register("bootBuildImageName") {
-    doFirst {
-        println(tasks.getByName<BootBuildImage>("bootBuildImage").imageName)
-    }
+	doFirst {
+		println(tasks.getByName<BootBuildImage>("bootBuildImage").imageName)
+	}
 }
diff --git a/...tools/spring-boot-gradle-plugin/src/docs/gradle/packaging/boot-build-image-publish.gradle b/...tools/spring-boot-gradle-plugin/src/docs/gradle/packaging/boot-build-image-publish.gradle
@@ -3,12 +3,12 @@ plugins {
 	id 'org.springframework.boot' version '{gradle-project-version}'
 }
 
-bootJar {
+tasks.named("bootJar") {
 	mainClass = 'com.example.ExampleApplication'
 }
 
 // tag::publish[]
-bootBuildImage {
+tasks.named("bootBuildImage") {
 	imageName = "docker.example.com/library/${project.name}"
 	publish = true
 	docker {
@@ -22,8 +22,8 @@ bootBuildImage {
 }
 // end::publish[]
 
-task bootBuildImagePublish {
-    doFirst {
-        println(tasks.bootBuildImage.publish)
-    }
+tasks.register("bootBuildImagePublish") {
+	doFirst {
+		println(tasks.bootBuildImage.publish)
+	}
 }
diff --git a/...s/spring-boot-gradle-plugin/src/docs/gradle/packaging/boot-build-image-publish.gradle.kts b/...s/spring-boot-gradle-plugin/src/docs/gradle/packaging/boot-build-image-publish.gradle.kts
@@ -6,12 +6,12 @@ plugins {
 	id("org.springframework.boot") version "{gradle-project-version}"
 }
 
-tasks.getByName<BootJar>("bootJar") {
+tasks.named<BootJar>("bootJar") {
 	mainClass.set("com.example.ExampleApplication")
 }
 
 // tag::publish[]
-tasks.getByName<BootBuildImage>("bootBuildImage") {
+tasks.named<BootBuildImage>("bootBuildImage") {
 	imageName = "docker.example.com/library/${project.name}"
 	isPublish = true
 	docker {
@@ -26,7 +26,7 @@ tasks.getByName<BootBuildImage>("bootBuildImage") {
 // end::publish[]
 
 tasks.register("bootBuildImagePublish") {
-    doFirst {
-        println(tasks.getByName<BootBuildImage>("bootBuildImage").isPublish)
-    }
+	doFirst {
+		println(tasks.getByName<BootBuildImage>("bootBuildImage").isPublish)
+	}
 }
diff --git a/...s/spring-boot-gradle-plugin/src/docs/gradle/packaging/boot-jar-and-jar-classifiers.gradle b/...s/spring-boot-gradle-plugin/src/docs/gradle/packaging/boot-jar-and-jar-classifiers.gradle
@@ -4,15 +4,15 @@ plugins {
 }
 
 // tag::classifiers[]
-bootJar {
+tasks.named("bootJar") {
 	archiveClassifier = 'boot'
 }
 
-jar {
+tasks.named("jar") {
 	archiveClassifier = ''
 }
 // end::classifiers[]
 
-bootJar {
+tasks.named("bootJar") {
 	mainClass = 'com.example.Application'
 }