spring-security-docs.gradle 4.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798
  1. plugins {
  2. id 'org.antora' version '1.0.0'
  3. id 'io.spring.antora.generate-antora-yml' version '0.0.1'
  4. id 'io.spring.convention.repository'
  5. id 'security-kotlin'
  6. }
  7. apply plugin: 'io.spring.convention.docs'
  8. apply plugin: 'java'
  9. antora {
  10. options = [clean: true, fetch: !project.gradle.startParameter.offline, stacktrace: true]
  11. environment = [
  12. 'BUILD_REFNAME': 'HEAD',
  13. 'BUILD_VERSION': project.version,
  14. ]
  15. }
  16. tasks.register("syncAntoraAttachments", Sync) {
  17. group = 'Documentation'
  18. description = 'Syncs the Antora attachments'
  19. from project.provider( { project.tasks.api.outputs } )
  20. into project.layout.buildDirectory.dir('generated-antora-resources/modules/ROOT/assets/attachments/api/java')
  21. }
  22. tasks.named("generateAntoraYml") {
  23. asciidocAttributes = project.provider( { generateAttributes() } )
  24. asciidocAttributes.putAll(providers.provider( { resolvedVersions(project.configurations.testRuntimeClasspath) }))
  25. }
  26. tasks.register("generateAntoraResources") {
  27. dependsOn 'generateAntoraYml', 'syncAntoraAttachments'
  28. }
  29. dependencies {
  30. testImplementation platform(project(':spring-security-dependencies'))
  31. testImplementation project(':spring-security-config')
  32. testImplementation project(path : ':spring-security-config', configuration : 'tests')
  33. testImplementation project(':spring-security-test')
  34. testImplementation project(':spring-security-oauth2-client')
  35. testImplementation 'com.squareup.okhttp3:mockwebserver'
  36. testImplementation libs.com.password4j.password4j
  37. testImplementation 'com.unboundid:unboundid-ldapsdk'
  38. testImplementation libs.webauthn4j.core
  39. testImplementation 'org.jetbrains.kotlin:kotlin-reflect'
  40. testImplementation 'org.jetbrains.kotlin:kotlin-stdlib-jdk8'
  41. testImplementation 'org.springframework:spring-core'
  42. testImplementation 'org.springframework:spring-test'
  43. testImplementation 'org.springframework:spring-webmvc'
  44. testImplementation 'jakarta.servlet:jakarta.servlet-api'
  45. testImplementation 'io.mockk:mockk'
  46. testImplementation "org.junit.jupiter:junit-jupiter-api"
  47. testImplementation "org.junit.jupiter:junit-jupiter-params"
  48. testImplementation "org.junit.jupiter:junit-jupiter-engine"
  49. testRuntimeOnly 'org.junit.platform:junit-platform-launcher'
  50. }
  51. def generateAttributes() {
  52. def springFrameworkVersion = libs.org.springframework.spring.framework.bom.get().versionConstraint.displayName
  53. def springBootVersion = project.property("springBootVersion")
  54. def samplesBranch = project.property("samplesBranch")
  55. def docsTag = snapshotBuild ? 'current' : project.version
  56. def ghTag = snapshotBuild ? 'main' : project.version
  57. def ghUrl = "https://github.com/spring-projects/spring-security/tree/$ghTag"
  58. def ghOldSamplesUrl = 'https://github.com/spring-projects/spring-security/tree/5.4.x/samples'
  59. def ghSamplesUrl = "https://github.com/spring-projects/spring-security-samples/tree/$samplesBranch"
  60. def securityDocsUrl = "https://docs.spring.io/spring-security/site/docs/$docsTag"
  61. def securityApiUrl = "$securityDocsUrl/api/"
  62. def securityReferenceUrl = "$securityDocsUrl/reference/html5/"
  63. def springFrameworkApiUrl = "https://docs.spring.io/spring-framework/docs/$springFrameworkVersion/javadoc-api/"
  64. def springFrameworkReferenceUrl = "https://docs.spring.io/spring-framework/reference/$springFrameworkVersion/"
  65. def springBootReferenceUrl = "https://docs.spring.io/spring-boot/$springBootVersion/"
  66. def springBootApiUrl = "https://docs.spring.io/spring-boot/$springBootVersion/api/java/"
  67. return ['gh-old-samples-url': ghOldSamplesUrl.toString(),
  68. 'gh-samples-url': ghSamplesUrl.toString(),
  69. 'gh-url': ghUrl.toString(),
  70. 'security-api-url': securityApiUrl.toString(),
  71. 'security-reference-url': securityReferenceUrl.toString(),
  72. 'spring-framework-api-url': springFrameworkApiUrl.toString(),
  73. 'spring-framework-reference-url': springFrameworkReferenceUrl.toString(),
  74. 'spring-boot-api-url': springBootApiUrl.toString(),
  75. 'spring-boot-reference-url': springBootReferenceUrl.toString(),
  76. 'spring-security-version': project.version]
  77. + resolvedVersions(project.configurations.testRuntimeClasspath)
  78. }
  79. def resolvedVersions(Configuration configuration) {
  80. return configuration.resolvedConfiguration
  81. .resolvedArtifacts
  82. .collectEntries { [(it.name + '-version'): it.moduleVersion.id.version] }
  83. }
  84. test {
  85. useJUnitPlatform()
  86. }