Browse Source

Use the shared antora playbook

pull/30430/head
Rob Winch 1 year ago committed by rstoyanchev
parent
commit
88c9b0f467
  1. 2
      .github/workflows/deploy-docs.yml
  2. 2
      .gitignore
  3. 35
      framework-docs/antora-playbook.yml
  4. 16
      framework-docs/framework-docs.gradle

2
.github/workflows/deploy-docs.yml

@ -13,7 +13,7 @@ permissions:
jobs: jobs:
build: build:
runs-on: ubuntu-latest runs-on: ubuntu-latest
# if: github.repository_owner == 'spring-projects' if: github.repository_owner == 'spring-projects'
steps: steps:
- name: Checkout - name: Checkout
uses: actions/checkout@v3 uses: actions/checkout@v3

2
.gitignore vendored

@ -50,3 +50,5 @@ atlassian-ide-plugin.xml
# VS Code # VS Code
.vscode/ .vscode/
cached-antora-playbook.yml

35
framework-docs/antora-playbook.yml

@ -1,35 +0,0 @@
# PACKAGES antora@3.2.0-alpha.2 @antora/atlas-extension:1.0.0-alpha.1 @antora/collector-extension@1.0.0-alpha.3 @springio/antora-extensions@1.1.0-alpha.2 @asciidoctor/tabs@1.0.0-alpha.12 @opendevise/antora-release-line-extension@1.0.0-alpha.2
#
# The purpose of this Antora playbook is to build the docs in the current branch.
antora:
extensions:
- '@antora/collector-extension'
site:
title: Spring Framework Reference
url: https://https://rwinch.github.io/spring-framework/
content:
sources:
- url: ../.
branches: HEAD
start_path: framework-docs
worktrees: true
asciidoc:
attributes:
page-pagination: ''
hide-uri-scheme: '@'
tabs-sync-option: '@'
chomp: 'all'
extensions:
- '@asciidoctor/tabs'
- '@springio/asciidoctor-extensions'
- '@springio/asciidoctor-extensions/include-code-extension'
sourcemap: true
urls:
latest_version_segment: ''
runtime:
log:
failure_level: warn
ui:
bundle:
url: https://github.com/spring-io/antora-ui-spring/releases/download/latest/ui-bundle.zip
snapshot: true

16
framework-docs/framework-docs.gradle

@ -11,13 +11,13 @@ apply from: "${rootDir}/gradle/publications.gradle"
antora { antora {
version = '3.2.0-alpha.2' version = '3.2.0-alpha.2'
playbook = 'antora-playbook.yml' playbook = 'cached-antora-playbook.yml'
// playbookProvider { playbookProvider {
// repository = 'rwinch/spring-framework' repository = 'rwinch/spring-framework'
// branch = 'docs-build' branch = 'docs-build'
// path = 'lib/antora/templates/per-branch-antora-playbook.yml' path = 'lib/antora/templates/per-branch-antora-playbook.yml'
// checkLocalBranch = true checkLocalBranch = true
// } }
options = ['--clean', '--stacktrace'] options = ['--clean', '--stacktrace']
environment = [ environment = [
'ALGOLIA_API_KEY': '82c7ead946afbac3cf98c32446154691', 'ALGOLIA_API_KEY': '82c7ead946afbac3cf98c32446154691',
@ -29,7 +29,7 @@ antora {
'@antora/collector-extension': '1.0.0-alpha.3', '@antora/collector-extension': '1.0.0-alpha.3',
'@asciidoctor/tabs': '1.0.0-beta.3', '@asciidoctor/tabs': '1.0.0-beta.3',
'@opendevise/antora-release-line-extension': '1.0.0-alpha.2', '@opendevise/antora-release-line-extension': '1.0.0-alpha.2',
'@springio/antora-extensions': '1.1.0', '@springio/antora-extensions': '1.3.0',
'@springio/asciidoctor-extensions': '1.0.0-alpha.9' '@springio/asciidoctor-extensions': '1.0.0-alpha.9'
] ]
} }

Loading…
Cancel
Save