Skip to content

Commit fba6585

Browse files
committed
Change readme generation task to abstract
1 parent 3c3d9ce commit fba6585

File tree

2 files changed

+10
-9
lines changed

2 files changed

+10
-9
lines changed

build-logic/src/main/kotlin/Tasks.kt

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ import org.gradle.api.attributes.java.TargetJvmEnvironment.TARGET_JVM_ENVIRONMEN
1111
import org.gradle.api.attributes.plugin.GradlePluginApiVersion
1212
import org.gradle.api.attributes.plugin.GradlePluginApiVersion.GRADLE_PLUGIN_API_VERSION_ATTRIBUTE
1313
import org.gradle.api.file.DuplicatesStrategy
14+
import org.gradle.api.file.RegularFileProperty
1415
import org.gradle.api.tasks.*
1516
import java.io.File
1617
import java.time.ZonedDateTime
@@ -176,8 +177,7 @@ fun Copy.configureCreateVersionClassTask(
176177
* Using a template file, the plugin's version constants & other dependency versions
177178
* are automatically injected into the README.
178179
*/
179-
open class GenerateReadme : DefaultTask() {
180-
180+
abstract class GenerateReadme : DefaultTask() {
181181
companion object {
182182
private val PLACEHOLDER_REGEX = Regex("\\\$\\{(.+)}")
183183
private val EXTERNAL_DEP_REGEX = Regex("libs\\.(.+)")
@@ -204,18 +204,19 @@ open class GenerateReadme : DefaultTask() {
204204
""".trimIndent()
205205
}
206206

207-
@InputFile
208-
lateinit var inputTemplateFile: File
207+
@get:InputFile
208+
abstract val inputTemplateFile: RegularFileProperty
209209

210-
@OutputFile
211-
lateinit var outputFile: File
210+
@get:OutputFile
211+
abstract val outputFile: RegularFileProperty
212212

213213
@TaskAction
214214
fun doWork() {
215-
val templateText = inputTemplateFile.readText()
215+
val templateText = inputTemplateFile.asFile.get().readText()
216216
val constants = parseConstantsFile()
217217
val replacedText = replacePlaceholdersInTemplate(templateText, constants)
218-
outputFile.writeText(replacedText)
218+
219+
outputFile.asFile.get().writeText(replacedText)
219220
}
220221

221222
/* Private */

plugin/build.gradle.kts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ apiValidation {
3939

4040
tasks.create<GenerateReadme>("generateReadme") {
4141
// Find folder containing README.md
42-
// (required because this script file is included through symlinks in sub-projects)
42+
// (required because this script file is included through symlinks in subprojects)
4343
var rootFolder: File? = project.rootDir
4444
while (rootFolder != null && rootFolder.exists()) {
4545
val inFile = File(rootFolder, "README.md.template")

0 commit comments

Comments
 (0)