From e157700087555f8a99449bb819e8f3a42d81e3d8 Mon Sep 17 00:00:00 2001 From: Eleftheria Stein Date: Fri, 11 Mar 2022 15:46:19 +0100 Subject: [PATCH] Update to Antora 3.0.1 Closes gh-2038 --- spring-session-docs/antora-playbook.yml | 3 +- .../antora/extensions/major-minor-segment.js | 6 +-- .../antora/extensions/root-component-name.js | 40 ------------------- .../antora/extensions/version-fix.js | 4 +- spring-session-docs/local-antora-playbook.yml | 4 +- .../spring-session-docs.gradle | 2 +- 6 files changed, 9 insertions(+), 50 deletions(-) delete mode 100644 spring-session-docs/antora/extensions/root-component-name.js diff --git a/spring-session-docs/antora-playbook.yml b/spring-session-docs/antora-playbook.yml index 2b22ab71..2c835d2f 100644 --- a/spring-session-docs/antora-playbook.yml +++ b/spring-session-docs/antora-playbook.yml @@ -20,8 +20,7 @@ ui: url: https://github.com/spring-io/antora-ui-spring/releases/download/latest/ui-bundle.zip snapshot: true -pipeline: +antora: extensions: - require: ./antora/extensions/version-fix.js - require: ./antora/extensions/major-minor-segment.js - - require: ./antora/extensions/root-component-name.js diff --git a/spring-session-docs/antora/extensions/major-minor-segment.js b/spring-session-docs/antora/extensions/major-minor-segment.js index eec07645..3c3761f9 100644 --- a/spring-session-docs/antora/extensions/major-minor-segment.js +++ b/spring-session-docs/antora/extensions/major-minor-segment.js @@ -3,8 +3,8 @@ const { posix: path } = require('path') -module.exports.register = (pipeline, { config }) => { - pipeline.on('contentClassified', ({ contentCatalog }) => { +module.exports.register = function({ config }) { + this.on('contentClassified', ({ contentCatalog }) => { contentCatalog.getComponents().forEach(component => { const componentName = component.name; const generationToVersion = new Map(); @@ -197,4 +197,4 @@ function no_data(key, value) { return value ? "__data__" : value; } return value; -} \ No newline at end of file +} diff --git a/spring-session-docs/antora/extensions/root-component-name.js b/spring-session-docs/antora/extensions/root-component-name.js deleted file mode 100644 index dcc8dc48..00000000 --- a/spring-session-docs/antora/extensions/root-component-name.js +++ /dev/null @@ -1,40 +0,0 @@ -// https://gitlab.com/antora/antora/-/issues/132#note_712132072 -'use strict' - -const { posix: path } = require('path') - -module.exports.register = (pipeline, { config }) => { - pipeline.on('contentClassified', ({ contentCatalog }) => { - const rootComponentName = config.rootComponentName || 'ROOT' - const rootComponentNameLength = rootComponentName.length - contentCatalog.findBy({ component: rootComponentName }).forEach((file) => { - if (file.out) { - file.out.dirname = file.out.dirname.substr(rootComponentNameLength) - file.out.path = file.out.path.substr(rootComponentNameLength + 1) - file.out.rootPath = fixPath(file.out.rootPath) - } - if (file.pub) { - file.pub.url = file.pub.url.substr(rootComponentNameLength + 1) - if (file.pub.rootPath) { - file.pub.rootPath = fixPath(file.pub.rootPath) - } - } - if (file.rel) { - if (file.rel.pub) { - file.rel.pub.url = file.rel.pub.url.substr(rootComponentNameLength + 1) - file.rel.pub.rootPath = fixPath(file.rel.pub.rootPath); - } - } - }) - const rootComponent = contentCatalog.getComponent(rootComponentName) - rootComponent?.versions?.forEach((version) => { - version.url = version.url.substr(rootComponentName.length + 1) - }) - // const siteStartPage = contentCatalog.getById({ component: '', version: '', module: '', family: 'alias', relative: 'index.adoc' }) - // if (siteStartPage) delete siteStartPage.out - }) - - function fixPath(path) { - return path.split('/').slice(1).join('/') || '.' - } -} \ No newline at end of file diff --git a/spring-session-docs/antora/extensions/version-fix.js b/spring-session-docs/antora/extensions/version-fix.js index 4b78ba79..19e77b88 100644 --- a/spring-session-docs/antora/extensions/version-fix.js +++ b/spring-session-docs/antora/extensions/version-fix.js @@ -1,8 +1,8 @@ 'use strict' -module.exports.register = (pipeline, { config }) => { +module.exports.register = function({ config }) { - pipeline.on('contentAggregated', ({ contentAggregate }) => { + this.on('contentAggregated', ({ contentAggregate }) => { contentAggregate.forEach(aggregate => { if (aggregate.version === "2.6.2" && aggregate.prerelease == "-SNAPSHOT") { diff --git a/spring-session-docs/local-antora-playbook.yml b/spring-session-docs/local-antora-playbook.yml index 159543f4..d36554ec 100644 --- a/spring-session-docs/local-antora-playbook.yml +++ b/spring-session-docs/local-antora-playbook.yml @@ -20,7 +20,7 @@ ui: url: https://github.com/spring-io/antora-ui-spring/releases/download/latest/ui-bundle.zip snapshot: true -pipeline: +antora: extensions: + - require: ./antora/extensions/version-fix.js - require: ./antora/extensions/major-minor-segment.js - - require: ./antora/extensions/root-component-name.js diff --git a/spring-session-docs/spring-session-docs.gradle b/spring-session-docs/spring-session-docs.gradle index 405c2b8a..f35292f0 100644 --- a/spring-session-docs/spring-session-docs.gradle +++ b/spring-session-docs/spring-session-docs.gradle @@ -29,7 +29,7 @@ dependencies { } antora { - antoraVersion = "3.0.0-alpha.8" + antoraVersion = "3.0.1" arguments = ["--fetch"] }