spring-security-docs.gradle 2.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667
  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: ROOT
  27. title: Spring Security
  28. version: 5.6
  29. start_page: ROOT:index.adoc
  30. asciidoc:
  31. attributes:
  32. icondir: icons
  33. gh-old-samples-url: $ghOldSamplesUrl
  34. gh-samples-url: $ghSamplesUrl
  35. gh-url: $ghUrl
  36. security-api-url: $securityApiUrl
  37. security-reference-url: $securityReferenceUrl
  38. spring-framework-api-url: $springFrameworkApiUrl
  39. spring-framework-reference-url: $springFrameworkReferenceUrl
  40. spring-security-version: ${project.version}
  41. ${ymlVersions}
  42. """)
  43. }
  44. }
  45. dependencies {
  46. testImplementation platform(project(":spring-security-dependencies"))
  47. testImplementation "com.unboundid:unboundid-ldapsdk"
  48. testImplementation "org.apache.directory.server:apacheds-core"
  49. testImplementation "org.springframework:spring-core"
  50. }
  51. def resolvedVersions(Configuration configuration) {
  52. return {
  53. configuration.resolvedConfiguration
  54. .resolvedArtifacts
  55. .collectEntries { [(it.name + "-version"): it.moduleVersion.id.version] }
  56. }
  57. }
  58. repositories {
  59. mavenCentral()
  60. maven { url "https://repo.spring.io/release" }
  61. maven { url "https://repo.spring.io/milestone" }
  62. maven { url "https://repo.spring.io/snapshot" }
  63. }