Spring/spring-boot
Spring/spring-boot
1
0
Fork 0
mirror of https://github.com/spring-projects/spring-boot.git synced 2024-07-05 00:56:58 +08:00
Code Issues Packages Projects Releases Wiki Activity

Refine links in spring-boot-dependencies

Browse Source 
Add support for a root name and change `reference` to `docs`.

See gh-39779
This commit is contained in:
Phillip Webb 2024-03-08 17:25:47 -08:00
parent 7a417503e5
commit 8b4f411e90
4 changed files with 82 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
buildSrc/src/main/java/org/springframework/boot/build/bom/BomExtension.java
View File

@ -124,7 +124,7 @@ public class BomExtension {
: null;
addLibrary(new Library(name, libraryHandler.calendarName, libraryVersion, libraryHandler.groups,
libraryHandler.prohibitedVersions, libraryHandler.considerSnapshots, versionAlignment,
libraryHandler.links));
libraryHandler.linkRootName, libraryHandler.links));
}
public void effectiveBomArtifact() {
@ -232,6 +232,8 @@ public class BomExtension {
private AlignWithVersionHandler alignWithVersion;
private String linkRootName;
private final Map<String, Function<LibraryVersion, String>> links = new HashMap<>();
@Inject
@ -271,8 +273,13 @@ public class BomExtension {
}
public void links(Action<LinksHandler> action) {
links(null, action);
}
public void links(String linkRootName, Action<LinksHandler> action) {
LinksHandler handler = new LinksHandler();
action.execute(handler);
this.linkRootName = linkRootName;
this.links.putAll(handler.links);
}
@ -431,6 +438,14 @@ public class BomExtension {
add("github", linkFactory);
}
public void docs(String linkTemplate) {
docs(asFactory(linkTemplate));
}
public void docs(Function<LibraryVersion, String> linkFactory) {
add("docs", linkFactory);
}
public void javadoc(String linkTemplate) {
javadoc(asFactory(linkTemplate));
}
@ -439,14 +454,6 @@ public class BomExtension {
add("javadoc", linkFactory);
}
public void reference(String linkTemplate) {
reference(asFactory(linkTemplate));
}
public void reference(Function<LibraryVersion, String> linkFactory) {
add("reference", linkFactory);
}
public void releaseNotes(String linkTemplate) {
releaseNotes(asFactory(linkTemplate));
}

11
buildSrc/src/main/java/org/springframework/boot/build/bom/Library.java
View File

@ -62,6 +62,8 @@ public class Library {
private final VersionAlignment versionAlignment;
private final String linkRootName;
private final Map<String, Function<LibraryVersion, String>> links;
/**
@ -75,11 +77,13 @@ public class Library {
* @param prohibitedVersions version of the library that are prohibited
* @param considerSnapshots whether to consider snapshots
* @param versionAlignment version alignment, if any, for the library
* @param linkRootName the root name to use when generating link variable or
* {@code null} to generate one based on the library {@code name}
* @param links a list of HTTP links relevant to the library
*/
public Library(String name, String calendarName, LibraryVersion version, List<Group> groups,
List<ProhibitedVersion> prohibitedVersions, boolean considerSnapshots, VersionAlignment versionAlignment,
Map<String, Function<LibraryVersion, String>> links) {
String linkRootName, Map<String, Function<LibraryVersion, String>> links) {
this.name = name;
this.calendarName = (calendarName != null) ? calendarName : name;
this.version = version;
@ -89,6 +93,7 @@ public class Library {
this.prohibitedVersions = prohibitedVersions;
this.considerSnapshots = considerSnapshots;
this.versionAlignment = versionAlignment;
this.linkRootName = linkRootName;
this.links = Collections.unmodifiableMap(links);
}
@ -124,6 +129,10 @@ public class Library {
return this.versionAlignment;
}
public String getLinkRootName() {
return this.linkRootName;
}
public Map<String, String> getLinks() {
Map<String, String> links = new TreeMap<>();
this.links.forEach((name, linkFactory) -> links.put(name, linkFactory.apply(this.version)));

4
buildSrc/src/test/java/org/springframework/boot/build/bom/bomr/UpgradeApplicatorTests.java
View File

@ -54,7 +54,7 @@ class UpgradeApplicatorTests {
FileCopyUtils.copy(new File("src/test/resources/gradle.properties"), gradleProperties);
new UpgradeApplicator(bom.toPath(), gradleProperties.toPath())
.apply(new Upgrade(new Library("ActiveMQ", null, new LibraryVersion(DependencyVersion.parse("5.15.11")),
null, null, false, null, Collections.emptyMap()), DependencyVersion.parse("5.16")));
null, null, false, null, null, Collections.emptyMap()), DependencyVersion.parse("5.16")));
String bomContents = Files.readString(bom.toPath());
assertThat(bomContents).hasSize(originalContents.length() - 3);
}
@ -67,7 +67,7 @@ class UpgradeApplicatorTests {
FileCopyUtils.copy(new File("src/test/resources/gradle.properties"), gradleProperties);
new UpgradeApplicator(bom.toPath(), gradleProperties.toPath())
.apply(new Upgrade(new Library("Kotlin", null, new LibraryVersion(DependencyVersion.parse("1.3.70")), null,
null, false, null, Collections.emptyMap()), DependencyVersion.parse("1.4")));
null, false, null, null, Collections.emptyMap()), DependencyVersion.parse("1.4")));
Properties properties = new Properties();
try (InputStream in = new FileInputStream(gradleProperties)) {
properties.load(in);

84
spring-boot-project/spring-boot-dependencies/build.gradle
View File

@ -51,7 +51,7 @@ bom {
}
links {
site("https://activemq.apache.org")
reference("https://activemq.apache.org/components/classic/documentation")
docs("https://activemq.apache.org/components/classic/documentation")
releaseNotes { version -> "https://activemq.apache.org/components/classic/download/classic-%02d-%02d-%02d"
.formatted(version.componentInts()) }
}
@ -131,7 +131,8 @@ bom {
]
}
links {
releaseNotes { version -> "https://github.com/awaitility/awaitility/wiki/ReleaseNotes%s.%s".formatted(version.major(), version.minor()) }
releaseNotes { version -> "https://github.com/awaitility/awaitility/wiki/ReleaseNotes%s.%s"
.formatted(version.major(), version.minor()) }
}
}
library("Zipkin Reporter", "3.3.0") {
@ -176,7 +177,7 @@ bom {
}
links {
site("https://bytebuddy.net/")
reference("https://bytebuddy.net/#/tutorial")
docs("https://bytebuddy.net/#/tutorial")
releaseNotes("https://github.com/raphw/byte-buddy/releases/tag/byte-buddy-{version}")
}
}
@ -207,7 +208,7 @@ bom {
}
links {
site("https://github.com/ben-manes/caffeine")
reference("https://github.com/ben-manes/caffeine/wiki")
docs("https://github.com/ben-manes/caffeine/wiki")
releaseNotes("https://github.com/ben-manes/caffeine/releases/tag/v{version}")
}
}
@ -319,6 +320,7 @@ bom {
}
links {
site("https://github.com/spring-gradle-plugins/dependency-management-plugin")
docs("https://docs.spring.io/dependency-management-plugin/docs/{version}/reference/html/")
releaseNotes("https://github.com/spring-gradle-plugins/dependency-management-plugin/releases/tag/v{version}")
}
}
@ -402,7 +404,8 @@ bom {
}
links {
site("https://freemarker.apache.org")
releaseNotes { version -> "https://freemarker.apache.org/docs/versions_%s.html".formatted(version.toString("_")) }
releaseNotes { version -> "https://freemarker.apache.org/docs/versions_%s.html"
.formatted(version.toString("_")) }
}
}
library("Git Commit ID Maven Plugin", "6.0.0") {
@ -520,9 +523,14 @@ bom {
}
links {
site("https://hibernate.org/orm")
javadoc { version -> "https://docs.jboss.org/hibernate/orm/%s.%s/javadocs".formatted(version.major(), version.minor()) }
reference { version -> "https://hibernate.org/orm/documentation/%s.%s".formatted(version.major(), version.minor()) }
releaseNotes { version -> "https://github.com/hibernate/hibernate-orm/releases/tag/%s".formatted(version.toString().replace(".Final", "")) }
javadoc { version -> "https://docs.jboss.org/hibernate/orm/%s.%s/javadocs"
.formatted(version.major(), version.minor()) }
docs { version -> "https://hibernate.org/orm/documentation/%s.%s"
.formatted(version.major(), version.minor()) }
releaseNotes { version -> "https://github.com/hibernate/hibernate-orm/releases/tag/%s"
.formatted(version.toString().replace(".Final", "")) }
add("userguide") { version -> "https://docs.jboss.org/hibernate/orm/%s.%s/userguide/html_single/Hibernate_User_Guide.html"
.formatted(version.major(), version.minor()) }
}
}
library("Hibernate Validator", "8.0.1.Final") {
@ -876,6 +884,7 @@ bom {
}
links {
site("https://www.jooq.org")
docs("https://www.jooq.org/doc/{jooq-version}/manual-single-page")
releaseNotes("https://github.com/jOOQ/jOOQ/releases/tag/version-{version}")
}
}
@ -936,7 +945,7 @@ bom {
links {
site("https://junit.org/junit5")
javadoc("https://junit.org/junit5/docs/{version}/api")
reference("https://junit.org/junit5/docs/{version}/user-guide")
docs("https://junit.org/junit5/docs/{version}/user-guide")
releaseNotes("https://junit.org/junit5/docs/{version}/release-notes")
}
}
@ -999,6 +1008,7 @@ bom {
}
links {
site("https://kotlinlang.org/")
docs("https://kotlinlang.org/docs/reference")
releaseNotes("https://github.com/JetBrains/kotlin/releases/tag/v{version}")
}
}
@ -1032,6 +1042,7 @@ bom {
}
links {
site("https://github.com/lettuce-io/lettuce-core")
docs("https://lettuce.io/core/{version}/reference/index.html")
releaseNotes("https://github.com/lettuce-io/lettuce-core/releases/tag/{version}")
}
}
@ -1091,7 +1102,8 @@ bom {
}
links {
site("https://mariadb.com/kb/en/mariadb-connector-j/")
releaseNotes { version -> "https://mariadb.com/kb/en/mariadb-connector-j-%s-release-notes/".formatted(version.toString("-")) }
releaseNotes { version -> "https://mariadb.com/kb/en/mariadb-connector-j-%s-release-notes/"
.formatted(version.toString("-")) }
}
}
library("Maven AntRun Plugin", "3.1.0") {
@ -1234,7 +1246,8 @@ bom {
}
links {
site("https://micrometer.io")
reference { version -> "https://docs.micrometer.io/micrometer/reference/%s.%s".formatted(version.major(), version.minor()) }
docs { version -> "https://docs.micrometer.io/micrometer/reference/%s.%s"
.formatted(version.major(), version.minor()) }
releaseNotes("https://github.com/micrometer-metrics/micrometer/releases/tag/v{version}")
}
}
@ -1248,7 +1261,8 @@ bom {
}
links {
site("https://micrometer.io")
reference { version -> "https://docs.micrometer.io/tracing/reference/%s.%s".formatted(version.major(), version.minor()) }
docs { version -> "https://docs.micrometer.io/tracing/reference/%s.%s"
.formatted(version.major(), version.minor()) }
releaseNotes("https://github.com/micrometer-metrics/tracing/releases/tag/v{version}")
}
}
@ -1416,7 +1430,8 @@ bom {
}
links {
site("https://pulsar.apache.org")
reference { version -> "https://pulsar.apache.org/docs/%s.%s.x".formatted(version.major(), version.minor()) }
docs { version -> "https://pulsar.apache.org/docs/%s.%s.x"
.formatted(version.major(), version.minor()) }
releaseNotes("https://pulsar.apache.org/release-notes/versioned/pulsar-{version}")
}
}
@ -1457,7 +1472,8 @@ bom {
}
links {
site("https://github.com/querydsl/querydsl")
releaseNotes { version -> "https://github.com/querydsl/querydsl/releases/tag/QUERYDSL_%s".formatted(version.toString("_")) }
releaseNotes { version -> "https://github.com/querydsl/querydsl/releases/tag/QUERYDSL_%s"
.formatted(version.toString("_")) }
}
}
library("R2DBC H2", "1.0.0.RELEASE") {
@ -1681,8 +1697,10 @@ bom {
site("https://spring.io/projects/spring-boot")
github("https://github.com/spring-projects/spring-boot")
javadoc("https://docs.spring.io/spring-boot/docs/{version}/api")
reference("https://docs.spring.io/spring-boot/docs/{version}/reference/htmlsingle")
docs("https://docs.spring.io/spring-boot/docs/{version}/reference/htmlsingle")
releaseNotes("https://github.com/spring-projects/spring-boot/releases/tag/v{version}")
add("layers-xsd") { version -> "layers-xsd: https://www.springframework.org/schema/boot/layers/layers-%s.%s.xsd"
.formatted(version.major(), version.minor()) }
}
}
library("SAAJ Impl", "3.0.3") {
@ -1760,7 +1778,7 @@ bom {
site("https://spring.io/projects/spring-amqp")
github("https://github.com/spring-projects/spring-amqp")
javadoc("https://docs.spring.io/spring-amqp/docs/{version}/api")
reference("https://docs.spring.io/spring-amqp/reference/{version}")
docs("https://docs.spring.io/spring-amqp/reference/{version}")
releaseNotes("https://github.com/spring-projects/spring-amqp/releases/tag/v{version}")
}
}
@ -1775,7 +1793,7 @@ bom {
site("https://spring.io/projects/spring-authorization-server")
github("https://github.com/spring-projects/spring-authorization-server")
javadoc("https://docs.spring.io/spring-authorization-server/docs/{version}/api")
reference { version -> "https://docs.spring.io/spring-authorization-server/reference/%s"
docs { version -> "https://docs.spring.io/spring-authorization-server/reference/%s"
.formatted(version.forAntora()) }
releaseNotes("https://github.com/spring-projects/spring-authorization-server/releases/tag/{version}")
}
@ -1791,7 +1809,8 @@ bom {
site("https://spring.io/projects/spring-batch")
github("https://github.com/spring-projects/spring-batch")
javadoc("https://docs.spring.io/spring-batch/docs/{version}/api")
reference { version -> "https://docs.spring.io/spring-batch/reference/%s".formatted(version.forAntora()) }
docs { version -> "https://docs.spring.io/spring-batch/reference/%s"
.formatted(version.forAntora()) }
releaseNotes("https://github.com/spring-projects/spring-batch/releases/tag/v{version}")
}
}
@ -1803,7 +1822,7 @@ bom {
"spring-data-bom"
]
}
links {
links("spring-data") {
site("https://spring.io/projects/spring-data")
github("https://github.com/spring-projects/spring-data-bom")
releaseNotes("https://github.com/spring-projects/spring-data-bom/releases/tag/{version}")
@ -1820,7 +1839,7 @@ bom {
site("https://spring.io/projects/spring-framework")
github("https://github.com/spring-projects/spring-framework")
javadoc("https://docs.spring.io/spring-framework/docs/{version}/javadoc-api")
reference("https://docs.spring.io/spring-framework/reference/{version}")
docs("https://docs.spring.io/spring-framework/reference/{version}")
releaseNotes("https://github.com/spring-projects/spring-framework/releases/tag/v{version}")
}
}
@ -1836,7 +1855,8 @@ bom {
site("https://spring.io/projects/spring-graphql")
github("https://github.com/spring-projects/spring-graphql")
javadoc("https://docs.spring.io/spring-graphql/docs/{version}/api")
reference { version -> "https://docs.spring.io/spring-graphql/reference/%s".formatted(version.forAntora()) }
docs { version -> "https://docs.spring.io/spring-graphql/reference/%s"
.formatted(version.forAntora()) }
releaseNotes("https://github.com/spring-projects/spring-graphql/releases/tag/v{version}")
}
}
@ -1851,7 +1871,7 @@ bom {
site("https://spring.io/projects/spring-hateoas")
github("https://github.com/spring-projects/spring-hateoas")
javadoc("https://docs.spring.io/spring-hateoas/docs/{version}/api")
reference("https://docs.spring.io/spring-hateoas/docs/{version}/reference/html")
docs("https://docs.spring.io/spring-hateoas/docs/{version}/reference/html")
releaseNotes("https://github.com/spring-projects/spring-hateoas/releases/tag/{version}")
}
}
@ -1866,7 +1886,8 @@ bom {
site("https://spring.io/projects/spring-integration")
github("https://github.com/spring-projects/spring-integration")
javadoc("https://docs.spring.io/spring-integration/docs/{version}/api")
reference { version -> "https://docs.spring.io/spring-integration/reference/%s".formatted(version.forAntora()) }
docs { version -> "https://docs.spring.io/spring-integration/reference/%s"
.formatted(version.forAntora()) }
releaseNotes("https://github.com/spring-projects/spring-integration/releases/tag/v{version}")
}
}
@ -1882,7 +1903,8 @@ bom {
site("https://spring.io/projects/spring-kafka")
github("https://github.com/spring-projects/spring-kafka")
javadoc("https://docs.spring.io/spring-kafka/docs/{version}/api")
reference { version -> "https://docs.spring.io/spring-kafka/reference/%s".formatted(version.forAntora()) }
docs { version -> "https://docs.spring.io/spring-kafka/reference/%s"
.formatted(version.forAntora()) }
releaseNotes("https://github.com/spring-projects/spring-kafka/releases/tag/v{version}")
}
}
@ -1900,7 +1922,7 @@ bom {
site("https://spring.io/projects/spring-ldap")
github("https://github.com/spring-projects/spring-ldap")
javadoc("https://docs.spring.io/spring-ldap/docs/{version}/api")
reference("https://docs.spring.io/spring-ldap/reference/{version}")
docs("https://docs.spring.io/spring-ldap/reference/{version}")
releaseNotes("https://github.com/spring-projects/spring-ldap/releases/tag/{version}")
}
}
@ -1915,7 +1937,7 @@ bom {
site("https://spring.io/projects/spring-pulsar")
github("https://github.com/spring-projects/spring-pulsar")
javadoc("https://docs.spring.io/spring-pulsar/docs/{version}/api/")
reference("https://docs.spring.io/spring-pulsar/docs/{version}/reference")
docs("https://docs.spring.io/spring-pulsar/docs/{version}/reference")
releaseNotes("https://github.com/spring-projects/spring-pulsar/releases/tag/v{version}")
}
}
@ -1930,7 +1952,7 @@ bom {
site("https://spring.io/projects/spring-restdocs")
github("https://github.com/spring-projects/spring-restdocs")
javadoc("https://docs.spring.io/spring-restdocs/docs/{version}/api/")
reference("https://docs.spring.io/spring-restdocs/docs/{version}/reference/htmlsingle/")
docs("https://docs.spring.io/spring-restdocs/docs/{version}/reference/htmlsingle/")
releaseNotes("https://github.com/spring-projects/spring-restdocs/releases/tag/v{version}")
}
}
@ -1957,7 +1979,8 @@ bom {
site("https://spring.io/projects/spring-security")
github("https://github.com/spring-projects/spring-security")
javadoc("https://docs.spring.io/spring-security/site/docs/{version}/api")
reference { version -> "https://docs.spring.io/spring-security/reference/%s".formatted(version.forAntora()) }
docs { version -> "https://docs.spring.io/spring-security/reference/%s"
.formatted(version.forAntora()) }
releaseNotes("https://github.com/spring-projects/spring-security/releases/tag/{version}")
}
}
@ -1976,7 +1999,8 @@ bom {
site("https://spring.io/projects/spring-session")
github("https://github.com/spring-projects/spring-session")
javadoc("https://docs.spring.io/spring-session/docs/{version}/api")
reference { version -> "https://docs.spring.io/spring-session/reference/%s".formatted(version.forAntora()) }
docs { version -> "https://docs.spring.io/spring-session/reference/%s"
.formatted(version.forAntora()) }
releaseNotes("https://github.com/spring-projects/spring-session/releases/tag/{version}")
}
}
@ -1991,7 +2015,7 @@ bom {
site("https://spring.io/projects/spring-ws")
github("https://github.com/spring-projects/spring-ws")
javadoc("https://docs.spring.io/spring-ws/docs/{version}/api")
reference("https://docs.spring.io/spring-ws/docs/{version}/reference/html")
docs("https://docs.spring.io/spring-ws/docs/{version}/reference/html")
releaseNotes("https://github.com/spring-projects/spring-ws/releases/tag/v{version}")
}
}