Skip to content

Commit 10260c0

Browse files
committed
Rename Antora component from spring-boot to boot
Closes gh-40131
1 parent ad79c37 commit 10260c0

File tree

7 files changed

+8
-9
lines changed

7 files changed

+8
-9
lines changed

buildSrc/src/main/java/org/springframework/boot/build/AntoraConventions.java

+2-3
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,7 @@
4343
import org.springframework.util.Assert;
4444

4545
/**
46-
* Conventions that are applied in the presence of the {@link AntoraPlugin} and
47-
* {@link GenerateAntoraYmlPlugin}.
46+
* Conventions that are applied in the presence of the {@link AntoraPlugin}.
4847
*
4948
* @author Phillip Webb
5049
*/
@@ -90,7 +89,7 @@ private void configureGenerateAntoraYmlTask(Project project, GenerateAntoraYmlTa
9089
ExtractVersionConstraints dependencyVersionsTask) {
9190
generateAntoraYmlTask.getOutputs().doNotCacheIf("getAsciidocAttributes() changes output", (task) -> true);
9291
generateAntoraYmlTask.dependsOn(dependencyVersionsTask);
93-
generateAntoraYmlTask.setProperty("componentName", "spring-boot");
92+
generateAntoraYmlTask.setProperty("componentName", "boot");
9493
generateAntoraYmlTask.setProperty("outputFile",
9594
new File(project.getBuildDir(), "generated/docs/antora-yml/antora.yml"));
9695
generateAntoraYmlTask.setProperty("yml", getDefaultYml(project));

buildSrc/src/main/java/org/springframework/boot/build/antora/GenerateAntoraPlaybook.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ private void addExtensions(Map<String, Object> data) {
119119
zipContentsCollector.locations(antoraContent, antoraDepenencies);
120120
zipContentsCollector.alwaysInclude(getAlwaysInclude().getOrNull());
121121
});
122-
extensions.rootComponent((rootComponent) -> rootComponent.name("spring-boot"));
122+
extensions.rootComponent((rootComponent) -> rootComponent.name("boot"));
123123
}));
124124
Map<String, Object> asciidoc = (Map<String, Object>) data.get("asciidoc");
125125
asciidoc.put("extensions", Extensions.asciidoc());

buildSrc/src/test/resources/org/springframework/boot/build/antora/expected-playbook.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ antora:
1515
- project/build/generated/docs/antora-dependencies-content/test-${version}-${name}-${classifier}.zip
1616
version_file: gradle.properties
1717
- require: '@springio/antora-extensions/root-component-extension'
18-
root_component_name: spring-boot
18+
root_component_name: boot
1919
site:
2020
title: Spring Boot
2121
content:

spring-boot-project/spring-boot-actuator-autoconfigure/src/docs/antora/antora.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: spring-boot
1+
name: boot
22
version: true
33
ext:
44
zip_contents_collector:

spring-boot-project/spring-boot-docs/src/docs/antora/antora.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: spring-boot
1+
name: boot
22
version: true
33
ext:
44
zip_contents_collector:

spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/docs/antora/antora.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: spring-boot
1+
name: boot
22
version: true
33
ext:
44
zip_contents_collector:

spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/docs/antora/antora.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: spring-boot
1+
name: boot
22
version: true
33
ext:
44
zip_contents_collector:

0 commit comments

Comments
 (0)