From 0fecaf492419a78b58ad91a86953b74fc6e19b31 Mon Sep 17 00:00:00 2001 From: Rob Winch <362503+rwinch@users.noreply.github.com> Date: Thu, 22 May 2025 14:47:37 -0500 Subject: [PATCH] Add include-code extension setup for docs Closes gh-17160 --- docs/antora.yml | 2 ++ docs/modules/ROOT/examples/docs-src | 1 + docs/spring-security-docs.gradle | 29 +++++++++++++++++++++++++++++ 3 files changed, 32 insertions(+) create mode 120000 docs/modules/ROOT/examples/docs-src diff --git a/docs/antora.yml b/docs/antora.yml index 571640b91d..02262db72e 100644 --- a/docs/antora.yml +++ b/docs/antora.yml @@ -16,3 +16,5 @@ asciidoc: gh-old-samples-url: 'https://github.com/spring-projects/spring-security/tree/5.4.x/samples' gh-samples-url: "https://github.com/spring-projects/spring-security-samples/tree/{gh-tag}" gh-url: "https://github.com/spring-projects/spring-security/tree/{gh-tag}" + include-java: 'example$docs-src/test/java/org/springframework/security/docs' + include-kotlin: 'example$docs-src/test/kotlin/org/springframework/security/kt/docs' diff --git a/docs/modules/ROOT/examples/docs-src b/docs/modules/ROOT/examples/docs-src new file mode 120000 index 0000000000..dabb0e15a9 --- /dev/null +++ b/docs/modules/ROOT/examples/docs-src @@ -0,0 +1 @@ +../../../src \ No newline at end of file diff --git a/docs/spring-security-docs.gradle b/docs/spring-security-docs.gradle index 0a1f98e022..ec459fc115 100644 --- a/docs/spring-security-docs.gradle +++ b/docs/spring-security-docs.gradle @@ -1,7 +1,10 @@ +import org.jetbrains.kotlin.gradle.tasks.KotlinCompile + plugins { id 'org.antora' version '1.0.0' id 'io.spring.antora.generate-antora-yml' version '0.0.1' id 'io.spring.convention.repository' + id 'kotlin' } apply plugin: 'io.spring.convention.docs' @@ -33,10 +36,23 @@ tasks.register("generateAntoraResources") { dependencies { testImplementation platform(project(':spring-security-dependencies')) + testImplementation project(':spring-security-config') + testImplementation project(path : ':spring-security-config', configuration : 'tests') + testImplementation project(':spring-security-test') testImplementation 'com.unboundid:unboundid-ldapsdk' testImplementation libs.webauthn4j.core + testImplementation 'org.jetbrains.kotlin:kotlin-reflect' + testImplementation 'org.jetbrains.kotlin:kotlin-stdlib-jdk8' testImplementation 'org.apache.directory.server:apacheds-core' testImplementation 'org.springframework:spring-core' + testImplementation 'org.springframework:spring-test' + + testImplementation 'org.springframework:spring-webmvc' + testImplementation 'jakarta.servlet:jakarta.servlet-api' + testImplementation "org.junit.jupiter:junit-jupiter-api" + testImplementation "org.junit.jupiter:junit-jupiter-params" + testImplementation "org.junit.jupiter:junit-jupiter-engine" + testRuntimeOnly 'org.junit.platform:junit-platform-launcher' } def generateAttributes() { @@ -78,3 +94,16 @@ def resolvedVersions(Configuration configuration) { .resolvedArtifacts .collectEntries { [(it.name + '-version'): it.moduleVersion.id.version] } } + +test { + useJUnitPlatform() +} + +tasks.withType(KotlinCompile).configureEach { + kotlinOptions { + languageVersion = "1.7" + apiVersion = "1.7" + freeCompilerArgs = ["-Xjsr305=strict", "-Xsuppress-version-warnings"] + jvmTarget = "17" + } +}