spring-security-docs.gradle 2.7 KB

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