Skip to content

Commit cc30882

Browse files
authored
Modernize Antora Build (#3309)
This PR is an attempt to apply some modernization related to Antora gradle build. It is related to spring-projects/spring-framework#32864 Notice that the @springio/antora-extensions is not used because it uses springio/antora-extensions/set-algolia-env-extension which is currently not compatible with projectreactor.
1 parent c826a22 commit cc30882

File tree

4 files changed

+15
-20
lines changed

4 files changed

+15
-20
lines changed

.gitignore

+3-1
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,6 @@ exportToHtml
1818
.rulesets
1919
.gradletasknamecache
2020
*.iml
21-
.idea
21+
.idea
22+
node_modules/
23+
.full-build

build.gradle

-7
Original file line numberDiff line numberDiff line change
@@ -140,13 +140,6 @@ ext {
140140

141141
// Antora
142142
antoraPluginVersion = '1.0.0'
143-
antoraVersion = '3.2.0-alpha.4'
144-
antoraAtlasExtensionVersion = '1.0.0-alpha.1'
145-
antoraPdfExtensionVersion = '1.0.0-alpha.7'
146-
antoraCollectorExtensionVersion = '1.0.0-alpha.3'
147-
asciiDocTabVersion = '1.0.0-beta.6'
148-
springIoAntoraExtensionsVersion = '1.8.2'
149-
springIoAsciidoctorExtensionsVersion = '1.0.0-alpha.9'
150143

151144
javadocLinks = ["https://docs.oracle.com/javase/8/docs/api/",
152145
// Use Reactive Streams 1.0.3 version for javadoc generation

docs/package.json

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"dependencies": {
3+
"antora": "3.2.0-alpha.4",
4+
"@antora/atlas-extension": "1.0.0-alpha.2",
5+
"@antora/collector-extension": "1.0.0-alpha.3",
6+
"@antora/pdf-extension": "1.0.0-alpha.7",
7+
"@asciidoctor/tabs": "1.0.0-beta.6",
8+
"@springio/antora-extensions": "1.11.1",
9+
"@springio/asciidoctor-extensions": "1.0.0-alpha.10"
10+
}
11+
}

gradle/antora-docs.gradle

+1-12
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,7 @@ def isCommandAvailable(String command) {
2626
}
2727

2828
antora {
29-
version = "$antoraVersion"
30-
playbook = findProperty('antora.playbook') ?: "antora-playbook.yml"
31-
options = ['--clean', '--stacktrace']
29+
options = [clean: true, fetch: !project.gradle.startParameter.offline, stacktrace: true]
3230

3331
def version = project.version
3432
def forcePdf = project.hasProperty('forcePdf')
@@ -47,15 +45,6 @@ antora {
4745
'ALGOLIA_APP_ID' : '82SNR5M8HE',
4846
'ALGOLIA_INDEX_NAME': 'projectreactor'
4947
]
50-
51-
dependencies = [
52-
'@antora/atlas-extension' : "$antoraAtlasExtensionVersion",
53-
'@antora/pdf-extension' : "$antoraPdfExtensionVersion",
54-
'@antora/collector-extension' : "$antoraCollectorExtensionVersion",
55-
'@asciidoctor/tabs' : "$asciiDocTabVersion",
56-
'@springio/antora-extensions' : "$springIoAntoraExtensionsVersion",
57-
'@springio/asciidoctor-extensions': "$springIoAsciidoctorExtensionsVersion"
58-
]
5948
}
6049

6150
jar {

0 commit comments

Comments
 (0)