From 10260c084bb61ae32a9da2e94dce3b351359978c Mon Sep 17 00:00:00 2001 From: Phillip Webb Date: Thu, 28 Mar 2024 13:21:27 -0700 Subject: [PATCH] Rename Antora component from spring-boot to boot Closes gh-40131 --- .../org/springframework/boot/build/AntoraConventions.java | 5 ++--- .../boot/build/antora/GenerateAntoraPlaybook.java | 2 +- .../springframework/boot/build/antora/expected-playbook.yml | 2 +- .../src/docs/antora/antora.yml | 2 +- .../spring-boot-docs/src/docs/antora/antora.yml | 2 +- .../spring-boot-gradle-plugin/src/docs/antora/antora.yml | 2 +- .../spring-boot-maven-plugin/src/docs/antora/antora.yml | 2 +- 7 files changed, 8 insertions(+), 9 deletions(-) diff --git a/buildSrc/src/main/java/org/springframework/boot/build/AntoraConventions.java b/buildSrc/src/main/java/org/springframework/boot/build/AntoraConventions.java index 6bb73305f6d..6a6af3de9bf 100644 --- a/buildSrc/src/main/java/org/springframework/boot/build/AntoraConventions.java +++ b/buildSrc/src/main/java/org/springframework/boot/build/AntoraConventions.java @@ -43,8 +43,7 @@ import org.springframework.boot.build.constraints.ExtractVersionConstraints; import org.springframework.util.Assert; /** - * Conventions that are applied in the presence of the {@link AntoraPlugin} and - * {@link GenerateAntoraYmlPlugin}. + * Conventions that are applied in the presence of the {@link AntoraPlugin}. * * @author Phillip Webb */ @@ -90,7 +89,7 @@ public class AntoraConventions { ExtractVersionConstraints dependencyVersionsTask) { generateAntoraYmlTask.getOutputs().doNotCacheIf("getAsciidocAttributes() changes output", (task) -> true); generateAntoraYmlTask.dependsOn(dependencyVersionsTask); - generateAntoraYmlTask.setProperty("componentName", "spring-boot"); + generateAntoraYmlTask.setProperty("componentName", "boot"); generateAntoraYmlTask.setProperty("outputFile", new File(project.getBuildDir(), "generated/docs/antora-yml/antora.yml")); generateAntoraYmlTask.setProperty("yml", getDefaultYml(project)); diff --git a/buildSrc/src/main/java/org/springframework/boot/build/antora/GenerateAntoraPlaybook.java b/buildSrc/src/main/java/org/springframework/boot/build/antora/GenerateAntoraPlaybook.java index b8e11baa68a..7b0211e69d2 100644 --- a/buildSrc/src/main/java/org/springframework/boot/build/antora/GenerateAntoraPlaybook.java +++ b/buildSrc/src/main/java/org/springframework/boot/build/antora/GenerateAntoraPlaybook.java @@ -119,7 +119,7 @@ public abstract class GenerateAntoraPlaybook extends DefaultTask { zipContentsCollector.locations(antoraContent, antoraDepenencies); zipContentsCollector.alwaysInclude(getAlwaysInclude().getOrNull()); }); - extensions.rootComponent((rootComponent) -> rootComponent.name("spring-boot")); + extensions.rootComponent((rootComponent) -> rootComponent.name("boot")); })); Map asciidoc = (Map) data.get("asciidoc"); asciidoc.put("extensions", Extensions.asciidoc()); diff --git a/buildSrc/src/test/resources/org/springframework/boot/build/antora/expected-playbook.yml b/buildSrc/src/test/resources/org/springframework/boot/build/antora/expected-playbook.yml index a5a42c8a262..3ccbbc6e9da 100644 --- a/buildSrc/src/test/resources/org/springframework/boot/build/antora/expected-playbook.yml +++ b/buildSrc/src/test/resources/org/springframework/boot/build/antora/expected-playbook.yml @@ -15,7 +15,7 @@ antora: - project/build/generated/docs/antora-dependencies-content/test-${version}-${name}-${classifier}.zip version_file: gradle.properties - require: '@springio/antora-extensions/root-component-extension' - root_component_name: spring-boot + root_component_name: boot site: title: Spring Boot content: diff --git a/spring-boot-project/spring-boot-actuator-autoconfigure/src/docs/antora/antora.yml b/spring-boot-project/spring-boot-actuator-autoconfigure/src/docs/antora/antora.yml index c7e2e774760..48c03f5e718 100644 --- a/spring-boot-project/spring-boot-actuator-autoconfigure/src/docs/antora/antora.yml +++ b/spring-boot-project/spring-boot-actuator-autoconfigure/src/docs/antora/antora.yml @@ -1,4 +1,4 @@ -name: spring-boot +name: boot version: true ext: zip_contents_collector: diff --git a/spring-boot-project/spring-boot-docs/src/docs/antora/antora.yml b/spring-boot-project/spring-boot-docs/src/docs/antora/antora.yml index 32fee7a774a..86bca204764 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/antora/antora.yml +++ b/spring-boot-project/spring-boot-docs/src/docs/antora/antora.yml @@ -1,4 +1,4 @@ -name: spring-boot +name: boot version: true ext: zip_contents_collector: diff --git a/spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/docs/antora/antora.yml b/spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/docs/antora/antora.yml index 6ef0660b696..a0830e8b6a6 100644 --- a/spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/docs/antora/antora.yml +++ b/spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/docs/antora/antora.yml @@ -1,4 +1,4 @@ -name: spring-boot +name: boot version: true ext: zip_contents_collector: diff --git a/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/docs/antora/antora.yml b/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/docs/antora/antora.yml index 9e329fa3c80..73acc5a9d98 100644 --- a/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/docs/antora/antora.yml +++ b/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/docs/antora/antora.yml @@ -1,4 +1,4 @@ -name: spring-boot +name: boot version: true ext: zip_contents_collector: