spring-security-docs.gradle 2.8 KB

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