From 22ffa833cae5842505311350db2ddf97ca095e58 Mon Sep 17 00:00:00 2001 From: Dan Allen Date: Wed, 11 Jan 2023 01:02:10 -0700 Subject: [PATCH] upgrade Antora plugin and configure playbook provider to support local build --- docs/.gitignore | 3 +-- docs/local-antora-playbook.yml | 23 ----------------------- docs/spring-security-docs.gradle | 21 +++++++++------------ 3 files changed, 10 insertions(+), 37 deletions(-) delete mode 100644 docs/local-antora-playbook.yml diff --git a/docs/.gitignore b/docs/.gitignore index 515f5c441d..b1c15f3b18 100644 --- a/docs/.gitignore +++ b/docs/.gitignore @@ -1,2 +1 @@ -/package-lock.json -/node_modules/ +/*-antora-playbook.yml diff --git a/docs/local-antora-playbook.yml b/docs/local-antora-playbook.yml deleted file mode 100644 index b58142e2eb..0000000000 --- a/docs/local-antora-playbook.yml +++ /dev/null @@ -1,23 +0,0 @@ -# The purpose of this Antora playbook is to generate a preview of the docs in the current branch. -antora: - extensions: - - '@antora/collector-extension' -site: - title: Spring Security - url: https://docs.spring.io/spring-security/reference -content: - sources: - - url: ./.. - branches: HEAD - start_path: docs - worktrees: true -asciidoc: - attributes: - page-pagination: '' - hide-uri-scheme: '@' -urls: - latest_version_segment: '' -ui: - bundle: - url: https://github.com/spring-io/antora-ui-spring/releases/download/latest/ui-bundle.zip - snapshot: true diff --git a/docs/spring-security-docs.gradle b/docs/spring-security-docs.gradle index 2ec3e11365..374298415b 100644 --- a/docs/spring-security-docs.gradle +++ b/docs/spring-security-docs.gradle @@ -1,22 +1,19 @@ plugins { - id 'org.antora' version '1.0.0-alpha.3' + id 'org.antora' version '1.0.0-alpha.7' } apply plugin: 'io.spring.convention.docs' apply plugin: 'java' antora { - version = '3.2.0-alpha.2' - playbook = file('local-antora-playbook.yml') - options = ['--clean', '--stacktrace'] - environment = [ - 'ALGOLIA_API_KEY': '82c7ead946afbac3cf98c32446154691', - 'ALGOLIA_APP_ID': '244V8V9FGG', - 'ALGOLIA_INDEX_NAME': 'security-docs' - ] - dependencies = [ - '@antora/collector-extension': '1.0.0-alpha.3' - ] + playbook = 'cached-antora-playbook.yml' + playbookProvider { + repository = 'spring-projects/spring-security' + branch = 'docs-build' + path = 'lib/antora/templates/per-branch-antora-playbook.yml' + checkLocalBranch = true + } + options = [clean: true, stacktrace: true] } tasks.register('generateAntora') {