Skip to content

Commit 34f4ad3

Browse files
rwinchsdeleuze
authored andcommitted
Modernize Antora Build
- Use same playbook as docs-build - Use Env Variables to cause partial build (same as docs-build) - Use package.json so that dependencies can be updated with dependabot
1 parent ea596aa commit 34f4ad3

File tree

4 files changed

+54
-20
lines changed

4 files changed

+54
-20
lines changed

Diff for: .gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -51,3 +51,5 @@ atlassian-ide-plugin.xml
5151
.vscode/
5252

5353
cached-antora-playbook.yml
54+
55+
node_modules

Diff for: framework-docs/antora-playbook.yml

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
antora:
2+
extensions:
3+
- require: '@springio/antora-extensions'
4+
root_component_name: 'framework'
5+
site:
6+
title: Spring Framework
7+
url: https://docs.spring.io/spring-framework/reference
8+
robots: allow
9+
git:
10+
ensure_git_suffix: false
11+
content:
12+
sources:
13+
- url: https://github.com/spring-projects/spring-framework
14+
# Refname matching:
15+
# https://docs.antora.org/antora/latest/playbook/content-refname-matching/
16+
branches: ['main', '{6..9}.+({0..9}).x']
17+
tags: ['v{6..9}.+({0..9}).+({0..9})?(-{RC,M}*)', '!(v6.0.{0..8})', '!(v6.0.0-{RC,M}{0..9})']
18+
start_path: framework-docs
19+
asciidoc:
20+
extensions:
21+
- '@asciidoctor/tabs'
22+
- '@springio/asciidoctor-extensions'
23+
- '@springio/asciidoctor-extensions/include-code-extension'
24+
attributes:
25+
page-stackoverflow-url: https://stackoverflow.com/questions/tagged/spring
26+
page-pagination: ''
27+
hide-uri-scheme: '@'
28+
tabs-sync-option: '@'
29+
include-java: 'example$docs-src/main/java/org/springframework/docs'
30+
urls:
31+
latest_version_segment_strategy: redirect:to
32+
latest_version_segment: ''
33+
redirect_facility: httpd
34+
runtime:
35+
log:
36+
failure_level: warn
37+
ui:
38+
bundle:
39+
url: https://github.com/spring-io/antora-ui-spring/releases/download/v0.4.15/ui-bundle.zip

Diff for: framework-docs/framework-docs.gradle

+3-20
Original file line numberDiff line numberDiff line change
@@ -10,27 +10,10 @@ apply from: "${rootDir}/gradle/ide.gradle"
1010
apply from: "${rootDir}/gradle/publications.gradle"
1111

1212
antora {
13-
version = '3.2.0-alpha.2'
14-
playbook = 'cached-antora-playbook.yml'
15-
playbookProvider {
16-
repository = 'spring-projects/spring-framework'
17-
branch = 'docs-build'
18-
path = 'lib/antora/templates/per-branch-antora-playbook.yml'
19-
checkLocalBranch = true
20-
}
21-
options = ['--clean', '--stacktrace']
13+
options = [clean: true, fetch: !project.gradle.startParameter.offline, stacktrace: true]
2214
environment = [
23-
'ALGOLIA_API_KEY': '82c7ead946afbac3cf98c32446154691',
24-
'ALGOLIA_APP_ID': '244V8V9FGG',
25-
'ALGOLIA_INDEX_NAME': 'framework-docs'
26-
]
27-
dependencies = [
28-
'@antora/atlas-extension': '1.0.0-alpha.1',
29-
'@antora/collector-extension': '1.0.0-alpha.3',
30-
'@asciidoctor/tabs': '1.0.0-beta.3',
31-
'@opendevise/antora-release-line-extension': '1.0.0',
32-
'@springio/antora-extensions': '1.8.2',
33-
'@springio/asciidoctor-extensions': '1.0.0-alpha.9'
15+
'BUILD_REFNAME': 'HEAD',
16+
'BUILD_VERSION': project.version,
3417
]
3518
}
3619

Diff for: framework-docs/package.json

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
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+
"@asciidoctor/tabs": "1.0.0-beta.6",
7+
"@springio/antora-extensions": "1.11.1",
8+
"@springio/asciidoctor-extensions": "1.0.0-alpha.10"
9+
}
10+
}

0 commit comments

Comments
 (0)