220 lines
7.4 KiB
Kotlin
220 lines
7.4 KiB
Kotlin
package ru.mipt.npm.gradle
|
|
|
|
import groovy.text.SimpleTemplateEngine
|
|
import org.gradle.api.Plugin
|
|
import org.gradle.api.Project
|
|
import org.gradle.kotlin.dsl.*
|
|
import org.jetbrains.changelog.ChangelogPlugin
|
|
import org.jetbrains.dokka.gradle.DokkaPlugin
|
|
import org.jetbrains.dokka.gradle.DokkaTask
|
|
import java.io.File
|
|
import kotlin.collections.component1
|
|
import kotlin.collections.component2
|
|
|
|
class KSciencePublishingExtension(val project: Project) {
|
|
var githubOrg: String? by project.extra
|
|
var githubProject: String? by project.extra
|
|
var spaceRepo: String? by project.extra
|
|
var spaceUser: String? by project.extra
|
|
var spaceToken: String? by project.extra
|
|
var bintrayOrg: String? by project.extra
|
|
var bintrayUser: String? by project.extra
|
|
var bintrayApiKey: String? by project.extra
|
|
var bintrayRepo: String? by project.extra
|
|
}
|
|
|
|
enum class Maturity {
|
|
PROTOTYPE,
|
|
EXPERIMENTAL,
|
|
DEVELOPMENT,
|
|
PRODUCTION
|
|
}
|
|
|
|
class KScienceReadmeExtension(val project: Project) {
|
|
var description: String = ""
|
|
var maturity: Maturity = Maturity.EXPERIMENTAL
|
|
|
|
var readmeTemplate: File = project.file("docs/README-TEMPLATE.md")
|
|
|
|
data class Feature(val id: String, val ref: String, val description: String, val name: String = id)
|
|
|
|
val features = ArrayList<Feature>()
|
|
|
|
fun feature(id: String, ref: String, description: String, name: String = id) {
|
|
features.add(Feature(id, ref, description, name))
|
|
}
|
|
|
|
val properties: MutableMap<String, () -> Any?> = mutableMapOf(
|
|
"name" to { project.name },
|
|
"group" to { project.group },
|
|
"version" to { project.version },
|
|
"features" to { featuresString() }
|
|
)
|
|
|
|
private fun getActualizedProperties() = properties.mapValues { (_, value) ->
|
|
value.invoke()
|
|
}
|
|
|
|
fun property(key: String, value: Any?) {
|
|
properties[key] = {value}
|
|
}
|
|
|
|
fun propertyByTemplate(key: String, template: String) {
|
|
val actual = getActualizedProperties()
|
|
properties[key] = {SimpleTemplateEngine().createTemplate(template).make(actual).toString()}
|
|
}
|
|
|
|
internal val additionalFiles = ArrayList<File>()
|
|
|
|
fun propertyByTemplate(key: String, template: File) {
|
|
val actual = getActualizedProperties()
|
|
properties[key] = {SimpleTemplateEngine().createTemplate(template).make(actual).toString()}
|
|
additionalFiles.add(template)
|
|
}
|
|
|
|
/**
|
|
* Generate a markdown string listing features
|
|
*/
|
|
fun featuresString(itemPrefix: String = " - ", pathPrefix: String = "") = buildString {
|
|
features.forEach {
|
|
appendln("$itemPrefix[${it.id}]($pathPrefix${it.ref}) : ${it.description}")
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Generate a readme string from the stub
|
|
*/
|
|
fun readmeString(): String? {
|
|
return if (readmeTemplate.exists()) {
|
|
val actual = getActualizedProperties()
|
|
SimpleTemplateEngine().createTemplate(readmeTemplate).make(actual).toString()
|
|
} else {
|
|
null
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Apply extension and repositories
|
|
*/
|
|
open class KScienceProjectPlugin : Plugin<Project> {
|
|
override fun apply(target: Project): Unit = target.run {
|
|
apply<ChangelogPlugin>()
|
|
apply<DokkaPlugin>()
|
|
val rootReadmeExtension = KScienceReadmeExtension(this)
|
|
extensions.add("ksciencePublish", KSciencePublishingExtension(this))
|
|
extensions.add("readme", rootReadmeExtension)
|
|
|
|
//Add readme generators to individual subprojects
|
|
subprojects {
|
|
val readmeExtension = KScienceReadmeExtension(this)
|
|
extensions.add("readme", readmeExtension)
|
|
val generateReadme by tasks.creating {
|
|
group = "documentation"
|
|
description = "Generate a README file if stub is present"
|
|
|
|
if(readmeExtension.readmeTemplate.exists()) {
|
|
inputs.file(readmeExtension.readmeTemplate)
|
|
}
|
|
readmeExtension.additionalFiles.forEach {
|
|
if(it.exists()){
|
|
inputs.file(it)
|
|
}
|
|
}
|
|
|
|
val readmeFile = this@subprojects.file("README.md")
|
|
outputs.file(readmeFile)
|
|
|
|
doLast {
|
|
val readmeString = readmeExtension.readmeString()
|
|
if (readmeString != null) {
|
|
readmeFile.writeText(readmeString)
|
|
}
|
|
}
|
|
}
|
|
tasks.withType<DokkaTask>{
|
|
dependsOn(generateReadme)
|
|
}
|
|
}
|
|
|
|
val generateReadme by tasks.creating {
|
|
group = "documentation"
|
|
description = "Generate a README file and a feature matrix if stub is present"
|
|
|
|
subprojects {
|
|
tasks.findByName("generateReadme")?.let {
|
|
dependsOn(it)
|
|
}
|
|
}
|
|
|
|
if(rootReadmeExtension.readmeTemplate.exists()) {
|
|
inputs.file(rootReadmeExtension.readmeTemplate)
|
|
}
|
|
rootReadmeExtension.additionalFiles.forEach {
|
|
if(it.exists()){
|
|
inputs.file(it)
|
|
}
|
|
}
|
|
|
|
val readmeFile = project.file("README.md")
|
|
outputs.file(readmeFile)
|
|
|
|
doLast {
|
|
val projects = subprojects.associate {
|
|
it.name to it.extensions.findByType<KScienceReadmeExtension>()
|
|
}
|
|
|
|
if (rootReadmeExtension.readmeTemplate.exists()) {
|
|
|
|
val modulesString = buildString {
|
|
projects.entries.forEach { (name, ext) ->
|
|
appendln("<hr/>")
|
|
appendln("\n* ### [$name]($name)")
|
|
if (ext != null) {
|
|
appendln("> ${ext.description}")
|
|
appendln(">\n> **Maturity**: ${ext.maturity}")
|
|
val featureString = ext.featuresString(itemPrefix = "> - ", pathPrefix = "$name/")
|
|
if(featureString.isNotBlank()) {
|
|
appendln(">\n> **Features:**")
|
|
appendln(featureString)
|
|
}
|
|
}
|
|
}
|
|
appendln("<hr/>")
|
|
}
|
|
|
|
val rootReadmeProperties: Map<String, Any?> = mapOf(
|
|
"name" to project.name,
|
|
"group" to project.group,
|
|
"version" to project.version,
|
|
"modules" to modulesString
|
|
)
|
|
|
|
readmeFile.writeText(
|
|
SimpleTemplateEngine().createTemplate(rootReadmeExtension.readmeTemplate)
|
|
.make(rootReadmeProperties).toString()
|
|
)
|
|
}
|
|
|
|
}
|
|
}
|
|
|
|
tasks.withType<DokkaTask>{
|
|
dependsOn(generateReadme)
|
|
}
|
|
|
|
val patchChangelog by tasks.getting
|
|
|
|
val release by tasks.creating{
|
|
group = RELEASE_GROUP
|
|
description = "Publish development or production release based on version suffix"
|
|
dependsOn(generateReadme, patchChangelog)
|
|
tasks.findByName("publishAllPublicationsToBintrayRepository")?.let {
|
|
dependsOn(it)
|
|
}
|
|
}
|
|
}
|
|
companion object{
|
|
const val RELEASE_GROUP = "release"
|
|
}
|
|
} |