Migrate actuator-autoconfigure to Antora

See gh-33766

Author: philwebb

spring-boot-project/spring-boot-actuator-autoconfigure/build.gradle

@@ -1,6 +1,6 @@
 plugins {
 	id "java-library"
-	id "org.asciidoctor.jvm.convert"
+	id "org.antora"
 	id "org.springframework.boot.auto-configuration"
 	id "org.springframework.boot.configuration-properties"
 	id "org.springframework.boot.conventions"
@@ -11,13 +11,10 @@ plugins {
 description = "Spring Boot Actuator AutoConfigure"
 
 configurations {
-	documentation
+	antoraContent
 }
 
 dependencies {
-	asciidoctorExtensions("org.springframework.restdocs:spring-restdocs-asciidoctor")
-	asciidoctorExtensions("io.spring.asciidoctor:spring-asciidoctor-extensions-section-ids")
-
 	api(project(":spring-boot-project:spring-boot-actuator"))
 	api(project(":spring-boot-project:spring-boot"))
 	api(project(":spring-boot-project:spring-boot-autoconfigure"))
@@ -195,38 +192,6 @@ dependencies {
 	}
 }
 
-task dependencyVersions(type: org.springframework.boot.build.constraints.ExtractVersionConstraints) {
-	enforcedPlatform(":spring-boot-project:spring-boot-dependencies")
-}
-
-asciidoctor {
-	sources {
-		include "index.adoc"
-	}
-}
-
-task asciidoctorPdf(type: org.asciidoctor.gradle.jvm.AsciidoctorTask) {
-	sources {
-		include "index.adoc"
-	}
-}
-
-task zip(type: Zip) {
-	dependsOn asciidoctor, asciidoctorPdf
-	duplicatesStrategy "fail"
-	from(asciidoctorPdf.outputDir) {
-		into "pdf"
-		rename { "spring-boot-actuator-web-api.pdf" }
-	}
-	from(asciidoctor.outputDir) {
-		into "htmlsingle"
-	}
-}
-
-artifacts {
-	documentation zip
-}
-
 tasks.named("test") {
 	jvmArgs += "--add-opens=java.base/java.net=ALL-UNNAMED"
 	filter {
@@ -235,28 +200,46 @@ tasks.named("test") {
 }
 
 def documentationTest = tasks.register("documentationTest", Test) {
+	jvmArgs += "--add-opens=java.base/java.net=ALL-UNNAMED"
 	filter {
 		includeTestsMatching("org.springframework.boot.actuate.autoconfigure.endpoint.web.documentation.*")
 	}
-	jvmArgs += "--add-opens=java.base/java.net=ALL-UNNAMED"
 	outputs.dir("${buildDir}/generated-snippets")
 	predictiveSelection {
 		enabled = false
 	}
 }
 
-tasks.withType(org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask) {
-	dependsOn dependencyVersions
-	doFirst {
-		def versionConstraints = dependencyVersions.versionConstraints
-		def toAntoraVersion = version -> {
-			String formatted = version.split("\\.").take(2).join('.')
-			return version.endsWith("-SNAPSHOT") ? formatted + "-SNAPSHOT" : formatted
-		}
-		def integrationVersion = versionConstraints["org.springframework.integration:spring-integration-core"]
-		String integrationDocs = String.format("https://docs.spring.io/spring-integration/reference/%s", toAntoraVersion(integrationVersion))
-		attributes "spring-integration-docs": integrationDocs
+def antoraActuatorRestApiLocalAggregateContent  = tasks.register("antoraActuatorRestApiLocalAggregateContent", Zip) {
+	destinationDirectory = layout.buildDirectory.dir('generated/docs/antora-content')
+	archiveClassifier = "actuator-rest-api-local-aggregate-content"
+	from(tasks.getByName("generateAntoraYml")) {
+		into "modules"
 	}
+}
+
+def antoraActuatorRestApiAggregateContent = tasks.register("antoraActuatorRestApiAggregateContent", Zip) {
 	dependsOn documentationTest
-	inputs.dir("${buildDir}/generated-snippets").withPathSensitivity(PathSensitivity.RELATIVE).withPropertyName("generatedSnippets")
+	inputs.dir("${buildDir}/generated-snippets")
+		.withPathSensitivity(PathSensitivity.RELATIVE)
+		.withPropertyName("generatedSnippets")
+	destinationDirectory = layout.buildDirectory.dir('generated/docs/antora-content')
+	archiveClassifier = "actuator-rest-api-aggregate-content"
+	from("${buildDir}/generated-snippets") {
+		into "modules/api/partials/rest/actuator"
+	}
+}
+
+tasks.named("generateAntoraPlaybook") {
+	alwaysInclude = [name: "actuator-rest-api", classifier: "local-aggregate-content"]
+	dependsOn antoraActuatorRestApiLocalAggregateContent
+}
+
+tasks.named("antora") {
+	inputs.files(antoraActuatorRestApiAggregateContent)
 }
+
+artifacts {
+	antoraContent antoraActuatorRestApiAggregateContent
+}
+

…/docs/asciidoc/anchor-rewrite.properties …rc/docs/antora/anchor-rewrite.propertiesspring-boot-project/spring-boot-actuator-autoconfigure/src/docs/asciidoc/anchor-rewrite.properties renamed to spring-boot-project/spring-boot-actuator-autoconfigure/src/docs/antora/anchor-rewrite.properties spring-boot-project/spring-boot-actuator-autoconfigure/src/docs/asciidoc/anchor-rewrite.properties renamed to spring-boot-project/spring-boot-actuator-autoconfigure/src/docs/antora/anchor-rewrite.properties

@@ -0,0 +1,6 @@
+name: spring-boot
+ext:
+  zip_contents_collector:
+    include:
+    - name: actuator-rest-api
+      classifier: aggregate-content

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

@@ -0,0 +1 @@
+include::api:partial$nav-actuator-rest-api.adoc[]

spring-boot-project/spring-boot-actuator-autoconfigure/src/docs/antora/local-nav.adoc

@@ -1,36 +1,40 @@
 [[audit-events]]
 = Audit Events (`auditevents`)
+
 The `auditevents` endpoint provides information about the application's audit events.
 
 
 
 [[audit-events.retrieving]]
 == Retrieving Audit Events
+
 To retrieve the audit events, make a `GET` request to `/actuator/auditevents`, as shown in the following curl-based example:
 
-include::{snippets}/auditevents/filtered/curl-request.adoc[]
+include::partial$rest/actuator/auditevents/filtered/curl-request.adoc[]
 
 The preceding example retrieves `logout` events for the principal, `alice`, that occurred after 09:37 on 7 November 2017 in the UTC timezone.
 The resulting response is similar to the following:
 
-include::{snippets}/auditevents/filtered/http-response.adoc[]
+include::partial$rest/actuator/auditevents/filtered/http-response.adoc[]
 
 
 
 [[audit-events.retrieving.query-parameters]]
 === Query Parameters
+
 The endpoint uses query parameters to limit the events that it returns.
 The following table shows the supported query parameters:
 
 [cols="2,4"]
-include::{snippets}/auditevents/filtered/query-parameters.adoc[]
+include::partial$rest/actuator/auditevents/filtered/query-parameters.adoc[]
 
 
 
 [[audit-events.retrieving.response-structure]]
 === Response Structure
+
 The response contains details of all of the audit events that matched the query.
 The following table describes the structure of the response:
 
 [cols="2,1,3"]
-include::{snippets}/auditevents/all/response-fields.adoc[]
+include::partial$rest/actuator/auditevents/all/response-fields.adoc[]

…docs/asciidoc/endpoints/auditevents.adoc …api/pages/rest/actuator/auditevents.adocspring-boot-project/spring-boot-actuator-autoconfigure/src/docs/asciidoc/endpoints/auditevents.adoc renamed to spring-boot-project/spring-boot-actuator-autoconfigure/src/docs/antora/modules/api/pages/rest/actuator/auditevents.adoc spring-boot-project/spring-boot-actuator-autoconfigure/src/docs/asciidoc/endpoints/auditevents.adoc renamed to spring-boot-project/spring-boot-actuator-autoconfigure/src/docs/antora/modules/api/pages/rest/actuator/auditevents.adoc

@@ -1,25 +1,28 @@
 [[beans]]
 = Beans (`beans`)
+
 The `beans` endpoint provides information about the application's beans.
 
 
 
 [[beans.retrieving]]
 == Retrieving the Beans
+
 To retrieve the beans, make a `GET` request to `/actuator/beans`, as shown in the following curl-based example:
 
-include::{snippets}/beans/curl-request.adoc[]
+include::partial$rest/actuator/beans/curl-request.adoc[]
 
 The resulting response is similar to the following:
 
-include::{snippets}/beans/http-response.adoc[]
+include::partial$rest/actuator/beans/http-response.adoc[]
 
 
 
 [[beans.retrieving.response-structure]]
 === Response Structure
+
 The response contains details of the application's beans.
 The following table describes the structure of the response:
 
 [cols="2,1,3"]
-include::{snippets}/beans/response-fields.adoc[]
+include::partial$rest/actuator/beans/response-fields.adoc[]

…e/src/docs/asciidoc/endpoints/beans.adoc …dules/api/pages/rest/actuator/beans.adocspring-boot-project/spring-boot-actuator-autoconfigure/src/docs/asciidoc/endpoints/beans.adoc renamed to spring-boot-project/spring-boot-actuator-autoconfigure/src/docs/antora/modules/api/pages/rest/actuator/beans.adoc spring-boot-project/spring-boot-actuator-autoconfigure/src/docs/asciidoc/endpoints/beans.adoc renamed to spring-boot-project/spring-boot-actuator-autoconfigure/src/docs/antora/modules/api/pages/rest/actuator/beans.adoc

@@ -1,88 +1,97 @@
 [[caches]]
 = Caches (`caches`)
+
 The `caches` endpoint provides access to the application's caches.
 
 
 
 [[caches.all]]
 == Retrieving All Caches
+
 To retrieve the application's caches, make a `GET` request to `/actuator/caches`, as shown in the following curl-based example:
 
-include::{snippets}/caches/all/curl-request.adoc[]
+include::partial$rest/actuator/caches/all/curl-request.adoc[]
 
 The resulting response is similar to the following:
 
-include::{snippets}/caches/all/http-response.adoc[]
+include::partial$rest/actuator/caches/all/http-response.adoc[]
 
 
 
 [[caches.all.response-structure]]
 === Response Structure
+
 The response contains details of the application's caches.
 The following table describes the structure of the response:
 
 [cols="3,1,3"]
-include::{snippets}/caches/all/response-fields.adoc[]
+include::partial$rest/actuator/caches/all/response-fields.adoc[]
 
 
 
 [[caches.named]]
 == Retrieving Caches by Name
+
 To retrieve a cache by name, make a `GET` request to `/actuator/caches/\{name}`, as shown in the following curl-based example:
 
-include::{snippets}/caches/named/curl-request.adoc[]
+include::partial$rest/actuator/caches/named/curl-request.adoc[]
 
 The preceding example retrieves information about the cache named `cities`.
 The resulting response is similar to the following:
 
-include::{snippets}/caches/named/http-response.adoc[]
+include::partial$rest/actuator/caches/named/http-response.adoc[]
 
 
 
 [[caches.named.query-parameters]]
 === Query Parameters
+
 If the requested name is specific enough to identify a single cache, no extra parameter is required.
 Otherwise, the `cacheManager` must be specified.
 The following table shows the supported query parameters:
 
 [cols="2,4"]
-include::{snippets}/caches/named/query-parameters.adoc[]
+include::partial$rest/actuator/caches/named/query-parameters.adoc[]
 
 
 
 [[caches.named.response-structure]]
 === Response Structure
+
 The response contains details of the requested cache.
 The following table describes the structure of the response:
 
 [cols="3,1,3"]
-include::{snippets}/caches/named/response-fields.adoc[]
+include::partial$rest/actuator/caches/named/response-fields.adoc[]
 
 
 
 [[caches.evict-all]]
 == Evict All Caches
+
 To clear all available caches, make a `DELETE` request to `/actuator/caches` as shown in the following curl-based example:
 
-include::{snippets}/caches/evict-all/curl-request.adoc[]
+include::partial$rest/actuator/caches/evict-all/curl-request.adoc[]
 
 
 
 [[caches.evict-named]]
 == Evict a Cache by Name
+
 To evict a particular cache, make a `DELETE` request to `/actuator/caches/\{name}` as shown in the following curl-based example:
 
-include::{snippets}/caches/evict-named/curl-request.adoc[]
+include::partial$rest/actuator/caches/evict-named/curl-request.adoc[]
 
 NOTE: As there are two caches named `countries`, the `cacheManager` has to be provided to specify which `Cache` should be cleared.
 
 
 
 [[caches.evict-named.request-structure]]
 === Request Structure
+
 If the requested name is specific enough to identify a single cache, no extra parameter is required.
 Otherwise, the `cacheManager` must be specified.
 The following table shows the supported query parameters:
 
 [cols="2,4"]
-include::{snippets}/caches/evict-named/query-parameters.adoc[]
+include::partial$rest/actuator/caches/evict-named/query-parameters.adoc[]

…/src/docs/asciidoc/endpoints/caches.adoc …ules/api/pages/rest/actuator/caches.adocspring-boot-project/spring-boot-actuator-autoconfigure/src/docs/asciidoc/endpoints/caches.adoc renamed to spring-boot-project/spring-boot-actuator-autoconfigure/src/docs/antora/modules/api/pages/rest/actuator/caches.adoc spring-boot-project/spring-boot-actuator-autoconfigure/src/docs/asciidoc/endpoints/caches.adoc renamed to spring-boot-project/spring-boot-actuator-autoconfigure/src/docs/antora/modules/api/pages/rest/actuator/caches.adoc

@@ -1,25 +1,28 @@
 [[conditions]]
 = Conditions Evaluation Report (`conditions`)
+
 The `conditions` endpoint provides information about the evaluation of conditions on configuration and auto-configuration classes.
 
 
 
 [[conditions.retrieving]]
 == Retrieving the Report
+
 To retrieve the report, make a `GET` request to `/actuator/conditions`, as shown in the following curl-based example:
 
-include::{snippets}/conditions/curl-request.adoc[]
+include::partial$rest/actuator/conditions/curl-request.adoc[]
 
 The resulting response is similar to the following:
 
-include::{snippets}/conditions/http-response.adoc[]
+include::partial$rest/actuator/conditions/http-response.adoc[]
 
 
 
 [[conditions.retrieving.response-structure]]
 === Response Structure
+
 The response contains details of the application's condition evaluation.
 The following table describes the structure of the response:
 
 [cols="3,1,3"]
-include::{snippets}/conditions/response-fields.adoc[]
+include::partial$rest/actuator/conditions/response-fields.adoc[]