WriteReadme

@CacheableTask

Creates or updates a README.md file to inject the generated chart/legend files. If the readme contains a block like below:

Something above

<!--region chart-->
Anything in between
<!--endregion-->

Something below

then the text in between will be replaced with the generated images. Anything outside will be left as-is.

If generating a new README, the output will look like below:

# :path:to:my:module

<!--region chart-->
![](atlas/chart.png)
![](../atlas/legend.png)
<!--endregion-->

Remember, this readme task will also be run when calling gradle atlasGenerate.

Constructors

constructor()

@get:PathSensitive(value = PathSensitivity.NONE)

@get:InputFile

abstract val chartFile: RegularFileProperty

@get:PathSensitive(value = PathSensitivity.NONE)

@get:InputFile

@get:Optional

abstract val legendFile: RegularFileProperty

@get:OutputFile

abstract override val outputFile: RegularFileProperty

@get:Input

abstract val projectPath: Property<String>

@get:Internal

abstract val readmeFile: RegularFileProperty