Merge branch '5.7.x' into 5.8.x
This commit is contained in:
		
						commit
						d42405de42
					
				| 
						 | 
				
			
			@ -6,7 +6,13 @@ nav:
 | 
			
		|||
ext:
 | 
			
		||||
  collector:
 | 
			
		||||
    run:
 | 
			
		||||
      command: gradlew -q -PbuildSrc.skipTests=true "-Dorg.gradle.jvmargs=-Xmx3g -XX:+HeapDumpOnOutOfMemoryError" :spring-security-docs:generateAntora
 | 
			
		||||
      command: gradlew -q -PbuildSrc.skipTests=true "-Dorg.gradle.jvmargs=-Xmx3g -XX:+HeapDumpOnOutOfMemoryError" :spring-security-docs:generateAntoraYml
 | 
			
		||||
      local: true
 | 
			
		||||
    scan:
 | 
			
		||||
      dir: ./build/generateAntora
 | 
			
		||||
      dir: ./build/generated-antora-resources
 | 
			
		||||
asciidoc:
 | 
			
		||||
  attributes:
 | 
			
		||||
    icondir: icons
 | 
			
		||||
    gh-old-samples-url: 'https://github.com/spring-projects/spring-security/tree/5.4.x/samples'
 | 
			
		||||
    gh-samples-url: "https://github.com/spring-projects/spring-security-samples/tree/{gh-tag}"
 | 
			
		||||
    gh-url: "https://github.com/spring-projects/spring-security/tree/{gh-tag}"
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -1,5 +1,6 @@
 | 
			
		|||
plugins {
 | 
			
		||||
	id 'org.antora' version '1.0.0-alpha.7'
 | 
			
		||||
	id 'io.spring.antora.generate-antora-yml' version '0.0.1'
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
apply plugin: 'io.spring.convention.docs'
 | 
			
		||||
| 
						 | 
				
			
			@ -16,60 +17,9 @@ antora {
 | 
			
		|||
	options = [clean: true, fetch: !project.gradle.startParameter.offline, stacktrace: true]
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
tasks.register('generateAntora') {
 | 
			
		||||
	group = 'Documentation'
 | 
			
		||||
	description = 'Generates the antora.yml for dynamic properties'
 | 
			
		||||
	doLast {
 | 
			
		||||
		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/"
 | 
			
		||||
		def springFrameworkReferenceUrl = "https://docs.spring.io/spring-framework/docs/$springFrameworkVersion/reference/html/"
 | 
			
		||||
		def ymlVersions = resolvedVersions(project.configurations.testRuntimeClasspath).call()
 | 
			
		||||
			.collect(v -> "    ${v.getKey()}: ${v.getValue()}")
 | 
			
		||||
			.join('\n')
 | 
			
		||||
		def outputFile = layout.buildDirectory.file('generateAntora/antora.yml').get().asFile
 | 
			
		||||
		mkdir(outputFile.getParentFile())
 | 
			
		||||
		def mainVersion = project.version
 | 
			
		||||
		def prerelease = null
 | 
			
		||||
		def versionComponents = mainVersion.split(/(?=-)/)
 | 
			
		||||
        if (versionComponents.length > 1) {
 | 
			
		||||
          if (versionComponents[1] == '-SNAPSHOT') {
 | 
			
		||||
            mainVersion = versionComponents[0]
 | 
			
		||||
            prerelease = "'-SNAPSHOT'"
 | 
			
		||||
          } else {
 | 
			
		||||
            prerelease = 'true'
 | 
			
		||||
          }
 | 
			
		||||
        }
 | 
			
		||||
		def antoraYmlText = file('antora.yml').text
 | 
			
		||||
		layout.buildDirectory.file('.antora.yml').get().asFile.text = antoraYmlText
 | 
			
		||||
		antoraYmlText = antoraYmlText.lines().collect { l ->
 | 
			
		||||
			if (l.startsWith('version: ')) {
 | 
			
		||||
				return prerelease == null ? "version: '${mainVersion}'" : "version: '${mainVersion}'\nprerelease: ${prerelease}"
 | 
			
		||||
			}
 | 
			
		||||
			if (l.startsWith('title: ')) return "title: ${project.parent.description}"
 | 
			
		||||
			return l == 'ext:' || l.getAt(0) == ' ' ? null : l
 | 
			
		||||
		}.findAll(Objects::nonNull).join('\n')
 | 
			
		||||
		outputFile.text = """$antoraYmlText
 | 
			
		||||
asciidoc:
 | 
			
		||||
  attributes:
 | 
			
		||||
    icondir: icons
 | 
			
		||||
    gh-old-samples-url: $ghOldSamplesUrl
 | 
			
		||||
    gh-samples-url: $ghSamplesUrl
 | 
			
		||||
    gh-url: $ghUrl
 | 
			
		||||
    security-api-url: $securityApiUrl
 | 
			
		||||
    security-reference-url: $securityReferenceUrl
 | 
			
		||||
    spring-framework-api-url: $springFrameworkApiUrl
 | 
			
		||||
    spring-framework-reference-url: $springFrameworkReferenceUrl
 | 
			
		||||
    spring-security-version: ${project.version}
 | 
			
		||||
${ymlVersions}
 | 
			
		||||
"""
 | 
			
		||||
	}
 | 
			
		||||
tasks.named("generateAntoraYml") {
 | 
			
		||||
	asciidocAttributes = project.provider( { generateAttributes() } )
 | 
			
		||||
	asciidocAttributes.putAll(providers.provider( { resolvedVersions(project.configurations.testRuntimeClasspath) }))
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
dependencies {
 | 
			
		||||
| 
						 | 
				
			
			@ -79,12 +29,33 @@ dependencies {
 | 
			
		|||
	testImplementation 'org.springframework:spring-core'
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
def generateAttributes() {
 | 
			
		||||
	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/"
 | 
			
		||||
	def springFrameworkReferenceUrl = "https://docs.spring.io/spring-framework/docs/$springFrameworkVersion/reference/html/"
 | 
			
		||||
		
 | 
			
		||||
	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(),
 | 
			
		||||
		'spring-security-version': project.version] 
 | 
			
		||||
		+ resolvedVersions(project.configurations.testRuntimeClasspath)
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
def resolvedVersions(Configuration configuration) {
 | 
			
		||||
	return {
 | 
			
		||||
		configuration.resolvedConfiguration
 | 
			
		||||
	return configuration.resolvedConfiguration
 | 
			
		||||
				.resolvedArtifacts
 | 
			
		||||
				.collectEntries { [(it.name + '-version'): it.moduleVersion.id.version] }
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
repositories {
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
		Loading…
	
		Reference in New Issue