fix it
This commit is contained in:
committed by
Rossen Stoyanchev
parent
6901f41c33
commit
bb9aaaddc8
@@ -1,36 +1,43 @@
|
||||
# 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:
|
||||
- '@springio/antora-extensions/partial-build-extension'
|
||||
# - require: '@springio/antora-extensions/latest-version-extension'
|
||||
- require: '@springio/antora-extensions/inject-collector-cache-config-extension'
|
||||
- '@antora/collector-extension'
|
||||
- '@antora/atlas-extension'
|
||||
- require: '@springio/antora-extensions/tabs-migration-extension'
|
||||
unwrap_example_block: always
|
||||
- require: '@springio/antora-extensions/root-component-extension'
|
||||
root_component_name: 'graphql'
|
||||
site:
|
||||
title: Spring Framework Reference
|
||||
url: https://https://rwinch.github.io/spring-framework/
|
||||
title: Spring GraphQL
|
||||
url: https://rwinch.github.io/spring-graphql
|
||||
robots: allow
|
||||
git:
|
||||
ensure_git_suffix: false
|
||||
content:
|
||||
sources:
|
||||
- url: https://github.com/rwinch/spring-framework
|
||||
branches: ./..
|
||||
start_path: framework-docs
|
||||
worktrees: true
|
||||
- url: ./..
|
||||
branches: HEAD
|
||||
start_path: spring-graphql-docs
|
||||
worktrees: true
|
||||
asciidoc:
|
||||
attributes:
|
||||
page-stackoverflow-url: https://stackoverflow.com/tags/spring-graphql
|
||||
page-pagination: ''
|
||||
hide-uri-scheme: '@'
|
||||
tabs-sync-option: '@'
|
||||
chomp: 'all'
|
||||
extensions:
|
||||
- '@asciidoctor/tabs'
|
||||
- '@springio/asciidoctor-extensions'
|
||||
sourcemap: true
|
||||
urls:
|
||||
latest_version_segment_strategy: redirect:to
|
||||
latest_version_segment: ''
|
||||
runtime:
|
||||
log:
|
||||
failure_level: warn
|
||||
redirect_facility: httpd
|
||||
ui:
|
||||
bundle:
|
||||
url: https://github.com/spring-io/antora-ui-spring/releases/download/latest/ui-bundle.zip
|
||||
snapshot: true
|
||||
url: https://github.com/spring-io/antora-ui-spring/releases/download/v0.3.3/ui-bundle.zip
|
||||
snapshot: true
|
||||
runtime:
|
||||
log:
|
||||
failure_level: warn
|
||||
@@ -1,12 +1,12 @@
|
||||
name: framework
|
||||
name: graphql
|
||||
version: true
|
||||
title: Spring Framework Documentation
|
||||
title: Spring GraphQL
|
||||
nav:
|
||||
- modules/ROOT/nav.adoc
|
||||
ext:
|
||||
collector:
|
||||
run:
|
||||
command: gradlew -q -PbuildSrc.skipTests=true "-Dorg.gradle.jvmargs=-Xmx3g -XX:+HeapDumpOnOutOfMemoryError" :spring-boot-project:spring-boot-docs:generateAntoraResources
|
||||
command: gradlew -q -PbuildSrc.skipTests=true "-Dorg.gradle.jvmargs=-Xmx3g -XX:+HeapDumpOnOutOfMemoryError" :spring-graphql-docs:generateAntoraYml
|
||||
local: true
|
||||
scan:
|
||||
dir: ./build/generated-antora-resources
|
||||
@@ -14,19 +14,4 @@ ext:
|
||||
asciidoc:
|
||||
attributes:
|
||||
attribute-missing: 'warn'
|
||||
# FIXME: the copyright is not removed
|
||||
# FIXME: The package is not renamed
|
||||
chomp: 'all'
|
||||
import-java: 'example$docs-src/main/java/org/springframework/docs'
|
||||
spring-framework-main-code: 'https://github.com/spring-projects/spring-framework/tree/main'
|
||||
docs-site: 'https://docs.spring.io'
|
||||
docs-spring: "{docs-site}/spring-framework/docs/{spring-version}"
|
||||
docs-spring-framework: '{docs_site}/spring-framework/docs/{spring-version}'
|
||||
api-spring-framework: '{docs-spring-framework}/javadoc-api/org/springframework'
|
||||
docs-graalvm: 'https://www.graalvm.org/22.3/reference-manual'
|
||||
docs-spring-boot: '{docs-site}/spring-boot/docs/current/reference'
|
||||
docs-spring-gemfire: '{docs_site}/spring-gemfire/docs/current/reference'
|
||||
docs-spring-security: '{docs_site}/spring-security/reference'
|
||||
gh-rsocket: 'https://github.com/rsocket'
|
||||
gh-rsocket-extensions: '{gh-rsocket}/rsocket/blob/master/Extensions'
|
||||
gh-rsocket-java: '{gh-rsocket}/rsocket-java{gh-rsocket}/rsocket-java'
|
||||
chomp: 'all'
|
||||
@@ -1,6 +1,7 @@
|
||||
plugins {
|
||||
id 'java-library'
|
||||
id 'org.asciidoctor.jvm.convert' version '3.3.2'
|
||||
id 'org.antora' version '1.0.0'
|
||||
id 'io.spring.antora.generate-antora-yml' version '0.0.1'
|
||||
}
|
||||
|
||||
description = "Spring for GraphQL reference documentation"
|
||||
@@ -12,7 +13,6 @@ configurations {
|
||||
visible = false
|
||||
}
|
||||
matching { it.name.endsWith("Classpath") }.all { it.extendsFrom(dependencyManagement) }
|
||||
asciidoctorExtensions
|
||||
}
|
||||
|
||||
dependencies {
|
||||
@@ -25,7 +25,6 @@ dependencies {
|
||||
api 'org.springframework:spring-messaging'
|
||||
api 'org.springframework.data:spring-data-commons'
|
||||
api 'com.querydsl:querydsl-core'
|
||||
asciidoctorExtensions 'io.spring.asciidoctor.backends:spring-asciidoctor-backends:0.0.4'
|
||||
}
|
||||
|
||||
jar {
|
||||
@@ -77,42 +76,42 @@ task api(type: Javadoc) {
|
||||
destinationDir = file("$buildDir/docs/javadoc")
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Generate the Spring for GraphQL Reference documentation from "src/docs/asciidoc"
|
||||
* in "build/docs/reference/html".
|
||||
*/
|
||||
asciidoctor {
|
||||
configurations 'asciidoctorExtensions'
|
||||
baseDirFollowsSourceDir()
|
||||
sources {
|
||||
include 'index.adoc'
|
||||
}
|
||||
logDocuments = true
|
||||
outputOptions {
|
||||
backends "spring-html"
|
||||
}
|
||||
outputDir "$buildDir/docs/reference/html"
|
||||
attributes 'spring-graphql-version': project.version,
|
||||
'spring-boot-version': springBootVersion,
|
||||
'spring-framework-version': springFrameworkVersion
|
||||
antora {
|
||||
options = [clean: true, fetch: !project.gradle.startParameter.offline, stacktrace: true]
|
||||
environment = [
|
||||
'ALGOLIA_API_KEY': '9d489079e5ec46dbb238909fee5c9c29',
|
||||
'ALGOLIA_APP_ID': 'WB1FQYI187',
|
||||
'ALGOLIA_INDEX_NAME': 'springsecurity',
|
||||
]
|
||||
dependencies = [
|
||||
'@antora/atlas-extension': '1.0.0-alpha.1',
|
||||
'@antora/collector-extension': '1.0.0-alpha.3',
|
||||
'@asciidoctor/tabs': '1.0.0-beta.3',
|
||||
'@springio/antora-extensions': '1.4.2',
|
||||
'@springio/asciidoctor-extensions': '1.0.0-alpha.8',
|
||||
]
|
||||
}
|
||||
|
||||
asciidoctor.mustRunAfter "check"
|
||||
tasks.named("generateAntoraYml") {
|
||||
asciidocAttributes = project.provider( { ['spring-graphql-version': project.version,
|
||||
'spring-boot-version': springBootVersion,
|
||||
'spring-framework-version': springFrameworkVersion] } )
|
||||
}
|
||||
|
||||
tasks.named("antora") {
|
||||
mustRunAfter "check"
|
||||
}
|
||||
|
||||
/**
|
||||
* Zip all docs into a single archive
|
||||
*/
|
||||
task docsZip(type: Zip, dependsOn: ['api', 'asciidoctor']) {
|
||||
task docsZip(type: Zip, dependsOn: ['api']) {
|
||||
group = "Distribution"
|
||||
description = "Builds -${archiveClassifier} archive containing api and reference " +
|
||||
"for deployment at https://docs.spring.io/spring-graphql/docs."
|
||||
from (api) {
|
||||
into "api"
|
||||
}
|
||||
from ("$asciidoctor.outputDir") {
|
||||
into "reference/html"
|
||||
}
|
||||
}
|
||||
|
||||
publishing {
|
||||
|
||||
Reference in New Issue
Block a user