Browse Source

Rename Antora component from spring-boot to boot

Closes gh-40131
pull/40135/head
Phillip Webb 2 years ago
parent
commit
10260c084b
  1. 5
      buildSrc/src/main/java/org/springframework/boot/build/AntoraConventions.java
  2. 2
      buildSrc/src/main/java/org/springframework/boot/build/antora/GenerateAntoraPlaybook.java
  3. 2
      buildSrc/src/test/resources/org/springframework/boot/build/antora/expected-playbook.yml
  4. 2
      spring-boot-project/spring-boot-actuator-autoconfigure/src/docs/antora/antora.yml
  5. 2
      spring-boot-project/spring-boot-docs/src/docs/antora/antora.yml
  6. 2
      spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/docs/antora/antora.yml
  7. 2
      spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/docs/antora/antora.yml

5
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; import org.springframework.util.Assert;
/** /**
* Conventions that are applied in the presence of the {@link AntoraPlugin} and * Conventions that are applied in the presence of the {@link AntoraPlugin}.
* {@link GenerateAntoraYmlPlugin}.
* *
* @author Phillip Webb * @author Phillip Webb
*/ */
@ -90,7 +89,7 @@ public class AntoraConventions {
ExtractVersionConstraints dependencyVersionsTask) { ExtractVersionConstraints dependencyVersionsTask) {
generateAntoraYmlTask.getOutputs().doNotCacheIf("getAsciidocAttributes() changes output", (task) -> true); generateAntoraYmlTask.getOutputs().doNotCacheIf("getAsciidocAttributes() changes output", (task) -> true);
generateAntoraYmlTask.dependsOn(dependencyVersionsTask); generateAntoraYmlTask.dependsOn(dependencyVersionsTask);
generateAntoraYmlTask.setProperty("componentName", "spring-boot"); generateAntoraYmlTask.setProperty("componentName", "boot");
generateAntoraYmlTask.setProperty("outputFile", generateAntoraYmlTask.setProperty("outputFile",
new File(project.getBuildDir(), "generated/docs/antora-yml/antora.yml")); new File(project.getBuildDir(), "generated/docs/antora-yml/antora.yml"));
generateAntoraYmlTask.setProperty("yml", getDefaultYml(project)); generateAntoraYmlTask.setProperty("yml", getDefaultYml(project));

2
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.locations(antoraContent, antoraDepenencies);
zipContentsCollector.alwaysInclude(getAlwaysInclude().getOrNull()); zipContentsCollector.alwaysInclude(getAlwaysInclude().getOrNull());
}); });
extensions.rootComponent((rootComponent) -> rootComponent.name("spring-boot")); extensions.rootComponent((rootComponent) -> rootComponent.name("boot"));
})); }));
Map<String, Object> asciidoc = (Map<String, Object>) data.get("asciidoc"); Map<String, Object> asciidoc = (Map<String, Object>) data.get("asciidoc");
asciidoc.put("extensions", Extensions.asciidoc()); asciidoc.put("extensions", Extensions.asciidoc());

2
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 - project/build/generated/docs/antora-dependencies-content/test-${version}-${name}-${classifier}.zip
version_file: gradle.properties version_file: gradle.properties
- require: '@springio/antora-extensions/root-component-extension' - require: '@springio/antora-extensions/root-component-extension'
root_component_name: spring-boot root_component_name: boot
site: site:
title: Spring Boot title: Spring Boot
content: content:

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

@ -1,4 +1,4 @@
name: spring-boot name: boot
version: true version: true
ext: ext:
zip_contents_collector: zip_contents_collector:

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

@ -1,4 +1,4 @@
name: spring-boot name: boot
version: true version: true
ext: ext:
zip_contents_collector: zip_contents_collector:

2
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 version: true
ext: ext:
zip_contents_collector: zip_contents_collector:

2
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 version: true
ext: ext:
zip_contents_collector: zip_contents_collector:

Loading…
Cancel
Save