Minor improvments

- Document a few implementation details
- Use Version catalog
- Upgrade Gradle Publish Plugin
- Rearange Jitpack in repository hierarchy
- Use Kotlin DSL method for registering download task
- Specify correct platform type for Project.lavalink
- Only run publish CI on tagss

Author: DRSchlaubi

.github/workflows/ci.yml

@@ -24,7 +24,7 @@ jobs:
           GRADLE_CONFIG: ${{ secrets.GRADLE_CONFIG }}
         run: echo "$GRADLE_CONFIG" > ~/.gradle/gradle.properties
       - name: Publish Plugin
-        if: github.ref == 'refs/heads/main'
+        if: startsWith(github.ref, 'refs/tags/')
         env:
           MAVEN_USERNAME: ${{ vars.MAVEN_USERNAME }}
           MAVEN_PASSWORD: ${{ secrets.MAVEN_PASSWORD }}

build.gradle.kts

@@ -1,12 +1,12 @@
 plugins {
     `kotlin-dsl`
     `java-gradle-plugin`
-    id("com.gradle.plugin-publish") version "1.1.0"
+    alias(libs.plugins.gradle.publish)
     `maven-publish`
 }
 
 group = "dev.arbjerg"
-version = "1.0.5"
+version = "1.0.6"
 
 repositories {
     mavenCentral()

gradle/libs.versions.toml

@@ -1 +1,2 @@
 [plugins]
+gradle-publish = { id = "com.gradle.plugin-publish", version = "1.2.0" }

src/main/kotlin/DependencyHelpers.kt

@@ -9,7 +9,7 @@ import org.gradle.api.provider.ProviderConvertible
 /**
  * Creates a Lavalink dependency with name [module].
  */
-fun Project.lavalink(module: String, group: String = "dev.arbjerg.lavalink") = extension.apiVersion.map { version ->
+fun Project.lavalink(module: String, group: String = "dev.arbjerg.lavalink"): Provider<Dependency> = extension.apiVersion.map { version ->
     dependencies.create("$group:$module:$version")
 }
 

src/main/kotlin/LavalinkGradlePlugin.kt

@@ -39,13 +39,13 @@ private fun Project.configureExtension(): LavalinkExtension {
 private fun Project.configureDependencies(): Provider<Dependency> {
     project.repositories {
         mavenCentral()
+        maven("https://jitpack.io")
         // Required for runtime
         maven("https://maven.arbjerg.dev/releases")
         maven("https://maven.arbjerg.dev/snapshots")
         // Required for Lavalink Dependencies
         @Suppress("DEPRECATION")
         jcenter()
-        maven("https://jitpack.io")
     }
 
     dependencies {
@@ -96,14 +96,17 @@ private fun Project.configureTasks(serverDependency: Provider<Dependency>) {
         val installPlugin by registering(Copy::class) {
             from(jar)
             into(project.testServerFolder)
+            // This always deletes old versions of the plugin in the test server
+            // So we don't install the same plugin twice
             rename { "plugin.jar" }
         }
 
-        val downloadTask =
-            register("downloadLavalink", DownloadLavalinkTask::class.java, constructorArgs = arrayOf(serverDependency))
+        val downloadLavalink by registering(DownloadLavalinkTask::class) {
+            dependencyProvider = serverDependency
+        }
 
         register<RunLavalinkTask>("runLavaLink") {
-            dependsOn(installPlugin, downloadTask)
+            dependsOn(installPlugin, downloadLavalink)
         }
     }
 }

src/main/kotlin/tasks/DownloadLavalinkTask.kt

@@ -5,22 +5,29 @@ import org.gradle.api.DefaultTask
 import org.gradle.api.Project
 import org.gradle.api.artifacts.Configuration
 import org.gradle.api.artifacts.Dependency
+import org.gradle.api.provider.Property
 import org.gradle.api.provider.Provider
+import org.gradle.api.tasks.Input
+import org.gradle.api.tasks.Internal
 import org.gradle.api.tasks.TaskAction
 import java.nio.file.Path
-import javax.inject.Inject
 import kotlin.io.path.div
 
 internal val Project.lavalinkJar: Provider<Path>
     get() = provider {
         project.gradle.gradleUserHomeDir.toPath() / "lavalink-versions" / extension.serverVersion.get() / "Lavalink.jar"
     }
 
-abstract class DownloadLavalinkTask @Inject constructor(private val dependencyProvider: Provider<Dependency>) :
-    DefaultTask() {
+abstract class DownloadLavalinkTask : DefaultTask() {
+    @get:Internal
+    internal abstract val dependencyProvider: Property<Dependency>
+
+    @Suppress("unused") // only exists for input snapshotting
+    @get:Input
+    val version: Provider<String>
+        get() = dependencyProvider.map { it.version!! }
 
     init {
-        inputs.property("dependency", dependencyProvider.map { it.version.toString() })
         outputs.dir(project.gradle.gradleUserHomeDir.toPath() / "lavalink-versions")
     }