We want to move our Kotlin and Java samples from the samples Gradle subproject to dedicated source sets, named *Samples, in the types and the types-kotlinx-serialization subprojects.
The new Gradle plugin should provide the following tasks:
checkSampleSources that checks the content of sample sources
extractSamples that extracts samples for KDoc
checkSampleReferences that checks sample references from KDoc
backupMainSources that copies main sources into the build directory
inlineSamples that inlines KDoc samples
restoreMainSources that restores main sources from the build directory
Finally, all tasks provided by this plugin should support Kotlin and Java samples.
✅ Checklist
[x] 👷 Add org.kotools.samples Gradle plugin that should create source sets suffixed by Sample for Kotlin Multiplatform projects.
[x] 👷 Add checkSampleSources task in the new plugin.
[x] 👷 Add extractSamples task in the new plugin.
[x] 👷 Add checkSampleReferences task in the new plugin.
[x] 👷 Add backupMainSources task in the new plugin.
[x] 👷 Add restoreMainSources task in the new plugin.
[x] 👷 Add inlineSamples task in the new plugin.
[x] 👷 Configure integration of new plugin with Dokka and Kotlin.
[x] 👷 Use the new plugin in types-kotlinx-serialization Gradle subproject.
[x] 👷 Use the new plugin in types Gradle subproject.
[x] 🔥 Remove the org.kotools.types.samples Gradle plugin.
[x] 🔥 Remove the samples Gradle subproject, GitHub workflows and run configurations using it, then update the documentation referencing it in some way.
📝 Description
We want to move our Kotlin and Java samples from the
samplesGradle subproject to dedicated source sets, named*Samples, in thetypesand thetypes-kotlinx-serializationsubprojects.The new Gradle plugin should provide the following tasks:
checkSampleSourcesthat checks the content of sample sourcesextractSamplesthat extracts samples for KDoccheckSampleReferencesthat checks sample references from KDocbackupMainSourcesthat copies main sources into the build directoryinlineSamplesthat inlines KDoc samplesrestoreMainSourcesthat restores main sources from the build directoryFinally, all tasks provided by this plugin should support Kotlin and Java samples.
✅ Checklist
org.kotools.samplesGradle plugin that should create source sets suffixed bySamplefor Kotlin Multiplatform projects.checkSampleSourcestask in the new plugin.extractSamplestask in the new plugin.checkSampleReferencestask in the new plugin.backupMainSourcestask in the new plugin.restoreMainSourcestask in the new plugin.inlineSamplestask in the new plugin.types-kotlinx-serializationGradle subproject.typesGradle subproject.org.kotools.types.samplesGradle plugin.samplesGradle subproject, GitHub workflows and run configurations using it, then update the documentation referencing it in some way.