build: support for changelog

fioan89 · fioan89 · commit a5019278befc · 2025-02-28T22:08:40.000+02:00
- initial changelog file.
- gradle plugin to automatically manage the changelog (ex: replacing unreleased tag with an actual version at release time)
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,8 @@
+# Coder Toolbox Plugin Changelog
+
+## Unreleased
+
+### Added
+
+- initial support for JetBrains Toolbox 2.6.0.38311 with the possibility to manage the workspaces - i.e. start, stop,
+  update and delete actions and also quick shortcuts to templates, web terminal and dashboard.
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -13,6 +13,7 @@ plugins {
     alias(libs.plugins.dependency.license.report)
     alias(libs.plugins.ksp)
     alias(libs.plugins.gradle.wrapper)
+    alias(libs.plugins.changelog)
 }
 
 buildscript {
@@ -50,6 +51,15 @@ dependencies {
     testImplementation(kotlin("test"))
 }
 
+val pluginId = properties("group")
+val pluginVersion = properties("version")
+
+changelog {
+    version.set(pluginVersion)
+    groups.set(emptyList())
+    title.set("Coder Toolbox Plugin Changelog")
+}
+
 licenseReport {
     renderers = arrayOf(JsonReportRenderer("dependencies.json"))
     filters = arrayOf(ExcludeTransitiveDependenciesFilter())
@@ -65,9 +75,6 @@ tasks.test {
     useJUnitPlatform()
 }
 
-val pluginId = "com.coder.toolbox"
-val pluginVersion = "0.0.1"
-
 val assemblePlugin by tasks.registering(Jar::class) {
     archiveBaseName.set(pluginId)
     from(sourceSets.main.get().output)
@@ -163,3 +170,5 @@ tasks.register("classpath") {
         )
     }
 }
+
+fun properties(key: String) = project.findProperty(key).toString()
diff --git a/gradle.properties b/gradle.properties
@@ -0,0 +1,2 @@
+version=0.1.0
+group=com.coder.toolbox
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -12,6 +12,7 @@ exec = "1.12"
 moshi = "1.15.1"
 ksp = "2.1.0-1.0.29"
 retrofit = "2.8.2"
+changelog = "2.2.1"
 
 [libraries]
 toolbox-core-api = { module = "com.jetbrains.toolbox:core-api", version.ref = "toolbox-plugin-api" }
@@ -40,4 +41,5 @@ kotlin = { id = "org.jetbrains.kotlin.jvm", version.ref = "kotlin" }
 serialization = { id = "org.jetbrains.kotlin.plugin.serialization", version.ref = "kotlin" }
 dependency-license-report = { id = "com.github.jk1.dependency-license-report", version.ref = "dependency-license-report" }
 ksp = { id = "com.google.devtools.ksp", version.ref = "ksp"}
-gradle-wrapper = { id = "me.filippov.gradle.jvm.wrapper", version.ref = "gradle-wrapper" }
+gradle-wrapper = { id = "me.filippov.gradle.jvm.wrapper", version.ref = "gradle-wrapper" }
+changelog = { id = "org.jetbrains.changelog", version.ref = "changelog" }

Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,7 @@ plugins {`
`13`	`13`	`alias(libs.plugins.dependency.license.report)`
`14`	`14`	`alias(libs.plugins.ksp)`
`15`	`15`	`alias(libs.plugins.gradle.wrapper)`
	`16`	`+ alias(libs.plugins.changelog)`
`16`	`17`	`}`
`17`	`18`
`18`	`19`	`buildscript {`
`@@ -50,6 +51,15 @@ dependencies {`
`50`	`51`	`testImplementation(kotlin("test"))`
`51`	`52`	`}`
`52`	`53`
	`54`	`+val pluginId = properties("group")`
	`55`	`+val pluginVersion = properties("version")`
	`56`	`+`
	`57`	`+changelog {`
	`58`	`+ version.set(pluginVersion)`
	`59`	`+ groups.set(emptyList())`
	`60`	`+ title.set("Coder Toolbox Plugin Changelog")`
	`61`	`+}`
	`62`	`+`
`53`	`63`	`licenseReport {`
`54`	`64`	`renderers = arrayOf(JsonReportRenderer("dependencies.json"))`
`55`	`65`	`filters = arrayOf(ExcludeTransitiveDependenciesFilter())`
`@@ -65,9 +75,6 @@ tasks.test {`
`65`	`75`	`useJUnitPlatform()`
`66`	`76`	`}`
`67`	`77`
`68`		`-val pluginId = "com.coder.toolbox"`
`69`		`-val pluginVersion = "0.0.1"`
`70`		`-`
`71`	`78`	`val assemblePlugin by tasks.registering(Jar::class) {`
`72`	`79`	`archiveBaseName.set(pluginId)`
`73`	`80`	`from(sourceSets.main.get().output)`
`@@ -163,3 +170,5 @@ tasks.register("classpath") {`
`163`	`170`	`)`
`164`	`171`	`}`
`165`	`172`	`}`
	`173`	`+`
	`174`	`+fun properties(key: String) = project.findProperty(key).toString()`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+version=0.1.0`
	`2`	`+group=com.coder.toolbox`