spring-security-docs.gradle 2.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768
  1. apply plugin: 'io.spring.convention.docs'
  2. apply plugin: 'java'
  3. tasks.register("generateAntora") {
  4. group = "Documentation"
  5. description = "Generates the antora.yml for dynamic properties"
  6. doLast {
  7. def docsTag = snapshotBuild ? 'current' : project.version
  8. def ghTag = snapshotBuild ? 'main' : project.version
  9. def ghUrl = "https://github.com/spring-projects/spring-security/tree/$ghTag"
  10. def ghOldSamplesUrl = "https://github.com/spring-projects/spring-security/tree/5.4.x/samples"
  11. def ghSamplesUrl = "https://github.com/spring-projects/spring-security-samples/tree/$samplesBranch"
  12. def securityDocsUrl = "https://docs.spring.io/spring-security/site/docs/$docsTag"
  13. def securityApiUrl = "$securityDocsUrl/api/"
  14. def securityReferenceUrl = "$securityDocsUrl/reference/html5/"
  15. def springFrameworkApiUrl = "https://docs.spring.io/spring-framework/docs/$springFrameworkVersion/javadoc-api/"
  16. def springFrameworkReferenceUrl = "https://docs.spring.io/spring-framework/docs/$springFrameworkVersion/reference/html/"
  17. def versions = resolvedVersions(project.configurations.testRuntimeClasspath)
  18. def ymlVersions = ""
  19. versions.call().each { name, version ->
  20. ymlVersions += """
  21. ${name}: ${version}"""
  22. }
  23. def outputFile = new File("$buildDir/generateAntora/antora.yml")
  24. outputFile.getParentFile().mkdirs()
  25. outputFile.createNewFile()
  26. outputFile.setText("""name: ''
  27. title: Spring Security
  28. version: ~
  29. display_version: 5.6
  30. start_page: ROOT:index.adoc
  31. asciidoc:
  32. attributes:
  33. icondir: icons
  34. gh-old-samples-url: $ghOldSamplesUrl
  35. gh-samples-url: $ghSamplesUrl
  36. gh-url: $ghUrl
  37. security-api-url: $securityApiUrl
  38. security-reference-url: $securityReferenceUrl
  39. spring-framework-api-url: $springFrameworkApiUrl
  40. spring-framework-reference-url: $springFrameworkReferenceUrl
  41. spring-security-version: ${project.version}
  42. ${ymlVersions}
  43. """)
  44. }
  45. }
  46. dependencies {
  47. testImplementation platform(project(":spring-security-dependencies"))
  48. testImplementation "com.unboundid:unboundid-ldapsdk"
  49. testImplementation "org.apache.directory.server:apacheds-core"
  50. testImplementation "org.springframework:spring-core"
  51. }
  52. def resolvedVersions(Configuration configuration) {
  53. return {
  54. configuration.resolvedConfiguration
  55. .resolvedArtifacts
  56. .collectEntries { [(it.name + "-version"): it.moduleVersion.id.version] }
  57. }
  58. }
  59. repositories {
  60. mavenCentral()
  61. maven { url "https://repo.spring.io/release" }
  62. maven { url "https://repo.spring.io/milestone" }
  63. maven { url "https://repo.spring.io/snapshot" }
  64. }