Skip to content

Commit 620b9bf

Browse files
author
Jay Bryant
authored
Upgrade to latest version of Asciidoctor
Upgrade to latest version of Asciidoctor because we were several versions behind and were steadily incurring more technical debt. * Replace project-version attribute in Asciidoctor I had removed the project-version attribute, but the docs use it all over, so I put it back. * Removed unneeded repositories It turns out that those repositories are not needed. A cross-reference was incorrectly formatted (missing the # character).
1 parent e9a0149 commit 620b9bf

File tree

3 files changed

+32
-24
lines changed

3 files changed

+32
-24
lines changed

build.gradle

Lines changed: 30 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,19 @@ buildscript {
66
dependencies {
77
classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlinVersion"
88
classpath "org.jetbrains.kotlin:kotlin-allopen:$kotlinVersion"
9-
classpath 'org.asciidoctor:asciidoctorj-pdf:1.5.0-beta.6'
109
}
1110
}
1211

1312
plugins {
1413
id 'org.sonarqube' version '2.8'
15-
id 'org.asciidoctor.convert' version '1.6.1'
1614
id 'io.spring.nohttp' version '0.0.4.RELEASE' apply false
1715
id 'org.ajoberstar.grgit' version '4.0.1'
1816
id "io.spring.dependency-management" version '1.0.9.RELEASE'
1917
id 'com.jfrog.artifactory' version '4.15.1' apply false
2018
id 'org.jetbrains.dokka' version '0.10.1'
19+
id 'org.asciidoctor.jvm.pdf' version '3.1.0'
20+
id 'org.asciidoctor.jvm.gems' version '3.1.0'
21+
id 'org.asciidoctor.jvm.convert' version '3.1.0'
2122
}
2223

2324
if (System.getenv('TRAVIS') || System.getenv('bamboo_buildKey')) {
@@ -907,51 +908,58 @@ task checkAsciidocLinks {
907908
}
908909
}
909910

910-
task('makePDF', type: org.asciidoctor.gradle.AsciidoctorTask) {
911+
asciidoctorPdf {
911912
dependsOn checkAsciidocLinks
912-
backends 'pdf'
913-
sourceDir "$buildDir/asciidoc"
914-
inputs.dir(sourceDir)
915-
sources {
916-
include 'index-single.adoc'
917-
}
918-
options doctype: 'book', eruby: 'erubis'
919-
attributes 'icons': 'font',
913+
baseDirFollowsSourceFile()
914+
915+
asciidoctorj {
916+
sourceDir "$buildDir/asciidoc"
917+
inputs.dir(sourceDir)
918+
sources {
919+
include 'index-single.adoc'
920+
}
921+
options doctype: 'book'
922+
attributes 'icons': 'font',
920923
'sectanchors': '',
921924
'sectnums': '',
922925
'toc': '',
923926
'source-highlighter' : 'coderay',
924-
revnumber: project.version
927+
revnumber: project.version,
928+
'project-version': project.version
929+
}
925930
}
926931

927932
asciidoctor {
928-
dependsOn makePDF
929-
backends 'html5'
933+
dependsOn asciidoctorPdf
934+
935+
baseDirFollowsSourceFile()
936+
930937
sourceDir "$buildDir/asciidoc"
931938
inputs.dir(sourceDir)
932939
resources {
933940
from(sourceDir) {
934941
include 'images/*', 'css/**', 'js/**'
935942
}
936943
}
937-
options doctype: 'book', eruby: 'erubis'
944+
options doctype: 'book'
938945

939946
attributes 'docinfo': 'shared',
940-
stylesdir: "css/",
947+
stylesdir: 'css/',
941948
stylesheet: 'spring.css',
942949
'linkcss': true,
943950
'icons': 'font',
944951
'sectanchors': '',
945-
'source-highlighter=highlight.js',
946-
'highlightjsdir=js/highlight',
952+
'source-highlighter': 'highlight.js',
953+
'highlightjsdir': 'js/highlight',
947954
'highlightjs-theme': 'github',
948955
'idprefix': '',
949956
'idseparator': '-',
950957
'spring-version': project.version,
951958
'allow-uri-read': '',
952959
'toc': 'left',
953-
'toclevbels': '4',
954-
revnumber: project.version
960+
'toclevels': '4',
961+
revnumber: project.version,
962+
'project-version': project.version
955963
}
956964

957965
task reference(dependsOn: asciidoctor) {
@@ -1074,11 +1082,11 @@ task docsZip(type: Zip, dependsOn: reference) {
10741082
into 'api'
10751083
}
10761084

1077-
from ('build/asciidoc/html5') {
1085+
from ('build/docs/asciidoc') {
10781086
into 'reference/html'
10791087
}
10801088

1081-
from ('build/asciidoc/pdf') {
1089+
from ('build/docs/asciidocPdf') {
10821090
include "index-single.pdf"
10831091
rename 'index-single.pdf', 'spring-integration-reference.pdf'
10841092
into 'reference/pdf'

src/reference/asciidoc/index-header.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Mark Fisher; Marius Bogoevici; Iwein Fuld; Jonas Partner; Oleg Zhurakousky; Gary Russell; Dave Syer; Josh Long; David Turanski; Gunnar Hillert; Artem Bilan; Amol Nayak; Jay Bryant
44

55
ifdef::backend-html5[]
6-
*{project-version}*
6+
*{revnumber}*
77
endif::[]
88

99
(C) 2009 - 2020 Pivotal Software, Inc.

src/reference/asciidoc/mongodb.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -548,7 +548,7 @@ Starting with version 5.3, the `ReactiveMongoDbStoringMessageHandler` and `React
548548
They are based on the `ReactiveMongoOperations` from Spring Data and requires a `org.mongodb:mongodb-driver-reactivestreams` dependency.
549549

550550
The `ReactiveMongoDbStoringMessageHandler` is an implementation of the `ReactiveMessageHandler` which is supported natively in the framework when reactive streams composition is involved in the integration flow definition.
551-
See more information in the <<./reactive-streams.adoc/reactive-message-handler,ReactiveMessageHandler>>.
551+
See more information in the <<./reactive-streams.adoc#reactive-message-handler,ReactiveMessageHandler>>.
552552

553553
From configuration perspective there is no difference with many other standard channel adapters.
554554
For example with Java DSL such a channel adapter could be used like:

0 commit comments

Comments
 (0)