Skip to content

Commit 0f822b9

Browse files
committed
Ensure stable ordering of Asciidoc attributes
See gh-1009
1 parent 4e9d464 commit 0f822b9

File tree

1 file changed

+12
-11
lines changed
  • gradle/plugins/antora/src/main/java/org/springframework/restdocs/build/antora

1 file changed

+12
-11
lines changed

gradle/plugins/antora/src/main/java/org/springframework/restdocs/build/antora/AntoraPlugin.java

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@
2525
import java.util.LinkedHashMap;
2626
import java.util.List;
2727
import java.util.Map;
28+
import java.util.TreeMap;
2829

2930
import com.fasterxml.jackson.databind.ObjectMapper;
3031
import com.github.gradle.node.NodeExtension;
@@ -87,7 +88,6 @@ public void apply(Project target) {
8788
target.getLayout().getBuildDirectory().file("generated/docs/antora-yml/antora.yml"));
8889
task.setProperty("yml", getDefaultYml(target));
8990
task.getAsciidocAttributes().putAll(getAsciidocAttributes(target));
90-
9191
});
9292
tasks.withType(AntoraTask.class, (antoraTask) -> {
9393
antoraTask.setGroup("Documentation");
@@ -130,16 +130,17 @@ public void apply(Project target) {
130130
private Provider<Map<String, String>> getAsciidocAttributes(Project project) {
131131
return project.provider(() -> {
132132
String version = project.getVersion().toString();
133-
return Map.of( //
134-
"branch-or-tag", version.toString().endsWith("SNAPSHOT") ? "main" : "v$%s".formatted(version), //
135-
"github", "https://github.com/spring-projects/spring-restdocs", //
136-
"include-java", "ROOT:example$java/org/springframework/restdocs/docs", //
137-
"project-version", version.toString(), //
138-
"samples", "https://github.com/spring-projects/spring-restdocs-samples/tree/main", //
139-
"source", "https://github.com/spring-projects/spring-restdocs/tree/{branch-or-tag}", //
140-
"spring-boot-docs", "https://docs.spring.io/spring-boot/reference", //
141-
"spring-framework-api", "https://docs.spring.io/spring-framework/docs/7.0.0/javadoc-api", //
142-
"spring-framework-docs", "https://docs.spring.io/spring-framework/reference");
133+
Map<String, String> attributes = new LinkedHashMap<>();
134+
attributes.put("branch-or-tag", version.toString().endsWith("SNAPSHOT") ? "main" : "v$%s".formatted(version));
135+
attributes.put("github", "https://github.com/spring-projects/spring-restdocs");
136+
attributes.put("include-java", "ROOT:example$java/org/springframework/restdocs/docs");
137+
attributes.put("project-version", version.toString());
138+
attributes.put("samples", "https://github.com/spring-projects/spring-restdocs-samples/tree/main");
139+
attributes.put("source", "https://github.com/spring-projects/spring-restdocs/tree/{branch-or-tag}");
140+
attributes.put("spring-boot-docs", "https://docs.spring.io/spring-boot/reference");
141+
attributes.put("spring-framework-api", "https://docs.spring.io/spring-framework/docs/7.0.0/javadoc-api");
142+
attributes.put("spring-framework-docs", "https://docs.spring.io/spring-framework/reference");
143+
return attributes;
143144
});
144145
}
145146

0 commit comments

Comments
 (0)