Use Antora

Closes gh-5835

.github/actions/dispatch.sh

@@ -0,0 +1,5 @@
+REPOSITORY_REF="$1"
+TOKEN="$2"
+
+curl -H "Accept: application/vnd.github.everest-preview+json" -H "Authorization: token ${TOKEN}" --request POST  --data '{"event_type": "request-build"}' https://api.github.com/repos/${REPOSITORY_REF}/dispatches
+echo "Requested Build for $REPOSITORY_REF"

.github/workflows/build-reference.yml

@@ -0,0 +1,28 @@
+name: reference
+
+on:
+  push:
+    branches-ignore:
+      - 'gh-pages'
+
+env:
+  GH_TOKEN_DISPATCH: ${{ secrets.GH_TOKEN_DISPATCH }}
+  GH_TOKEN_PUSH: ${{ secrets.GH_TOKEN_PUSH }}
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Source
+        uses: actions/checkout@v2
+      - name: Generate antora.yml
+        run: ./gradlew :spring-security-docs:generateAntora
+      - name: Push generated antora files to the spring-security-docs-generated
+        uses: JamesIves/[email protected]
+        with:
+          branch: "spring-security/main" # The branch the action should deploy to.
+          folder: "docs/build/generateAntora" # The folder the action should deploy.
+          repository-name: "rwinch/spring-security-docs-generated"
+          token: ${{ secrets.GH_TOKEN_PUSH }}
+      - name: Dispatch Build Request
+        run: ${GITHUB_WORKSPACE}/.github/actions/dispatch.sh 'rwinch/spring-reference' "$GH_TOKEN_DISPATCH"

buildSrc/build.gradle

@@ -76,13 +76,9 @@ dependencies {
 	implementation 'gradle.plugin.org.gretty:gretty:3.0.1'
 	implementation 'com.apollographql.apollo:apollo-runtime:2.4.5'
 	implementation 'com.github.ben-manes:gradle-versions-plugin:0.38.0'
-	implementation 'io.spring.gradle:docbook-reference-plugin:0.3.1'
 	implementation 'io.spring.gradle:propdeps-plugin:0.0.10.RELEASE'
 	implementation 'io.spring.javaformat:spring-javaformat-gradle-plugin:0.0.15'
 	implementation 'io.spring.nohttp:nohttp-gradle:0.0.10'
-	implementation 'org.aim42:htmlSanityCheck:1.1.6'
-	implementation 'org.asciidoctor:asciidoctor-gradle-jvm:3.1.0'
-	implementation 'org.asciidoctor:asciidoctor-gradle-jvm-pdf:3.1.0'
 	implementation 'org.hidetake:gradle-ssh-plugin:2.10.1'
 	implementation 'org.jfrog.buildinfo:build-info-extractor-gradle:4.9.10'
 	implementation 'org.sonarsource.scanner.gradle:sonarqube-gradle-plugin:2.7.1'

buildSrc/src/main/groovy/io/spring/gradle/convention/DocsPlugin.groovy

@@ -1,12 +1,9 @@
 package io.spring.gradle.convention
 
-import org.aim42.htmlsanitycheck.HtmlSanityCheckPlugin
-import org.aim42.htmlsanitycheck.HtmlSanityCheckTask
-import org.aim42.htmlsanitycheck.check.BrokenHttpLinksChecker
-import org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask
 import org.gradle.api.Plugin
 import org.gradle.api.Project
 import org.gradle.api.Task
+import org.gradle.api.plugins.BasePlugin
 import org.gradle.api.plugins.PluginManager
 import org.gradle.api.tasks.bundling.Zip
 
@@ -19,54 +16,18 @@ public class DocsPlugin implements Plugin<Project> {
 	public void apply(Project project) {
 
 		PluginManager pluginManager = project.getPluginManager();
-		pluginManager.apply("org.asciidoctor.jvm.convert");
-		pluginManager.apply("org.asciidoctor.jvm.pdf");
-		pluginManager.apply(AsciidoctorConventionPlugin);
+		pluginManager.apply(BasePlugin);
 		pluginManager.apply(DeployDocsPlugin);
 		pluginManager.apply(JavadocApiPlugin);
-		pluginManager.apply(HtmlSanityCheckPlugin)
-
-		String projectName = Utils.getProjectName(project);
-		String pdfFilename = projectName + "-reference.pdf";
-
-		project.tasks.withType(AbstractAsciidoctorTask) { t ->
-			project.configure(t) {
-				sources {
-					include "**/*.adoc"
-					exclude '_*/**'
-				}
-			}
-		}
-
-		project.tasks.withType(HtmlSanityCheckTask) { HtmlSanityCheckTask t ->
-			project.configure(t) {
-				t.dependsOn 'asciidoctor'
-				t.checkerClasses = [BrokenHttpLinksChecker]
-				t.checkingResultsDir = new File(project.getBuildDir(), "/report/htmlchecks")
-				t.failOnErrors = false
-				t.httpConnectionTimeout = 3000
-				t.sourceDir = new File(project.getBuildDir(), "/docs/asciidoc/")
-				t.sourceDocuments = project.files(new File(project.getBuildDir(), "/docs/asciidoc/index.html"))
-			}
-		}
 
 		Task docsZip = project.tasks.create('docsZip', Zip) {
-			dependsOn 'api', 'asciidoctor'
+			dependsOn 'api'
 			group = 'Distribution'
 			archiveBaseName = project.rootProject.name
 			archiveClassifier = 'docs'
 			description = "Builds -${classifier} archive containing all " +
 				"Docs for deployment at docs.spring.io"
 
-			from(project.tasks.asciidoctor.outputs) {
-				into 'reference/html5'
-				include '**'
-			}
-			from(project.tasks.asciidoctorPdf.outputs) {
-				into 'reference/pdf'
-				include '**'
-				rename "index.pdf", pdfFilename
-			}
 			from(project.tasks.api.outputs) {
 				into 'api'
 			}