Skip to content

Commit 4167558

Browse files
rwinchsdeleuze
authored andcommitted
Modernize Antora Build
- Use package.json so dependabot can automatically update JS dependencies - Use @springio/antora-extensions (automatically apply default extensions in proper order) - Leverage set-algolia-env-extension to manage algolia env variables - Update to latest ui Closes spring-projectsgh-32863
1 parent b14a201 commit 4167558

File tree

4 files changed

+14
-25
lines changed

4 files changed

+14
-25
lines changed

Diff for: .gitignore

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

5454
cached-antora-playbook.yml
55+
56+
node_modules

Diff for: antora-playbook.yml

+2-10
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,7 @@
11
antora:
22
extensions:
3-
- '@springio/antora-extensions/partial-build-extension'
4-
# atlas-extension must be before latest-version-extension so latest versions are applied to imported versions
5-
- '@antora/atlas-extension'
6-
- require: '@springio/antora-extensions/latest-version-extension'
7-
- require: '@springio/antora-extensions/inject-collector-cache-config-extension'
8-
- '@antora/collector-extension'
9-
- require: '@springio/antora-extensions/root-component-extension'
3+
- require: '@springio/antora-extensions'
104
root_component_name: 'framework'
11-
- '@springio/antora-extensions/static-page-extension'
125
site:
136
title: Spring Framework
147
url: https://docs.spring.io/spring-framework/reference
@@ -43,5 +36,4 @@ runtime:
4336
failure_level: warn
4437
ui:
4538
bundle:
46-
url: https://github.com/spring-io/antora-ui-spring/releases/download/v0.4.13/ui-bundle.zip
47-
snapshot: true
39+
url: https://github.com/spring-io/antora-ui-spring/releases/download/v0.4.15/ui-bundle.zip

Diff for: build.gradle

-15
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,5 @@ plugins {
44
}
55

66
antora {
7-
version = '3.2.0-alpha.2'
87
options = [clean: true, fetch: true, stacktrace: true]
9-
environment = [
10-
'ALGOLIA_API_KEY': '042f6aaab6ce998d2ea29e60167e1660',
11-
'ALGOLIA_APP_ID': 'WB1FQYI187',
12-
'ALGOLIA_INDEX_NAME': 'springdocs'
13-
]
14-
// NOTE remember to update the versions in lib/antora/templates/per-branch-antora-playbook.yml as well
15-
dependencies = [
16-
'@antora/atlas-extension': '1.0.0-alpha.1',
17-
'@antora/collector-extension': '1.0.0-alpha.3',
18-
'@asciidoctor/tabs': '1.0.0-beta.3',
19-
'@opendevise/antora-release-line-extension': '1.0.0',
20-
'@springio/antora-extensions': '1.8.2',
21-
'@springio/asciidoctor-extensions': '1.0.0-alpha.10',
22-
]
238
}

Diff for: 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)