spring-security-docs.gradle 2.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
  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. }
  6. apply plugin: 'io.spring.convention.docs'
  7. apply plugin: 'java'
  8. antora {
  9. options = [clean: true, fetch: !project.gradle.startParameter.offline, stacktrace: true]
  10. environment = [
  11. 'BUILD_REFNAME': 'HEAD',
  12. 'BUILD_VERSION': project.version,
  13. ]
  14. }
  15. tasks.named("generateAntoraYml") {
  16. asciidocAttributes = project.provider( { generateAttributes() } )
  17. asciidocAttributes.putAll(providers.provider( { resolvedVersions(project.configurations.testRuntimeClasspath) }))
  18. }
  19. dependencies {
  20. testImplementation platform(project(':spring-security-dependencies'))
  21. testImplementation 'com.unboundid:unboundid-ldapsdk'
  22. testImplementation 'org.apache.directory.server:apacheds-core'
  23. testImplementation 'org.springframework:spring-core'
  24. }
  25. def generateAttributes() {
  26. def springFrameworkVersion = libs.org.springframework.spring.framework.bom.get().versionConstraint.displayName
  27. springFrameworkVersion = springFrameworkVersion.contains("-")
  28. ? springFrameworkVersion.substring(0, springFrameworkVersion.indexOf("-"))
  29. : springFrameworkVersion
  30. def springBootVersion = project.property("springBootVersion")
  31. def samplesBranch = project.property("samplesBranch")
  32. def docsTag = snapshotBuild ? 'current' : project.version
  33. def ghTag = snapshotBuild ? 'main' : project.version
  34. def ghUrl = "https://github.com/spring-projects/spring-security/tree/$ghTag"
  35. def ghOldSamplesUrl = 'https://github.com/spring-projects/spring-security/tree/5.4.x/samples'
  36. def ghSamplesUrl = "https://github.com/spring-projects/spring-security-samples/tree/$samplesBranch"
  37. def securityDocsUrl = "https://docs.spring.io/spring-security/site/docs/$docsTag"
  38. def securityApiUrl = "$securityDocsUrl/api/"
  39. def securityReferenceUrl = "$securityDocsUrl/reference/html5/"
  40. def springFrameworkApiUrl = "https://docs.spring.io/spring-framework/docs/$springFrameworkVersion/javadoc-api/"
  41. def springFrameworkReferenceUrl = "https://docs.spring.io/spring-framework/docs/$springFrameworkVersion/reference/html/"
  42. def springBootReferenceUrl = "https://docs.spring.io/spring-boot/docs/$springBootVersion/reference/html/"
  43. return ['gh-old-samples-url': ghOldSamplesUrl.toString(),
  44. 'gh-samples-url': ghSamplesUrl.toString(),
  45. 'gh-url': ghUrl.toString(),
  46. 'security-api-url': securityApiUrl.toString(),
  47. 'security-reference-url': securityReferenceUrl.toString(),
  48. 'spring-framework-api-url': springFrameworkApiUrl.toString(),
  49. 'spring-framework-reference-url': springFrameworkReferenceUrl.toString(),
  50. 'spring-boot-reference-url': springBootReferenceUrl.toString(),
  51. 'spring-security-version': project.version]
  52. + resolvedVersions(project.configurations.testRuntimeClasspath)
  53. }
  54. def resolvedVersions(Configuration configuration) {
  55. return configuration.resolvedConfiguration
  56. .resolvedArtifacts
  57. .collectEntries { [(it.name + '-version'): it.moduleVersion.id.version] }
  58. }