spring-security-docs.gradle 3.0 KB

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