From fe29938f33f11c76a108a22a90d09b153dae2942 Mon Sep 17 00:00:00 2001 From: Pierre De Rop Date: Fri, 7 Jun 2024 09:54:56 +0200 Subject: [PATCH] Modernize Antora Build --- .gitignore | 4 +++- build.gradle | 7 ------- docs/antora-playbook.yml | 11 +++-------- docs/package.json | 11 +++++++++++ gradle/antora-docs.gradle | 15 +++------------ 5 files changed, 20 insertions(+), 28 deletions(-) create mode 100644 docs/package.json diff --git a/.gitignore b/.gitignore index d2b0ea6987..493b9c4f18 100644 --- a/.gitignore +++ b/.gitignore @@ -18,4 +18,6 @@ exportToHtml .rulesets .gradletasknamecache *.iml -.idea \ No newline at end of file +.idea +node_modules/ +.full-build diff --git a/build.gradle b/build.gradle index ca3a1e0bfc..53fc397838 100644 --- a/build.gradle +++ b/build.gradle @@ -140,13 +140,6 @@ ext { // Antora antoraPluginVersion = '1.0.0' - antoraVersion = '3.2.0-alpha.4' - antoraAtlasExtensionVersion = '1.0.0-alpha.1' - antoraPdfExtensionVersion = '1.0.0-alpha.7' - antoraCollectorExtensionVersion = '1.0.0-alpha.3' - asciiDocTabVersion = '1.0.0-beta.6' - springIoAntoraExtensionsVersion = '1.8.2' - springIoAsciidoctorExtensionsVersion = '1.0.0-alpha.9' javadocLinks = ["https://docs.oracle.com/javase/8/docs/api/", // Use Reactive Streams 1.0.3 version for javadoc generation diff --git a/docs/antora-playbook.yml b/docs/antora-playbook.yml index 0362d6582e..4fa4b87c9e 100644 --- a/docs/antora-playbook.yml +++ b/docs/antora-playbook.yml @@ -1,19 +1,13 @@ antora: extensions: - - '@springio/antora-extensions/partial-build-extension' - # atlas-extension must be before latest-version-extension so latest versions are applied to imported versions - - '@antora/atlas-extension' - - require: '@springio/antora-extensions/latest-version-extension' - - require: '@springio/antora-extensions/inject-collector-cache-config-extension' - - '@antora/collector-extension' - id: pdf-extension # pdf-extension is enabled from antora-docs.gradle require: '@antora/pdf-extension' enabled: false - - require: '@springio/antora-extensions/root-component-extension' + - require: '@springio/antora-extensions' root_component_name: 'reactor-netty' site: title: Reactor Netty Reference Guide - url: https://projectreactor.io/docs/netty/release/reference/ + url: https://projectreactor.io/docs/netty/milestone/reference/ content: sources: - url: ./.. @@ -24,6 +18,7 @@ asciidoc: extensions: - '@asciidoctor/tabs' - '@springio/asciidoctor-extensions' + - '@springio/asciidoctor-extensions/include-code-extension' attributes: page-stackoverflow-url: https://stackoverflow.com/tags/reactor-netty page-pagination: '' diff --git a/docs/package.json b/docs/package.json new file mode 100644 index 0000000000..aced98784b --- /dev/null +++ b/docs/package.json @@ -0,0 +1,11 @@ +{ + "dependencies": { + "antora": "3.2.0-alpha.4", + "@antora/atlas-extension": "1.0.0-alpha.2", + "@antora/collector-extension": "1.0.0-alpha.3", + "@antora/pdf-extension": "1.0.0-alpha.7", + "@asciidoctor/tabs": "1.0.0-beta.6", + "@springio/antora-extensions": "1.11.1", + "@springio/asciidoctor-extensions": "1.0.0-alpha.10" + } +} \ No newline at end of file diff --git a/gradle/antora-docs.gradle b/gradle/antora-docs.gradle index 003319a930..d9a15bf5d5 100644 --- a/gradle/antora-docs.gradle +++ b/gradle/antora-docs.gradle @@ -26,9 +26,7 @@ def isCommandAvailable(String command) { } antora { - version = "$antoraVersion" - playbook = findProperty('antora.playbook') ?: "antora-playbook.yml" - options = ['--clean', '--stacktrace'] + options = [clean: true, fetch: !project.gradle.startParameter.offline, stacktrace: true] def version = project.version def forcePdf = project.hasProperty('forcePdf') @@ -43,19 +41,12 @@ antora { } environment = [ + 'BUILD_REFNAME': 'HEAD', + 'BUILD_VERSION': project.version, 'ALGOLIA_API_KEY' : 'd4bf9918bfc7d63ae68fbf92d69c2f49', 'ALGOLIA_APP_ID' : '82SNR5M8HE', 'ALGOLIA_INDEX_NAME': 'projectreactor' ] - - dependencies = [ - '@antora/atlas-extension' : "$antoraAtlasExtensionVersion", - '@antora/pdf-extension' : "$antoraPdfExtensionVersion", - '@antora/collector-extension' : "$antoraCollectorExtensionVersion", - '@asciidoctor/tabs' : "$asciiDocTabVersion", - '@springio/antora-extensions' : "$springIoAntoraExtensionsVersion", - '@springio/asciidoctor-extensions': "$springIoAsciidoctorExtensionsVersion" - ] } jar {