392 lines
17 KiB
Groovy
392 lines
17 KiB
Groovy
import org.springframework.boot.build.docs.ConfigureJavadocLinks
|
|
|
|
plugins {
|
|
id "dev.adamko.dokkatoo-html"
|
|
id "java"
|
|
id "org.antora"
|
|
id "org.springframework.boot.antora-contributor"
|
|
id "org.springframework.boot.antora-dependencies"
|
|
id "org.springframework.boot.deployed"
|
|
id 'org.jetbrains.kotlin.jvm'
|
|
}
|
|
|
|
description = "Spring Boot Docs"
|
|
|
|
configurations {
|
|
autoConfiguration
|
|
configurationProperties
|
|
remoteSpringApplicationExample
|
|
resolvedBom
|
|
springApplicationExample
|
|
testSlices
|
|
all {
|
|
resolutionStrategy.eachDependency { DependencyResolveDetails details ->
|
|
if (details.requested.module.group == "org.apache.kafka" && details.requested.module.name == "kafka-server-common") {
|
|
details.artifactSelection {
|
|
selectArtifact(DependencyArtifact.DEFAULT_TYPE, null, null)
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
jar {
|
|
enabled = false
|
|
}
|
|
|
|
javadoc {
|
|
enabled = false
|
|
}
|
|
|
|
javadocJar {
|
|
enabled = false
|
|
}
|
|
|
|
sourcesJar {
|
|
enabled = false
|
|
}
|
|
|
|
plugins.withType(EclipsePlugin) {
|
|
eclipse.classpath { classpath ->
|
|
classpath.plusConfigurations.add(configurations.getByName(sourceSets.main.runtimeClasspathConfigurationName))
|
|
}
|
|
}
|
|
|
|
dependencies {
|
|
autoConfiguration(project(path: ":spring-boot-project:spring-boot-actuator-autoconfigure", configuration: "autoConfigurationMetadata"))
|
|
autoConfiguration(project(path: ":spring-boot-project:spring-boot-autoconfigure", configuration: "autoConfigurationMetadata"))
|
|
autoConfiguration(project(path: ":spring-boot-project:spring-boot-devtools", configuration: "autoConfigurationMetadata"))
|
|
autoConfiguration(project(path: ":spring-boot-project:spring-boot-testcontainers", configuration: "autoConfigurationMetadata"))
|
|
|
|
configurationProperties(project(path: ":spring-boot-project:spring-boot", configuration: "configurationPropertiesMetadata"))
|
|
configurationProperties(project(path: ":spring-boot-project:spring-boot-actuator", configuration: "configurationPropertiesMetadata"))
|
|
configurationProperties(project(path: ":spring-boot-project:spring-boot-actuator-autoconfigure", configuration: "configurationPropertiesMetadata"))
|
|
configurationProperties(project(path: ":spring-boot-project:spring-boot-autoconfigure", configuration: "configurationPropertiesMetadata"))
|
|
configurationProperties(project(path: ":spring-boot-project:spring-boot-devtools", configuration: "configurationPropertiesMetadata"))
|
|
configurationProperties(project(path: ":spring-boot-project:spring-boot-docker-compose", configuration: "configurationPropertiesMetadata"))
|
|
configurationProperties(project(path: ":spring-boot-project:spring-boot-test-autoconfigure", configuration: "configurationPropertiesMetadata"))
|
|
configurationProperties(project(path: ":spring-boot-project:spring-boot-testcontainers", configuration: "configurationPropertiesMetadata"))
|
|
|
|
dokkatoo(project(path: ":spring-boot-project:spring-boot"))
|
|
dokkatoo(project(path: ":spring-boot-project:spring-boot-test"))
|
|
|
|
implementation(project(path: ":spring-boot-project:spring-boot-actuator"))
|
|
implementation(project(path: ":spring-boot-project:spring-boot-actuator-autoconfigure"))
|
|
implementation(project(path: ":spring-boot-project:spring-boot-autoconfigure"))
|
|
implementation(project(path: ":spring-boot-project:spring-boot-devtools"))
|
|
implementation(project(path: ":spring-boot-project:spring-boot-docker-compose"))
|
|
implementation(project(path: ":spring-boot-project:spring-boot-test"))
|
|
implementation(project(path: ":spring-boot-project:spring-boot-test-autoconfigure"))
|
|
implementation(project(path: ":spring-boot-project:spring-boot-testcontainers"))
|
|
implementation(project(path: ":spring-boot-project:spring-boot-tools:spring-boot-cli"))
|
|
implementation(project(path: ":spring-boot-project:spring-boot-tools:spring-boot-loader-tools"))
|
|
implementation("ch.qos.logback:logback-classic")
|
|
implementation("com.redis:testcontainers-redis")
|
|
implementation("com.zaxxer:HikariCP")
|
|
implementation("io.micrometer:micrometer-jakarta9")
|
|
implementation("io.micrometer:micrometer-tracing")
|
|
implementation("io.micrometer:micrometer-registry-graphite")
|
|
implementation("io.micrometer:micrometer-registry-jmx")
|
|
implementation("io.opentelemetry.instrumentation:opentelemetry-logback-appender-1.0")
|
|
implementation("io.projectreactor.netty:reactor-netty-http")
|
|
implementation("io.undertow:undertow-core")
|
|
implementation("jakarta.annotation:jakarta.annotation-api")
|
|
implementation("jakarta.jms:jakarta.jms-api")
|
|
implementation("jakarta.persistence:jakarta.persistence-api")
|
|
implementation("jakarta.servlet:jakarta.servlet-api")
|
|
implementation("jakarta.validation:jakarta.validation-api")
|
|
implementation("org.apache.httpcomponents.client5:httpclient5")
|
|
implementation("org.apache.commons:commons-dbcp2") {
|
|
exclude group: "commons-logging", module: "commons-logging"
|
|
}
|
|
implementation("org.apache.kafka:kafka-streams")
|
|
implementation("org.apache.logging.log4j:log4j-to-slf4j")
|
|
implementation("org.apache.tomcat.embed:tomcat-embed-core")
|
|
implementation("org.assertj:assertj-core")
|
|
implementation("org.cache2k:cache2k-spring")
|
|
implementation("org.apache.groovy:groovy")
|
|
implementation("org.glassfish.jersey.containers:jersey-container-servlet-core")
|
|
implementation("org.glassfish.jersey.core:jersey-server")
|
|
implementation("org.hibernate.orm:hibernate-jcache") {
|
|
exclude group: "javax.activation", module: "javax.activation-api"
|
|
exclude group: "javax.persistence", module: "javax.persistence-api"
|
|
exclude group: "org.jboss.spec.javax.transaction", module: "jboss-transaction-api_1.2_spec"
|
|
}
|
|
implementation("org.htmlunit:htmlunit") {
|
|
exclude group: "commons-logging", module: "commons-logging"
|
|
exclude group: "xml-apis", module: "xml-apis"
|
|
}
|
|
implementation("org.jetbrains.kotlin:kotlin-stdlib-jdk8")
|
|
implementation("org.jooq:jooq")
|
|
implementation("org.mockito:mockito-core")
|
|
implementation("org.mongodb:mongodb-driver-sync")
|
|
implementation("org.postgresql:r2dbc-postgresql")
|
|
implementation("org.quartz-scheduler:quartz")
|
|
implementation("org.slf4j:jul-to-slf4j")
|
|
implementation("org.springframework:spring-jdbc")
|
|
implementation("org.springframework:spring-jms")
|
|
implementation("org.springframework:spring-orm")
|
|
implementation("org.springframework:spring-test")
|
|
implementation("org.springframework:spring-web")
|
|
implementation("org.springframework:spring-webflux")
|
|
implementation("org.springframework:spring-webmvc")
|
|
implementation("org.springframework:spring-websocket")
|
|
implementation("org.springframework.amqp:spring-amqp")
|
|
implementation("org.springframework.amqp:spring-rabbit")
|
|
implementation("org.springframework.batch:spring-batch-core")
|
|
implementation("org.springframework.data:spring-data-cassandra")
|
|
implementation("org.springframework.data:spring-data-couchbase")
|
|
implementation("org.springframework.data:spring-data-elasticsearch") {
|
|
exclude group: "commons-logging", module: "commons-logging"
|
|
}
|
|
implementation("org.springframework.data:spring-data-envers") {
|
|
exclude group: "javax.activation", module: "javax.activation-api"
|
|
exclude group: "javax.persistence", module: "javax.persistence-api"
|
|
exclude group: "org.jboss.spec.javax.transaction", module: "jboss-transaction-api_1.2_spec"
|
|
}
|
|
implementation("org.springframework.data:spring-data-jpa")
|
|
implementation("org.springframework.data:spring-data-ldap")
|
|
implementation("org.springframework.data:spring-data-mongodb")
|
|
implementation("org.springframework.data:spring-data-neo4j")
|
|
implementation("org.springframework.data:spring-data-redis")
|
|
implementation("org.springframework.data:spring-data-r2dbc")
|
|
implementation("org.springframework.graphql:spring-graphql")
|
|
implementation("org.springframework.graphql:spring-graphql-test")
|
|
implementation("org.springframework.kafka:spring-kafka")
|
|
implementation("org.springframework.kafka:spring-kafka-test") {
|
|
exclude group: "commons-logging", module: "commons-logging"
|
|
}
|
|
implementation("org.springframework.pulsar:spring-pulsar")
|
|
implementation("org.springframework.pulsar:spring-pulsar-reactive")
|
|
implementation("org.springframework.restdocs:spring-restdocs-mockmvc")
|
|
implementation("org.springframework.restdocs:spring-restdocs-restassured")
|
|
implementation("org.springframework.restdocs:spring-restdocs-webtestclient")
|
|
implementation("org.springframework.security:spring-security-config")
|
|
implementation("org.springframework.security:spring-security-oauth2-client")
|
|
implementation("org.springframework.security:spring-security-test")
|
|
implementation("org.springframework.security:spring-security-web")
|
|
implementation("org.springframework.ws:spring-ws-core")
|
|
implementation("org.springframework.ws:spring-ws-test")
|
|
implementation("org.testcontainers:junit-jupiter")
|
|
implementation("org.testcontainers:neo4j")
|
|
implementation("org.testcontainers:mongodb")
|
|
implementation("org.testcontainers:elasticsearch")
|
|
implementation("org.junit.jupiter:junit-jupiter")
|
|
implementation("org.yaml:snakeyaml")
|
|
|
|
remoteSpringApplicationExample(platform(project(":spring-boot-project:spring-boot-dependencies")))
|
|
remoteSpringApplicationExample(project(":spring-boot-project:spring-boot-devtools"))
|
|
remoteSpringApplicationExample(project(":spring-boot-project:spring-boot-starters:spring-boot-starter-logging"))
|
|
remoteSpringApplicationExample("org.springframework:spring-web")
|
|
|
|
resolvedBom(project(path: ":spring-boot-project:spring-boot-dependencies", configuration: "resolvedBom"))
|
|
|
|
springApplicationExample(platform(project(":spring-boot-project:spring-boot-dependencies")))
|
|
springApplicationExample(project(path: ":spring-boot-project:spring-boot-starters:spring-boot-starter-web"))
|
|
|
|
testImplementation(project(":spring-boot-project:spring-boot-actuator-autoconfigure"))
|
|
testImplementation(project(":spring-boot-project:spring-boot-tools:spring-boot-test-support"))
|
|
testImplementation("org.assertj:assertj-core")
|
|
testImplementation("org.junit.jupiter:junit-jupiter")
|
|
|
|
testRuntimeOnly(project(":spring-boot-project:spring-boot-starters:spring-boot-starter-web"))
|
|
testRuntimeOnly("com.h2database:h2")
|
|
testRuntimeOnly("org.springframework:spring-jdbc")
|
|
|
|
testSlices(project(path: ":spring-boot-project:spring-boot-test-autoconfigure", configuration: "testSliceMetadata"))
|
|
}
|
|
|
|
dokkatoo {
|
|
moduleName.set("Spring Boot Kotlin API")
|
|
}
|
|
|
|
def aggregatedJavadoc = tasks.register('aggregatedJavadoc', Javadoc) {
|
|
dependsOn configurations.resolvedBom
|
|
destinationDir = project.file(project.layout.buildDirectory.dir("docs/javadoc"))
|
|
options {
|
|
author = true
|
|
docTitle = "Spring Boot ${project.version} API"
|
|
memberLevel = "protected"
|
|
outputLevel = "quiet"
|
|
splitIndex = true
|
|
use = true
|
|
windowTitle = "Spring Boot ${project.version} API"
|
|
}
|
|
doFirst(new ConfigureJavadocLinks(configurations.resolvedBom, ["Spring Framework", "Spring Security", "Tomcat"]))
|
|
}
|
|
|
|
project.rootProject.gradle.projectsEvaluated {
|
|
Set<Project> publishedProjects = rootProject.subprojects.findAll { it != project }
|
|
.findAll { it.plugins.hasPlugin(JavaPlugin) && it.plugins.hasPlugin(MavenPublishPlugin) }
|
|
.findAll { !it.path.contains(":spring-boot-tools:") ||
|
|
it.path.contains(":spring-boot-tools:spring-boot-buildpack-platform") ||
|
|
it.path.contains(":spring-boot-tools:spring-boot-loader-tools") ||
|
|
(it.path.contains(":spring-boot-tools:spring-boot-loader") && !it.path.contains("spring-boot-loader-classic"))}
|
|
.findAll { !it.name.startsWith('spring-boot-starter') }
|
|
aggregatedJavadoc.configure {
|
|
dependsOn publishedProjects.javadoc
|
|
source publishedProjects.javadoc.source
|
|
classpath = project.files(publishedProjects.javadoc.classpath)
|
|
}
|
|
}
|
|
|
|
tasks.register("documentTestSlices", org.springframework.boot.build.test.autoconfigure.DocumentTestSlices) {
|
|
testSlices = configurations.testSlices
|
|
outputFile = layout.buildDirectory.file("generated/docs/test-auto-configuration/documented-slices.adoc")
|
|
}
|
|
|
|
tasks.register("documentStarters", org.springframework.boot.build.starters.DocumentStarters) {
|
|
outputDir = layout.buildDirectory.dir("generated/docs/using/starters/")
|
|
}
|
|
|
|
tasks.register("documentAutoConfigurationClasses", org.springframework.boot.build.autoconfigure.DocumentAutoConfigurationClasses) {
|
|
autoConfiguration = configurations.autoConfiguration
|
|
outputDir = layout.buildDirectory.dir("generated/docs/auto-configuration-classes/documented-auto-configuration-classes/")
|
|
}
|
|
|
|
tasks.register("documentDependencyVersionCoordinates", org.springframework.boot.build.docs.DocumentManagedDependencies) {
|
|
outputFile = layout.buildDirectory.file("generated/docs/dependency-versions/documented-coordinates.adoc")
|
|
resolvedBoms = configurations.resolvedBom
|
|
}
|
|
|
|
tasks.register("documentDependencyVersionProperties", org.springframework.boot.build.docs.DocumentVersionProperties) {
|
|
outputFile = layout.buildDirectory.file("generated/docs/dependency-versions/documented-properties.adoc")
|
|
resolvedBoms = configurations.resolvedBom
|
|
}
|
|
|
|
tasks.register("documentConfigurationProperties", org.springframework.boot.build.context.properties.DocumentConfigurationProperties) {
|
|
configurationPropertyMetadata = configurations.configurationProperties
|
|
outputDir = layout.buildDirectory.dir("generated/docs/application-properties")
|
|
}
|
|
|
|
tasks.register("documentDevtoolsPropertyDefaults", org.springframework.boot.build.devtools.DocumentDevtoolsPropertyDefaults) {}
|
|
|
|
tasks.register("runRemoteSpringApplicationExample", org.springframework.boot.build.docs.ApplicationRunner) {
|
|
classpath = configurations.remoteSpringApplicationExample
|
|
mainClass = "org.springframework.boot.devtools.RemoteSpringApplication"
|
|
args = ["https://myapp.example.com", "--spring.devtools.remote.secret=secret", "--spring.devtools.livereload.port=0"]
|
|
output = layout.buildDirectory.file("example-output/remote-spring-application.txt")
|
|
expectedLogging = "Started RemoteSpringApplication in "
|
|
applicationJar = "/Users/myuser/.m2/repository/org/springframework/boot/spring-boot-devtools/${project.version}/spring-boot-devtools-${project.version}.jar"
|
|
normalizeLiveReloadPort()
|
|
}
|
|
|
|
tasks.register("runSpringApplicationExample", org.springframework.boot.build.docs.ApplicationRunner) {
|
|
classpath = configurations.springApplicationExample + sourceSets.main.output
|
|
mainClass = "org.springframework.boot.docs.features.logexample.MyApplication"
|
|
args = ["--server.port=0"]
|
|
output = layout.buildDirectory.file("example-output/spring-application.txt")
|
|
expectedLogging = "Started MyApplication in "
|
|
normalizeTomcatPort()
|
|
}
|
|
|
|
tasks.register("runLoggingFormatExample", org.springframework.boot.build.docs.ApplicationRunner) {
|
|
classpath = configurations.springApplicationExample + sourceSets.main.output
|
|
mainClass = "org.springframework.boot.docs.features.logexample.MyApplication"
|
|
args = ["--spring.main.banner-mode=off", "--server.port=0", "--spring.application.name=myapp"]
|
|
output = layout.buildDirectory.file("example-output/logging-format.txt")
|
|
expectedLogging = "Started MyApplication in "
|
|
normalizeTomcatPort()
|
|
}
|
|
|
|
def getRelativeExamplesPath(var outputs) {
|
|
def fileName = outputs.files.singleFile.name
|
|
'example$example-output/' + fileName
|
|
}
|
|
|
|
antoraDependencies {
|
|
'actuator-rest-api' {
|
|
path = ":spring-boot-project:spring-boot-actuator-autoconfigure"
|
|
source()
|
|
aggregateContent()
|
|
}
|
|
'gradle-plugin' {
|
|
path = ":spring-boot-project:spring-boot-tools:spring-boot-gradle-plugin"
|
|
source()
|
|
catalogContent()
|
|
}
|
|
'maven-plugin' {
|
|
path = ":spring-boot-project:spring-boot-tools:spring-boot-maven-plugin"
|
|
source()
|
|
catalogContent()
|
|
aggregateContent()
|
|
}
|
|
}
|
|
|
|
antoraContributions {
|
|
'api' {
|
|
publish()
|
|
catalogContent {
|
|
from(aggregatedJavadoc) {
|
|
into "java"
|
|
}
|
|
from(tasks.named("dokkatooGeneratePublicationHtml")) {
|
|
into "kotlin"
|
|
}
|
|
}
|
|
}
|
|
'root' {
|
|
publish()
|
|
aggregateContent {
|
|
from("src/main") {
|
|
into "modules/ROOT/examples"
|
|
}
|
|
from(project.configurations.configurationProperties) {
|
|
eachFile {
|
|
it.path = rootProject
|
|
.projectDir
|
|
.toPath()
|
|
.relativize(it.file.toPath())
|
|
.toString()
|
|
.replace('\\', '/')
|
|
.replaceAll('.*/([^/]+)/build.*', 'modules/ROOT/partials/$1/spring-configuration-metadata.json')
|
|
}
|
|
}
|
|
from(runRemoteSpringApplicationExample) {
|
|
into "modules/ROOT/examples"
|
|
}
|
|
from(documentDevtoolsPropertyDefaults) {
|
|
into "modules/ROOT/partials/propertydefaults"
|
|
}
|
|
from(documentStarters) {
|
|
into "modules/ROOT/partials/starters"
|
|
}
|
|
from(documentTestSlices) {
|
|
into "modules/appendix/partials/slices"
|
|
}
|
|
from(runSpringApplicationExample) {
|
|
into "modules/ROOT/partials/application"
|
|
}
|
|
from(runLoggingFormatExample) {
|
|
into "modules/ROOT/partials/logging"
|
|
}
|
|
from(documentDependencyVersionCoordinates) {
|
|
into "modules/appendix/partials/dependency-versions"
|
|
}
|
|
from(documentDependencyVersionProperties) {
|
|
into "modules/appendix/partials/dependency-versions"
|
|
}
|
|
from(documentAutoConfigurationClasses) {
|
|
into "modules/appendix/partials/auto-configuration-classes"
|
|
include "nav.adoc"
|
|
}
|
|
from(documentAutoConfigurationClasses) {
|
|
into "modules/appendix/pages/auto-configuration-classes"
|
|
exclude "nav.adoc"
|
|
}
|
|
from(documentConfigurationProperties) {
|
|
into "modules/appendix/partials/configuration-properties"
|
|
}
|
|
from(tasks.getByName("generateAntoraYml")) {
|
|
into "modules"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
dokkatoo {
|
|
dokkatooPublications.configureEach {
|
|
includes.from("src/docs/dokkatoo/dokka-overview.md")
|
|
}
|
|
}
|