Browse Source

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 gh-32863
pull/32893/head
Rob Winch 2 years ago committed by Sébastien Deleuze
parent
commit
41675587ea
  1. 2
      .gitignore
  2. 12
      antora-playbook.yml
  3. 15
      build.gradle
  4. 10
      package.json

2
.gitignore vendored

@ -52,3 +52,5 @@ atlassian-ide-plugin.xml
.vscode/ .vscode/
cached-antora-playbook.yml cached-antora-playbook.yml
node_modules

12
antora-playbook.yml

@ -1,14 +1,7 @@
antora: antora:
extensions: extensions:
- '@springio/antora-extensions/partial-build-extension' - require: '@springio/antora-extensions'
# atlas-extension must be before latest-version-extension so latest versions are applied to imported versions
- '@antora/atlas-extension'
- require: '@springio/antora-extensions/latest-version-extension'
- require: '@springio/antora-extensions/inject-collector-cache-config-extension'
- '@antora/collector-extension'
- require: '@springio/antora-extensions/root-component-extension'
root_component_name: 'framework' root_component_name: 'framework'
- '@springio/antora-extensions/static-page-extension'
site: site:
title: Spring Framework title: Spring Framework
url: https://docs.spring.io/spring-framework/reference url: https://docs.spring.io/spring-framework/reference
@ -43,5 +36,4 @@ runtime:
failure_level: warn failure_level: warn
ui: ui:
bundle: bundle:
url: https://github.com/spring-io/antora-ui-spring/releases/download/v0.4.13/ui-bundle.zip url: https://github.com/spring-io/antora-ui-spring/releases/download/v0.4.15/ui-bundle.zip
snapshot: true

15
build.gradle

@ -4,20 +4,5 @@ plugins {
} }
antora { antora {
version = '3.2.0-alpha.2'
options = [clean: true, fetch: true, stacktrace: true] options = [clean: true, fetch: true, stacktrace: true]
environment = [
'ALGOLIA_API_KEY': '042f6aaab6ce998d2ea29e60167e1660',
'ALGOLIA_APP_ID': 'WB1FQYI187',
'ALGOLIA_INDEX_NAME': 'springdocs'
]
// NOTE remember to update the versions in lib/antora/templates/per-branch-antora-playbook.yml as well
dependencies = [
'@antora/atlas-extension': '1.0.0-alpha.1',
'@antora/collector-extension': '1.0.0-alpha.3',
'@asciidoctor/tabs': '1.0.0-beta.3',
'@opendevise/antora-release-line-extension': '1.0.0',
'@springio/antora-extensions': '1.8.2',
'@springio/asciidoctor-extensions': '1.0.0-alpha.10',
]
} }

10
package.json

@ -0,0 +1,10 @@
{
"dependencies": {
"antora": "3.2.0-alpha.4",
"@antora/atlas-extension": "1.0.0-alpha.2",
"@antora/collector-extension": "1.0.0-alpha.3",
"@asciidoctor/tabs": "1.0.0-beta.6",
"@springio/antora-extensions": "1.11.1",
"@springio/asciidoctor-extensions": "1.0.0-alpha.10"
}
}
Loading…
Cancel
Save