feat: add changelog helpers

Prototik · Jan 10, 2024 · 444b50f · 444b50f
1 parent e3e4ee9
commit 444b50f
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -42,7 +42,7 @@ cursedPublish {
         displayName("MyCoolMod (Fabric)")
 
         // Changelog
-        changelog(CursedChangelogType.Text, "Some changelog")
+        changelogMarkdown("# Some changelog for my CoolMod")
 
         // Minecraft version
         minecraft("1.20.4")

diff --git a/build.gradle.kts b/build.gradle.kts
@@ -243,7 +243,7 @@ signing {
 
 tasks {
     publishPlugins {
-        onlyIf { nyxState.coreVersion }
+        onlyIf { nyxState.coreVersion && nyxState.newRelease }
     }
     nyxPublish {
         dependsOn(publishPlugins)

diff --git a/src/integrationTest/kotlin/rocks/aur/cursedpublish/test/GradleBuildScriptSpec.kt b/src/integrationTest/kotlin/rocks/aur/cursedpublish/test/GradleBuildScriptSpec.kt
@@ -124,7 +124,7 @@ object KotlinGradleBuildScriptSpec : GradleBuildScriptSpec({ projectDir, apiBase
 
             file(tasks.jar) {
                 displayName("MyCoolMod (Fabric)")
-                changelog(CursedChangelogType.Text, "Some changelog")
+                changelogText("Some changelog")
 
                 minecraft("1.20.4")
                 fabric()
@@ -173,7 +173,7 @@ object GroovyGradleBuildScriptSpec : GradleBuildScriptSpec({ projectDir, apiBase
 
             file(tasks.jar) {
                 displayName 'MyCoolMod (Fabric)'
-                changelog CursedChangelogType.Text, 'Some changelog'
+                changelogText 'Some changelog'
 
                 minecraft '1.20.4'
                 fabric()

diff --git a/src/main/kotlin/rocks/aur/cursedpublish/CursedFile.kt b/src/main/kotlin/rocks/aur/cursedpublish/CursedFile.kt
@@ -9,6 +9,7 @@ import org.gradle.internal.*
 import org.jetbrains.annotations.*
 import java.io.*
 
+@Suppress("unused")
 @ApiStatus.NonExtendable
 @CursedDsl
 @SubclassOptInRequired(markerClass = CursedInternalApi::class)
@@ -35,6 +36,10 @@ interface CursedFile : Named, Buildable {
         changelog(changelog)
     }
 
+    fun changelogText(changelog: String) = changelog(CursedChangelogType.Text, changelog)
+    fun changelogHtml(changelog: String) = changelog(CursedChangelogType.Html, changelog)
+    fun changelogMarkdown(changelog: String) = changelog(CursedChangelogType.Markdown, changelog)
+
     @get:Input
     @get:Optional
     val displayName: Property<String>