| 
									
										
										
										
											2021-11-08 13:35:57 -06:00
										 |  |  | plugins { | 
					
						
							| 
									
										
										
										
											2023-01-26 19:58:23 -07:00
										 |  |  | 	id 'org.antora' version '1.0.0' | 
					
						
							| 
									
										
										
										
											2023-01-17 17:05:55 -06:00
										 |  |  | 	id 'io.spring.antora.generate-antora-yml' version '0.0.1' | 
					
						
							| 
									
										
										
										
											2023-07-24 14:00:33 -05:00
										 |  |  | 	id 'io.spring.convention.repository' | 
					
						
							| 
									
										
										
										
											2021-11-08 13:35:57 -06:00
										 |  |  | } | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2021-09-02 14:38:19 -05:00
										 |  |  | apply plugin: 'io.spring.convention.docs' | 
					
						
							| 
									
										
										
										
											2021-08-20 17:08:39 -05:00
										 |  |  | apply plugin: 'java' | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2021-11-08 13:35:57 -06:00
										 |  |  | antora { | 
					
						
							| 
									
										
										
										
											2023-01-17 10:36:17 -07:00
										 |  |  | 	options = [clean: true, fetch: !project.gradle.startParameter.offline, stacktrace: true] | 
					
						
							| 
									
										
										
										
											2024-04-19 14:15:49 -05:00
										 |  |  | 	environment = [ | 
					
						
							|  |  |  | 		'BUILD_REFNAME': 'HEAD', | 
					
						
							|  |  |  | 		'BUILD_VERSION': project.version, | 
					
						
							|  |  |  | 	] | 
					
						
							| 
									
										
										
										
											2021-11-08 13:35:57 -06:00
										 |  |  | } | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2024-07-09 13:23:24 -05:00
										 |  |  | tasks.register("syncAntoraAttachments", Sync) { | 
					
						
							|  |  |  | 	group = 'Documentation' | 
					
						
							|  |  |  | 	description = 'Syncs the Antora attachments' | 
					
						
							|  |  |  | 	from project.provider( { project.tasks.api.outputs } ) | 
					
						
							|  |  |  | 	into project.layout.buildDirectory.dir('generated-antora-resources/modules/ROOT/assets/attachments/api/java') | 
					
						
							|  |  |  | } | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2023-01-17 17:05:55 -06:00
										 |  |  | tasks.named("generateAntoraYml") { | 
					
						
							|  |  |  | 	asciidocAttributes = project.provider( { generateAttributes() } ) | 
					
						
							|  |  |  | 	asciidocAttributes.putAll(providers.provider( { resolvedVersions(project.configurations.testRuntimeClasspath) })) | 
					
						
							| 
									
										
										
										
											2021-08-20 17:08:39 -05:00
										 |  |  | } | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2024-07-09 13:23:24 -05:00
										 |  |  | tasks.register("generateAntoraResources") { | 
					
						
							|  |  |  | 	dependsOn 'generateAntoraYml', 'syncAntoraAttachments' | 
					
						
							|  |  |  | } | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2021-08-20 17:08:39 -05:00
										 |  |  | dependencies { | 
					
						
							| 
									
										
										
										
											2022-09-26 14:54:14 -06:00
										 |  |  | 	testImplementation platform(project(':spring-security-dependencies')) | 
					
						
							|  |  |  | 	testImplementation 'com.unboundid:unboundid-ldapsdk' | 
					
						
							|  |  |  | 	testImplementation 'org.apache.directory.server:apacheds-core' | 
					
						
							|  |  |  | 	testImplementation 'org.springframework:spring-core' | 
					
						
							| 
									
										
										
										
											2021-08-20 17:08:39 -05:00
										 |  |  | } | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2023-01-17 17:05:55 -06:00
										 |  |  | def generateAttributes() { | 
					
						
							| 
									
										
										
										
											2023-09-27 15:42:42 -03:00
										 |  |  | 	def springFrameworkVersion = libs.org.springframework.spring.framework.bom.get().versionConstraint.displayName | 
					
						
							|  |  |  | 	springFrameworkVersion = springFrameworkVersion.contains("-") | 
					
						
							|  |  |  | 			? springFrameworkVersion.substring(0, springFrameworkVersion.indexOf("-")) | 
					
						
							|  |  |  | 			: springFrameworkVersion | 
					
						
							|  |  |  | 	def springBootVersion = project.property("springBootVersion") | 
					
						
							|  |  |  | 	def samplesBranch = project.property("samplesBranch") | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2023-01-17 17:05:55 -06:00
										 |  |  | 	def docsTag = snapshotBuild ? 'current' : project.version | 
					
						
							|  |  |  | 	def ghTag = snapshotBuild ? 'main' : project.version | 
					
						
							|  |  |  | 	def ghUrl = "https://github.com/spring-projects/spring-security/tree/$ghTag" | 
					
						
							|  |  |  | 	def ghOldSamplesUrl = 'https://github.com/spring-projects/spring-security/tree/5.4.x/samples' | 
					
						
							|  |  |  | 	def ghSamplesUrl = "https://github.com/spring-projects/spring-security-samples/tree/$samplesBranch" | 
					
						
							|  |  |  | 	def securityDocsUrl = "https://docs.spring.io/spring-security/site/docs/$docsTag" | 
					
						
							|  |  |  | 	def securityApiUrl = "$securityDocsUrl/api/" | 
					
						
							|  |  |  | 	def securityReferenceUrl = "$securityDocsUrl/reference/html5/" | 
					
						
							|  |  |  | 	def springFrameworkApiUrl = "https://docs.spring.io/spring-framework/docs/$springFrameworkVersion/javadoc-api/" | 
					
						
							| 
									
										
										
										
											2024-07-01 18:08:45 -06:00
										 |  |  | 	def springFrameworkReferenceUrl = "https://docs.spring.io/spring-framework/reference/$springFrameworkVersion/" | 
					
						
							| 
									
										
										
										
											2023-04-18 11:28:44 -06:00
										 |  |  | 	def springBootReferenceUrl = "https://docs.spring.io/spring-boot/docs/$springBootVersion/reference/html/" | 
					
						
							| 
									
										
										
										
											2023-05-10 15:26:41 -06:00
										 |  |  | 	def springBootApiUrl = "https://docs.spring.io/spring-boot/docs/$springBootVersion/api/" | 
					
						
							| 
									
										
										
										
											2023-04-18 11:28:44 -06:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2023-01-17 17:05:55 -06:00
										 |  |  | 	return	['gh-old-samples-url': ghOldSamplesUrl.toString(), | 
					
						
							|  |  |  | 		'gh-samples-url': ghSamplesUrl.toString(), | 
					
						
							|  |  |  | 		'gh-url': ghUrl.toString(), | 
					
						
							|  |  |  | 		'security-api-url': securityApiUrl.toString(), | 
					
						
							|  |  |  | 		'security-reference-url': securityReferenceUrl.toString(), | 
					
						
							|  |  |  | 		'spring-framework-api-url': springFrameworkApiUrl.toString(), | 
					
						
							|  |  |  | 		'spring-framework-reference-url': springFrameworkReferenceUrl.toString(), | 
					
						
							| 
									
										
										
										
											2023-05-10 15:26:41 -06:00
										 |  |  | 		'spring-boot-api-url': springBootApiUrl.toString(), | 
					
						
							| 
									
										
										
										
											2023-04-18 11:28:44 -06:00
										 |  |  | 		'spring-boot-reference-url': springBootReferenceUrl.toString(), | 
					
						
							|  |  |  | 		'spring-security-version': project.version] | 
					
						
							| 
									
										
										
										
											2023-01-17 17:05:55 -06:00
										 |  |  | 		+ resolvedVersions(project.configurations.testRuntimeClasspath) | 
					
						
							|  |  |  | } | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2021-08-20 17:08:39 -05:00
										 |  |  | def resolvedVersions(Configuration configuration) { | 
					
						
							| 
									
										
										
										
											2023-01-17 17:05:55 -06:00
										 |  |  | 	return configuration.resolvedConfiguration | 
					
						
							| 
									
										
										
										
											2021-08-20 17:08:39 -05:00
										 |  |  | 				.resolvedArtifacts | 
					
						
							| 
									
										
										
										
											2022-09-26 14:54:14 -06:00
										 |  |  | 				.collectEntries { [(it.name + '-version'): it.moduleVersion.id.version] } | 
					
						
							| 
									
										
										
										
											2021-08-20 17:08:39 -05:00
										 |  |  | } |