Skip to content

Commit de54d4d

Browse files
wilkinsonawilkinsona
committed
Improve linking to Testcontainers' javadoc
Closes gh-45802
1 parent cc4bb1e commit de54d4d

File tree

4 files changed

+25
-47
lines changed

4 files changed

+25
-47
lines changed

‎buildSrc/src/main/java/org/springframework/boot/build/antora/AntoraAsciidocAttributes.java

Lines changed: 0 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -178,24 +178,6 @@ private void addVersionAttributes(Map<String, String> attributes, Map<String, St
178178
addSpringDataDependencyVersion(attributes, internal, "spring-data-redis");
179179
addSpringDataDependencyVersion(attributes, internal, "spring-data-rest", "spring-data-rest-core");
180180
addSpringDataDependencyVersion(attributes, internal, "spring-data-ldap");
181-
addTestcontainersDependencyVersion(attributes, internal, "activemq");
182-
addTestcontainersDependencyVersion(attributes, internal, "cassandra");
183-
addTestcontainersDependencyVersion(attributes, internal, "couchbase");
184-
addTestcontainersDependencyVersion(attributes, internal, "elasticsearch");
185-
addTestcontainersDependencyVersion(attributes, internal, "jdbc");
186-
addTestcontainersDependencyVersion(attributes, internal, "kafka");
187-
addTestcontainersDependencyVersion(attributes, internal, "mariadb");
188-
addTestcontainersDependencyVersion(attributes, internal, "mongodb");
189-
addTestcontainersDependencyVersion(attributes, internal, "mssqlserver");
190-
addTestcontainersDependencyVersion(attributes, internal, "mysql");
191-
addTestcontainersDependencyVersion(attributes, internal, "neo4j");
192-
addTestcontainersDependencyVersion(attributes, internal, "oracle-xe");
193-
addTestcontainersDependencyVersion(attributes, internal, "oracle-free");
194-
addTestcontainersDependencyVersion(attributes, internal, "postgresql");
195-
addTestcontainersDependencyVersion(attributes, internal, "pulsar");
196-
addTestcontainersDependencyVersion(attributes, internal, "rabbitmq");
197-
addTestcontainersDependencyVersion(attributes, internal, "redpanda");
198-
addTestcontainersDependencyVersion(attributes, internal, "r2dbc");
199181
addDependencyVersion(attributes, "pulsar-client-reactive-api", "org.apache.pulsar:pulsar-client-reactive-api");
200182
addDependencyVersion(attributes, "pulsar-client-api", "org.apache.pulsar:pulsar-client-api");
201183
}
@@ -216,11 +198,6 @@ private void addSpringDataDependencyVersion(Map<String, String> attributes, Map<
216198
internal.put("dotxversion-" + name, majorMinor + ".x");
217199
}
218200

219-
private void addTestcontainersDependencyVersion(Map<String, String> attributes, Map<String, String> internal,
220-
String artifactId) {
221-
addDependencyVersion(attributes, "testcontainers-" + artifactId, "org.testcontainers:" + artifactId);
222-
}
223-
224201
private void addDependencyVersion(Map<String, String> attributes, String name, String groupAndArtifactId) {
225202
attributes.put("version-" + name, getVersion(groupAndArtifactId));
226203
}

‎buildSrc/src/main/resources/org/springframework/boot/build/antora/antora-asciidoc-attributes.properties

Lines changed: 0 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -76,25 +76,6 @@ url-spring-data-rest-docs=https://docs.spring.io/spring-data/rest/reference/{ant
7676
url-spring-data-rest-site=https://spring.io/projects/spring-data-rest
7777
url-spring-data-rest-javadoc=https://docs.spring.io/spring-data/rest/docs/{dotxversion-spring-data-rest}/api
7878
url-spring-data-site=https://spring.io/projects/spring-data
79-
url-testcontainers-docs=https://java.testcontainers.org
80-
url-testcontainers-activemq-javadoc=https://javadoc.io/doc/org.testcontainers/activemq/{version-testcontainers-activemq}
81-
url-testcontainers-cassandra-javadoc=https://javadoc.io/doc/org.testcontainers/cassandra/{version-testcontainers-cassandra}
82-
url-testcontainers-couchbase-javadoc=https://javadoc.io/doc/org.testcontainers/couchbase/{version-testcontainers-couchbase}
83-
url-testcontainers-elasticsearch-javadoc=https://javadoc.io/doc/org.testcontainers/elasticsearch/{version-testcontainers-elasticsearch}
84-
url-testcontainers-jdbc-javadoc=https://javadoc.io/doc/org.testcontainers/jdbc/{version-testcontainers-jdbc}
85-
url-testcontainers-kafka-javadoc=https://javadoc.io/doc/org.testcontainers/kafka/{version-testcontainers-kafka}
86-
url-testcontainers-mariadb-javadoc=https://javadoc.io/doc/org.testcontainers/mariadb/{version-testcontainers-mariadb}
87-
url-testcontainers-mongodb-javadoc=https://javadoc.io/doc/org.testcontainers/mongodb/{version-testcontainers-mongodb}
88-
url-testcontainers-mssqlserver-javadoc=https://javadoc.io/doc/org.testcontainers/mssqlserver/{version-testcontainers-mssqlserver}
89-
url-testcontainers-mysql-javadoc=https://javadoc.io/doc/org.testcontainers/mysql/{version-testcontainers-mysql}
90-
url-testcontainers-neo4j-javadoc=https://javadoc.io/doc/org.testcontainers/neo4j/{version-testcontainers-neo4j}
91-
url-testcontainers-oracle-xe-javadoc=https://javadoc.io/doc/org.testcontainers/oracle-xe/{version-testcontainers-oracle-xe}
92-
url-testcontainers-oracle-free-javadoc=https://javadoc.io/doc/org.testcontainers/oracle-free/{version-testcontainers-oracle-free}
93-
url-testcontainers-postgresql-javadoc=https://javadoc.io/doc/org.testcontainers/postgresql/{version-testcontainers-postgresql}
94-
url-testcontainers-pulsar-javadoc=https://javadoc.io/doc/org.testcontainers/pulsar/{version-testcontainers-pulsar}
95-
url-testcontainers-rabbitmq-javadoc=https://javadoc.io/doc/org.testcontainers/rabbitmq/{version-testcontainers-rabbitmq}
96-
url-testcontainers-redpanda-javadoc=https://javadoc.io/doc/org.testcontainers/redpanda/{version-testcontainers-redpanda}
97-
url-testcontainers-r2dbc-javadoc=https://javadoc.io/doc/org.testcontainers/r2dbc/{version-testcontainers-r2dbc}
9879
url-jackson-annotations-javadoc=https://javadoc.io/doc/com.fasterxml.jackson.core/jackson-annotations/{version-jackson-annotations}
9980
url-jackson-core-javadoc=https://javadoc.io/doc/com.fasterxml.jackson.core/jackson-core/{version-jackson-core}
10081
url-jackson-databind-javadoc=https://javadoc.io/doc/com.fasterxml.jackson.core/jackson-databind/{version-jackson-databind}

‎spring-boot-project/spring-boot-dependencies/build.gradle

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2355,9 +2355,29 @@ bom {
23552355
bom("testcontainers-bom")
23562356
}
23572357
links {
2358-
site("https://java.testcontainers.org")
2359-
javadoc("https://javadoc.io/doc/org.testcontainers/testcontainers/{version}", "org.testcontainers")
2358+
docs("https://java.testcontainers.org")
2359+
javadoc("testcontainers", version -> "https://javadoc.io/doc/org.testcontainers/testcontainers/%s".formatted(version), "org.testcontainers")
2360+
javadoc("testcontainers-activemq", version -> "https://javadoc.io/doc/org.testcontainers/activemq/%s".formatted(version), "org.testcontainers.activemq")
2361+
javadoc("testcontainers-cassandra", version -> "https://javadoc.io/doc/org.testcontainers/cassandra/%s".formatted(version))
2362+
javadoc("testcontainers-couchbase", version -> "https://javadoc.io/doc/org.testcontainers/couchbase/%s".formatted(version), "org.testcontainers.couchbase")
2363+
javadoc("testcontainers-elasticsearch", version -> "https://javadoc.io/doc/org.testcontainers/elasticsearch/%s".formatted(version), "org.testcontainers.elasticsearch")
2364+
javadoc("testcontainers-jdbc", version -> "https://javadoc.io/doc/org.testcontainers/jdbc/%s".formatted(version))
2365+
javadoc("testcontainers-junit-jupiter", version -> "https://javadoc.io/doc/org.testcontainers/junit-jupiter/%s".formatted(version), "org.testcontainers.junit.jupiter")
2366+
javadoc("testcontainers-kafka", version -> "https://javadoc.io/doc/org.testcontainers/kafka/%s".formatted(version), "org.testcontainers.kafka")
2367+
javadoc("testcontainers-mariadb", version -> "https://javadoc.io/doc/org.testcontainers/mariadb/%s".formatted(version))
2368+
javadoc("testcontainers-mongodb", version -> "https://javadoc.io/doc/org.testcontainers/mongodb/%s".formatted(version))
2369+
javadoc("testcontainers-mssqlserver", version -> "https://javadoc.io/doc/org.testcontainers/mssqlserver/%s".formatted(version))
2370+
javadoc("testcontainers-mysql", version -> "https://javadoc.io/doc/org.testcontainers/mysql/%s".formatted(version))
2371+
javadoc("testcontainers-neo4j", version -> "https://javadoc.io/doc/org.testcontainers/neo4j/%s".formatted(version))
2372+
javadoc("testcontainers-oracle-xe", version -> "https://javadoc.io/doc/org.testcontainers/oracle-xe/%s".formatted(version))
2373+
javadoc("testcontainers-oracle-free", version -> "https://javadoc.io/doc/org.testcontainers/oracle-free/%s".formatted(version), "org.testcontainers.oracle")
2374+
javadoc("testcontainers-postgresql", version -> "https://javadoc.io/doc/org.testcontainers/postgresql/%s".formatted(version))
2375+
javadoc("testcontainers-pulsar", version -> "https://javadoc.io/doc/org.testcontainers/pulsar/%s".formatted(version))
2376+
javadoc("testcontainers-rabbitmq", version -> "https://javadoc.io/doc/org.testcontainers/rabbitmq/%s".formatted(version))
2377+
javadoc("testcontainers-redpanda", version -> "https://javadoc.io/doc/org.testcontainers/redpanda/%s".formatted(version), "org.testcontainers.redpanda")
2378+
javadoc("testcontainers-r2dbc", version -> "https://javadoc.io/doc/org.testcontainers/r2dbc/%s".formatted(version), "org.testcontainers.r2dbc")
23602379
releaseNotes("https://github.com/testcontainers/testcontainers-java/releases/tag/{version}")
2380+
site("https://java.testcontainers.org")
23612381
}
23622382
}
23632383
library("Thymeleaf", "3.1.3.RELEASE") {

‎spring-boot-project/spring-boot-docs/src/docs/antora/modules/reference/pages/testing/testcontainers.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ NOTE: In most cases, you will additionally need to configure the application to
4949

5050
A common pattern with Testcontainers is to declare the container instances as static fields in an interface.
5151

52-
For example, the following interface declares two containers, one named `mongo` of type javadoc:org.testcontainers.containers.MongoDBContainer[] and another named `neo4j` of type javadoc:org.testcontainers.containers.Neo4jContainer.Neo4jContainer[]:
52+
For example, the following interface declares two containers, one named `mongo` of type javadoc:{url-testcontainers-mongodb-javadoc}/org.testcontainers.containers.MongoDBContainer[] and another named `neo4j` of type javadoc:{url-testcontainers-neo4j-javadoc}/org.testcontainers.containers.Neo4jContainer[]:
5353

5454
include-code::MyContainers[]
5555

@@ -141,7 +141,7 @@ The following service connection factories are provided in the `spring-boot-test
141141
| Containers of type javadoc:{url-testcontainers-jdbc-javadoc}/org.testcontainers.containers.JdbcDatabaseContainer[]
142142

143143
| javadoc:org.springframework.boot.autoconfigure.kafka.KafkaConnectionDetails[]
144-
| Containers of type javadoc:{url-testcontainers-kafka-javadoc}/org.testcontainers.containers.KafkaContainer[] or javadoc:org.testcontainers.redpanda.RedpandaContainer[]
144+
| Containers of type javadoc:org.testcontainers.kafka.KafkaContainer[] or javadoc:org.testcontainers.redpanda.RedpandaContainer[]
145145

146146
| javadoc:org.springframework.boot.autoconfigure.liquibase.LiquibaseConnectionDetails[]
147147
| Containers of type javadoc:{url-testcontainers-jdbc-javadoc}/org.testcontainers.containers.JdbcDatabaseContainer[]
@@ -162,7 +162,7 @@ The following service connection factories are provided in the `spring-boot-test
162162
| Containers of type javadoc:{url-testcontainers-pulsar-javadoc}/org.testcontainers.containers.PulsarContainer[]
163163

164164
| javadoc:org.springframework.boot.autoconfigure.r2dbc.R2dbcConnectionDetails[]
165-
| Containers of type javadoc:{url-testcontainers-mariadb-javadoc}/org.testcontainers.containers.MariaDBContainer[], javadoc:{url-testcontainers-mssqlserver-javadoc}/org.testcontainers.containers.MSSQLServerContainer[], javadoc:{url-testcontainers-mysql-javadoc}/org.testcontainers.containers.MySQLContainer[], javadoc:{url-testcontainers-oracle-free-javadoc}/org.testcontainers.OracleContainer[OracleContainer (free)], javadoc:{url-testcontainers-oracle-xe-javadoc}/org.testcontainers.oracle.OracleContainer[OracleContainer (XE)] or javadoc:{url-testcontainers-postgresql-javadoc}/org.testcontainers.containers.PostgreSQLContainer[]
165+
| Containers of type javadoc:{url-testcontainers-mariadb-javadoc}/org.testcontainers.containers.MariaDBContainer[], javadoc:{url-testcontainers-mssqlserver-javadoc}/org.testcontainers.containers.MSSQLServerContainer[], javadoc:{url-testcontainers-mysql-javadoc}/org.testcontainers.containers.MySQLContainer[], javadoc:org.testcontainers.oracle.OracleContainer[OracleContainer (free)], javadoc:{url-testcontainers-oracle-xe-javadoc}/org.testcontainers.containers.OracleContainer[OracleContainer (XE)] or javadoc:{url-testcontainers-postgresql-javadoc}/org.testcontainers.containers.PostgreSQLContainer[]
166166

167167
| javadoc:org.springframework.boot.autoconfigure.amqp.RabbitConnectionDetails[]
168168
| Containers of type javadoc:{url-testcontainers-rabbitmq-javadoc}/org.testcontainers.containers.RabbitMQContainer[]

0 commit comments

Comments
 (0)