Add changelog (#12)

* add changelog plugin to the sdk project

* setup changelog at top level

* update changelog config
add info for the RC1

* use patchChangelog to create the 1.0.0-RC1 section that is published

* set the current version to next release 1.0.0-RC2

* prepare modification comment for the setupResponse method

* update changelog plugin setup not to combine pre-release notes

Author: GuillaumeTaffin

CHANGELOG.md

@@ -0,0 +1,31 @@
+# Changelog
+
+Datastar Kotlin SDK updates.
+
+## Unreleased
+
+### Added
+
+### Changed
+
+- Add `ServerSentEventGenerator.setupResponse` method. This was internally called on generator initialization but was not playing well with web frameworks' multiple ways of handling responses. This method now needs to be called explicitly when applicable.
+
+### Deprecated
+
+### Removed
+
+### Fixed
+
+### Security
+
+## 1.0.0-RC1 - 2025-08-30
+
+### Added
+
+- Initial project setup.
+- [Datastar ADR](https://github.com/starfederation/datastar/blob/develop/sdk/ADR.md) compliant implementation.
+    - `readSignals`
+    - `ServerSentEventGenerator.send`
+    - `ServerSentEventGenerator.patchElements`
+    - `ServerSentEventGenerator.patchSignals`
+- Tested against [Datastar](https://github.com/starfederation/datastar/releases/tag/v1.0.0-RC.5) `v1.0.0-RC.5` (a7adbacbc9c1a3b27707d7cceba3c02a3f81a86c).

build.gradle.kts

@@ -0,0 +1,11 @@
+plugins {
+    alias(libs.plugins.changelog)
+}
+
+version = providers.gradleProperty("version").get()
+
+changelog {
+    version = project.version.toString()
+    introduction = "Datastar Kotlin SDK updates."
+    combinePreReleases = false
+}

gradle.properties

@@ -4,4 +4,4 @@ org.gradle.caching=true
 datastar.test-suite.version=a7adbacbc9c1a3b27707d7cceba3c02a3f81a86c
 groupId=dev.data-star.kotlin
 artifactId=kotlin-sdk
-version=1.0.0-RC1
+version=1.0.0-RC2

gradle/libs.versions.toml

@@ -15,6 +15,7 @@ kotlin-serialization = { id = "org.jetbrains.kotlin.plugin.serialization", versi
 spotless = { id = "com.diffplug.spotless", version = "7.2.1" }
 kover = { id = "org.jetbrains.kotlinx.kover", version = "0.9.1" }
 jreleaser = { id = "org.jreleaser", version = "1.19.0" }
+changelog = { id = "org.jetbrains.changelog", version = "2.4.0" }
 
 [bundles]
 kotest = ["kotest-assertions"]