Skip to content

Commit cde909d

Browse files
committed
Merge branch '2.7.x' into 3.0.x
- Update Antora Closes gh-2332
2 parents 8f7e056 + 2d5432b commit cde909d

File tree

3 files changed

+34
-46
lines changed

3 files changed

+34
-46
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,4 @@ out
1616
.DS_Store
1717
spring-session-docs/package-lock.json
1818
spring-session-docs/node_modules/
19+
cached-antora-playbook.yml

spring-session-docs/antora.yml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
name: session
22
version: true
33
title: Spring Session
4+
start_page: ROOT:index.adoc
45
nav:
56
- modules/ROOT/nav.adoc
67
ext:
@@ -10,3 +11,15 @@ ext:
1011
local: true
1112
scan:
1213
dir: ./build/generated-antora-resources
14+
asciidoc:
15+
attributes:
16+
gh-url: "https://github.com/spring-projects/spring-session/tree/{gh-tag}"
17+
download-url: "https://github.com/spring-projects/spring-session/archive/{gh-tag}.zip"
18+
gh-samples-url: "{gh-url}/spring-session-samples/"
19+
samples-dir: "example$spring-session-samples/"
20+
session-jdbc-main-resources-dir: "example$session-jdbc-main-resources-dir/"
21+
spring-session-data-mongodb-dir: "example$spring-session-data-mongodb-dir/"
22+
docs-test-dir: "example$java/"
23+
websocketdoc-test-dir: 'example$java/docs/websocket/'
24+
docs-test-resources-dir: "example$resources/"
25+
indexdoc-tests: "example$java/docs/IndexDocTests.java"

spring-session-docs/spring-session-docs.gradle

Lines changed: 20 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
plugins {
2-
id 'org.antora' version '1.0.0'
3-
id 'io.spring.antora.generate-antora-yml' version '0.0.1'
2+
id 'org.antora' version '1.0.0'
3+
id 'io.spring.antora.generate-antora-yml' version '0.0.1'
44
}
55

66
apply plugin: 'io.spring.convention.docs'
@@ -29,57 +29,31 @@ dependencies {
2929
testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine'
3030
}
3131

32+
3233
antora {
33-
playbook = 'cached-antora-playbook.yml'
34-
playbookProvider {
35-
repository = 'spring-projects/spring-session'
36-
branch = 'docs-build'
37-
path = 'lib/antora/templates/per-branch-antora-playbook.yml'
38-
checkLocalBranch = true
39-
}
40-
options = [clean: true, fetch: !project.gradle.startParameter.offline, stacktrace: true]
34+
playbook = 'cached-antora-playbook.yml'
35+
playbookProvider {
36+
repository = 'spring-projects/spring-session'
37+
branch = 'docs-build'
38+
path = 'lib/antora/templates/per-branch-antora-playbook.yml'
39+
checkLocalBranch = true
40+
}
41+
options = [clean: true, fetch: !project.gradle.startParameter.offline, stacktrace: true]
4142
}
4243

4344
tasks.named("generateAntoraYml") {
44-
asciidocAttributes = project.provider( { generateAttributes() } )
45+
asciidocAttributes = project.provider( { generateAttributes() } )
46+
asciidocAttributes.putAll(providers.provider( { resolvedVersions(project.configurations.testRuntimeClasspath) }))
4547
}
4648

47-
def generateAttributes() {
48-
def dollar = '$'
49-
def ghTag = snapshotBuild ? 'main' : project.version
50-
def ghUrl = "https://github.com/spring-projects/spring-session/tree/${ghTag.toString()}"
51-
def snapshotBuild = project.version.contains("SNAPSHOT")
52-
def milestoneBuild = project.version.contains("-M")
53-
def releaseBuild = (!snapshotBuild && !milestoneBuild)
54-
def springBootVersion = project.springBootVersion
55-
def downloadUrl = "https://github.com/spring-projects/spring-session/archive/${ghTag}.zip"
56-
def ghSamplesUrl = "$ghUrl/spring-session-samples/"
57-
def samplesDir = "example${dollar}spring-session-samples/"
58-
def sessionJdbcMainResourcesDir = "example${dollar.toString()}session-jdbc-main-resources-dir/"
59-
def springSessionDataMongoDbDir = "example${dollar.toString()}spring-session-data-mongodb-dir/"
60-
def docsTestDir = "example${dollar.toString()}java/"
61-
def websocketdocTestDir = "example${dollar.toString()}java/docs/websocket/"
62-
def docsTestResourcesDir = "example${dollar.toString()}resources/"
63-
def indexdocTests = "example${dollar.toString()}java/docs/IndexDocTests.java"
64-
def springBootRefDocs = "https://docs.spring.io/spring-boot/docs/${springBootVersion}/reference/html"
6549

66-
return [
67-
'download-url': downloadUrl.toString(),
68-
'gh-samples-url': ghSamplesUrl.toString(),
69-
'samples-dir': samplesDir.toString(),
70-
'session-jdbc-main-resources-dir': sessionJdbcMainResourcesDir.toString(),
71-
'spring-session-data-mongodb-dir': springSessionDataMongoDbDir.toString(),
72-
'docs-test-dir': docsTestDir.toString(),
73-
'websocketdoc-test-dir': websocketdocTestDir.toString(),
74-
'docs-test-resources-dir': docsTestResourcesDir.toString(),
75-
'indexdoc-tests': indexdocTests.toString(),
76-
'spring-session-version': project.version,
77-
'version-milestone': milestoneBuild,
78-
'version-release': releaseBuild,
79-
'version-snapshot': snapshotBuild,
80-
'spring-boot-version': springBootVersion,
81-
'spring-boot-ref-docs': springBootRefDocs.toString()
82-
] + resolvedVersions(project.configurations.testRuntimeClasspath)
50+
def generateAttributes() {
51+
def ghTag = snapshotBuild ? 'main' : project.version
52+
def springBootRefDocs = "https://docs.spring.io/spring-boot/docs/${springBootVersion}/reference/html"
53+
return ['gh-tag':ghTag,
54+
'spring-boot-version': springBootVersion,
55+
'spring-boot-ref-docs': springBootRefDocs.toString(),
56+
'spring-session-version': project.version]
8357
}
8458

8559
sourceSets {

0 commit comments

Comments
 (0)