Skip to content

Releases: kotools/samples

0.3.0

09 Mar 19:31
bdd0962
Compare
Choose a tag to compare

♻️ Changed

  • Bump Gradle Wrapper from 8.11.1 to 8.12.1 (#29).

🗑️ Deprecated

  • The sample Kotlin source set with an error level (#24).

Thanks to @LVMVRQUXL for contributing to this release. 🙏

0.2.0

03 Feb 17:41
510fa03
Compare
Choose a tag to compare

✨ Added

  • Support samples from the test Kotlin source set (#22). These files must have a name suffixed by Sample for distinguishing them from test files.
  • Dependency compatibility documentation (#11).

♻️ Changed

  • Bump Gradle Wrapper from 8.10.2 to 8.11.1 (#16).
  • Rename the build output directory from samples as kotools-samples (#27).

🗑️ Deprecated

  • The sample Kotlin source set with a warning level for using the test Kotlin source set instead (#23).

Thanks to @LVMVRQUXL for contributing to this new release. 🙏

0.1.0

17 Nov 10:20
208e6c7
Compare
Choose a tag to compare

✨ Added

  • org.kotools.samples.jvm Gradle plugin for Kotlin/JVM projects, supporting Kotlin 1.8.22 and Dokka 1.8.20. The following bullet points refer to changes made to this Gradle plugin.
  • sample Kotlin source set dedicated to code samples written in Kotlin or Java. By default, the test source set depends on the sample one, which depends on the main one. This configuration allows to execute code samples alongside unit tests, ensuring their correctness.
  • checkSampleSources task for checking the content of sample sources. This task fails if a sample source doesn't have a single class.
  • extractSamples task that extracts samples from sources as Markdown for KDoc.
  • checkSampleReferences task for checking that KDoc sample references targets existing code samples.
  • backupMainSources task for saving main sources before inlining samples.
  • inlineSamples task that inlines samples in KDoc as Markdown code blocks.
  • restoreMainSources task for restoring main sources after inlining samples.

Thanks to @LVMVRQUXL for contributing to this new release. 🙏