Skip to content

Commit

Permalink
📝 Move unreleased changelog to GitHub Releases (#7)
Browse files Browse the repository at this point in the history
  • Loading branch information
LVMVRQUXL committed Nov 17, 2024
1 parent 7a9f68d commit 208e6c7
Showing 1 changed file with 7 additions and 23 deletions.
30 changes: 7 additions & 23 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,26 +16,10 @@ All notable changes to this project will be documented in this file.

## 🚧 Unreleased

### ✨ 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. 🙏

[@LVMVRQUXL]: https://github.com/LVMVRQUXL
## 🔖 Releases

| Version | Release date |
|---------|--------------|
| [0.1.0] | 2024-11-17 |

[0.1.0]: https://github.com/kotools/samples/releases/tag/0.1.0

0 comments on commit 208e6c7

Please sign in to comment.