Merge branch 'master' into dev

topi314 · topi314 · commit dd84b42fa713 · 2023-08-02T22:24:58.000+02:00
diff --git a/LavalinkServer/build.gradle.kts b/LavalinkServer/build.gradle.kts
@@ -1,12 +1,14 @@
+import com.vanniktech.maven.publish.JavadocJar
+import com.vanniktech.maven.publish.KotlinJvm
 import org.apache.tools.ant.filters.ReplaceTokens
 import org.springframework.boot.gradle.tasks.bundling.BootJar
 import org.springframework.boot.gradle.tasks.run.BootRun
 
 plugins {
     application
-    `maven-publish`
     kotlin("jvm")
     id("org.jetbrains.dokka")
+    alias(libs.plugins.maven.publish.base)
 }
 
 apply(plugin = "org.springframework.boot")
@@ -15,28 +17,17 @@ apply(plugin = "org.ajoberstar.grgit")
 apply(plugin = "com.adarshr.test-logger")
 apply(plugin = "kotlin")
 apply(plugin = "kotlin-spring")
-apply(from = "../repositories.gradle")
 
 val archivesBaseName = "Lavalink"
 group = "dev.arbjerg.lavalink"
 description = "Play audio to discord voice channels"
 
 application {
-    mainClass.set("lavalink.server.Launcher")
+    mainClass = "lavalink.server.Launcher"
 }
 
 java {
     sourceCompatibility = JavaVersion.VERSION_17
-    targetCompatibility = JavaVersion.VERSION_17
-    withJavadocJar()
-    withSourcesJar()
-}
-
-val dokkaJar by tasks.registering(Jar::class) {
-    group = JavaBasePlugin.DOCUMENTATION_GROUP
-    description = "Assembles Javadoc with Dokka"
-    archiveClassifier.set("javadoc")
-    from(tasks.dokkaJavadoc)
 }
 
 configurations {
@@ -104,11 +95,11 @@ tasks {
 
     // https://stackoverflow.com/questions/41444916/multiple-artifacts-issue-with-deploying-zip-to-nexus
     named<AbstractArchiveTask>("bootDistTar") {
-        archiveClassifier.set("bootTar")
+        archiveClassifier = "bootTar"
     }
 
     named<AbstractArchiveTask>("bootDistZip") {
-        archiveClassifier.set("bootZip")
+        archiveClassifier = "bootZip"
     }
 
     named<Test>("test") {
@@ -125,16 +116,16 @@ tasks {
             }
         })
 
-        archiveBaseName.set("lavaplayer-natives")
-        archiveClassifier.set("musl")
+        archiveBaseName = "lavaplayer-natives"
+        archiveClassifier = "musl"
     }
 
 
     withType<BootJar> {
-        archiveFileName.set("Lavalink.jar")
+        archiveFileName = "Lavalink.jar"
 
         if (findProperty("targetPlatform") == "musl") {
-            archiveFileName.set("Lavalink-musl.jar")
+            archiveFileName = "Lavalink-musl.jar"
             // Exclude base dependency jar
             exclude {
                 it.name.contains("lavaplayer-natives-fork") || (it.name.contains("udpqueue-native-") && !it.name.contains("musl"))
@@ -162,39 +153,18 @@ tasks {
     }
 }
 
+mavenPublishing {
+    configure(KotlinJvm(JavadocJar.Dokka("dokkaHtml")))
+    pom {
+        name = "Lavalink Server"
+        description = "Lavalink Server"
+    }
+}
+
 publishing {
     publications {
-        create<MavenPublication>("LavalinkServer") {
+        named<MavenPublication>("maven") {
             artifact(tasks.named("bootJar"))
-            artifact(tasks.kotlinSourcesJar)
-            artifact(dokkaJar)
-
-            pom {
-                name.set("Lavalink Server")
-                description.set("Lavalink Server")
-                url.set("https://github.com/lavalink-devs/lavalink")
-
-                licenses {
-                    license {
-                        name.set("The MIT License")
-                        url.set("https://github.com/lavalink-devs/Lavalink/blob/master/LICENSE")
-                    }
-                }
-
-                developers {
-                    developer {
-                        id.set("freyacodes")
-                        name.set("Freya Arbjerg")
-                        url.set("https://www.arbjerg.dev")
-                    }
-                }
-
-                scm {
-                    connection.set("scm:git:ssh://github.com/lavalink-devs/lavalink.git")
-                    developerConnection.set("scm:git:ssh://github.com/lavalink-devs/lavalink.git")
-                    url.set("https://github.com/lavalink-devs/lavalink")
-                }
-            }
         }
     }
 }
diff --git a/PLUGINS.md b/PLUGINS.md
@@ -21,35 +21,20 @@ You can add your own plugin by submitting a pull-request to this file.
 ## Developing your own plugin
 
 > **Note:**  
-> If your plugin is developed in Kotlin make sure you are using **Kotlin v1.7.20**
+> If your plugin is developed in Kotlin make sure you are using **Kotlin v1.8.22**
 
-Follow these steps to quickly get started with plugin development:
-1. Create a copy of https://github.com/lavalink-devs/lavalink-plugin-template
-2. Rename the directories `org/example/plugin/` under `src/main/java/` to something more specific like
-`io/github/yourusername/yourplugin`
-3. Rename `src/main/resources/lavalink-plugins/your-plugin.properties` to the name of your plugin. The file must end
-with `.properties`. This is the plugin manifest.
-4. Fill out the name, path, and version properties in the manifest. The path is where your classes will be loaded from,
-e.g. `io.github.yourusername.yourplugin`.
+Follow [these steps](https://github.com/lavalink-devs/lavalink-plugin-template#how-to-use-this-template) to setup a new Lavalink plugin
 
 Now you can start writing your plugin. You can test your plugin against Lavalink by running Gradle with the
-`:run` Gradle task. The [Gradle documentation](https://docs.gradle.org/current/userguide/userguide.html) might be helpful.
+`:runLavalink` Gradle task. The [Gradle plugin documentation](https://github.com/lavalink-devs/lavalink-gradle-plugin#running-the-plugin) might be helpful.
 
-Lavalink has a [plugin API](plugin-api/src/main/java/dev/arbjerg/lavalink/api) which you can integrate with. The API is
-provided as an artifact and is used by the template. It is also possible to integrate with internal parts og Lavalink,
+Lavalink has a [plugin API](https://javadoc.io/doc/dev.arbjerg.lavalink/plugin-api/latest/dev/arbjerg/lavalink/api/package-summary.html) which you can integrate with. The API is
+provided [as an artifact](https://central.sonatype.com/artifact/dev.arbjerg.lavalink/plugin-api) and is used by the template. It is also possible to integrate with internal parts og Lavalink,
 but this is not recommended. Instead, open an issue or pull-request to change the API.
 
-Lavalink is configured by plugins using the Spring Boot framework using Spring annotations. For instance, you could define
-an extension to the WebSocket API by exposing a Spring bean like this:
+Lavalink is configured by plugins using the Spring Boot framework using Spring annotations.
 
-```java
-@Service
-class MyExtension implements WebSocketExtension {
-    // ...
-} 
-```
-
-You can also define custom REST endpoints and configuration file properties. See the Spring Boot documentation for
+You can define custom REST endpoints and configuration file properties. See the Spring Boot documentation for
 [Spring Web MVC](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#web.servlet) and
 [type-safe configuration](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#features.external-config.typesafe-configuration-properties).
 
diff --git a/README.md b/README.md
@@ -11,8 +11,8 @@ A [basic example bot](Testbot) is available.
 
 [![Lavalink Guild](https://discordapp.com/api/guilds/1082302532421943407/embed.png?style=banner2)](https://discord.gg/ZW4s47Ppw4)
 
-> **Warning** Lavalink v4 is now in beta!
-> See [here](CHANGELOG.md#400-beta1) for more information.
+> [!Warning]
+> Lavalink v4 is now in beta! See [here](CHANGELOG.md#400-beta1) for more information.
 
 <details>
 <summary>Table of Contents</summary>
diff --git a/Testbot/build.gradle.kts b/Testbot/build.gradle.kts
@@ -1,14 +1,13 @@
 plugins {
     application
-
     kotlin("jvm")
 }
 
 group = "dev.arbjerg.lavalink"
 version = "1.0"
 
 application {
-    mainClass.set("lavalink.testbot.TestbotKt")
+    mainClass = "lavalink.testbot.TestbotKt"
 }
 
 repositories {
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -1,3 +1,5 @@
+import com.vanniktech.maven.publish.MavenPublishBaseExtension
+import com.vanniktech.maven.publish.SonatypeHost
 import org.ajoberstar.grgit.Grgit
 import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
 
@@ -11,6 +13,7 @@ plugins {
     id("org.jetbrains.kotlin.jvm") version "1.8.22"
     id("org.jetbrains.kotlin.plugin.allopen") version "1.8.22"
     id("org.jetbrains.kotlin.plugin.serialization") version "1.8.22" apply false
+    alias(libs.plugins.maven.publish.base) apply false
 }
 
 allprojects {
@@ -42,6 +45,65 @@ subprojects {
         options.compilerArgs.add("-Xlint:unchecked")
         options.compilerArgs.add("-Xlint:deprecation")
     }
+
+    afterEvaluate {
+        plugins.withId(libs.plugins.maven.publish.base.get().pluginId) {
+            configure<PublishingExtension> {
+                if (findProperty("MAVEN_PASSWORD") != null && findProperty("MAVEN_USERNAME") != null) {
+                    repositories {
+                        val snapshots = "https://maven.arbjerg.dev/snapshots"
+                        val releases = "https://maven.arbjerg.dev/releases"
+
+                        maven(if ((version as String).endsWith("-SNAPSHOT")) releases else snapshots) {
+                            credentials {
+                                password = findProperty("MAVEN_PASSWORD") as String?
+                                username = findProperty("MAVEN_USERNAME") as String?
+                            }
+                        }
+                    }
+                } else {
+                    logger.lifecycle("Not publishing to maven.arbjerg.dev because credentials are not set")
+                }
+            }
+            configure<MavenPublishBaseExtension> {
+                coordinates(group.toString(), project.the<BasePluginExtension>().archivesName.get(), version.toString())
+
+                if (findProperty("mavenCentralUsername") != null && findProperty("mavenCentralPassword") != null) {
+                    publishToMavenCentral(SonatypeHost.S01, false)
+                    if (!(version as String).endsWith("-SNAPSHOT")) {
+                        signAllPublications()
+                    }
+                } else {
+                    logger.lifecycle("Not publishing to OSSRH due to missing credentials")
+                }
+
+                pom {
+                    url = "https://github.com/lavalink-devs/Lavalink"
+
+                    licenses {
+                        license {
+                            name = "MIT License"
+                            url = "https://github.com/lavalink-devs/Lavalink/blob/main/LICENSE"
+                        }
+                    }
+
+                    developers {
+                        developer {
+                            id = "freyacodes"
+                            name = "Freya Arbjerg"
+                            url = "https://www.arbjerg.dev"
+                        }
+                    }
+
+                    scm {
+                        url = "https://github.com/lavalink-devs/Lavalink/"
+                        connection = "scm:git:git://github.com/lavalink-devs/Lavalink.git"
+                        developerConnection = "scm:git:ssh://git@github.com/lavalink-devs/Lavalink.git"
+                    }
+                }
+            }
+        }
+    }
 }
 
 @SuppressWarnings("GrMethodMayBeStatic")
diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties
@@ -1,6 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.2-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.2.1-bin.zip
 networkTimeout=10000
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
diff --git a/plugin-api/build.gradle.kts b/plugin-api/build.gradle.kts
@@ -1,15 +1,14 @@
+import com.vanniktech.maven.publish.JavadocJar
+import com.vanniktech.maven.publish.KotlinJvm
 import org.jetbrains.kotlin.gradle.dsl.JvmTarget
 import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
 
 plugins {
-    signing
-    `maven-publish`
     kotlin("jvm")
     id("org.jetbrains.dokka")
+    alias(libs.plugins.maven.publish.base)
 }
 
-apply(from = "../repositories.gradle")
-
 val archivesBaseName = "plugin-api"
 group = "dev.arbjerg.lavalink"
 
@@ -27,60 +26,15 @@ java {
 
 tasks.withType<KotlinCompile> {
     compilerOptions {
-        jvmTarget.set(JvmTarget.JVM_17)
+        jvmTarget = JvmTarget.JVM_17
         freeCompilerArgs.add("-Xjvm-default=all")
     }
 }
 
-val dokkaJar by tasks.registering(Jar::class) {
-    group = JavaBasePlugin.DOCUMENTATION_GROUP
-    description = "Assembles Javadoc with Dokka"
-    archiveClassifier.set("javadoc")
-    from(tasks.dokkaJavadoc)
-}
-
-val isGpgKeyDefined = findProperty("signing.gnupg.keyName") != null
-
-publishing {
-    publications {
-        create<MavenPublication>("PluginApi") {
-            from(project.components["java"])
-            artifact(tasks.kotlinSourcesJar)
-            artifact(dokkaJar)
-
-            pom {
-                name.set("Lavalink Plugin API")
-                description.set("API for Lavalink plugin development")
-                url.set("https://github.com/lavalink-devs/lavalink")
-
-                licenses {
-                    license {
-                        name.set("The MIT License")
-                        url.set("https://github.com/lavalink-devs/Lavalink/blob/master/LICENSE")
-                    }
-                }
-
-                developers {
-                    developer {
-                        id.set("freyacodes")
-                        name.set("Freya Arbjerg")
-                        url.set("https://www.arbjerg.dev")
-                    }
-                }
-
-                scm {
-                    connection.set("scm:git:ssh://github.com/lavalink-devs/lavalink.git")
-                    developerConnection.set("scm:git:ssh://github.com/lavalink-devs/lavalink.git")
-                    url.set("https://github.com/lavalink-devs/lavalink")
-                }
-            }
-        }
-    }
-}
-
-if (isGpgKeyDefined) {
-    signing {
-        sign(publishing.publications["PluginApi"])
-        useGpgCmd()
+mavenPublishing {
+    configure(KotlinJvm(JavadocJar.Dokka("dokkaJavadoc")))
+    pom {
+        name = "Lavalink Plugin API"
+        description = "API for Lavalink plugin development"
     }
 }
diff --git a/protocol/build.gradle.kts b/protocol/build.gradle.kts
diff --git a/repositories.gradle b/repositories.gradle
diff --git a/settings.gradle.kts b/settings.gradle.kts

Original file line number	Diff line number	Diff line change
`@@ -1,14 +1,13 @@`
`1`	`1`	`plugins {`
`2`	`2`	`application`
`3`		`-`
`4`	`3`	`kotlin("jvm")`
`5`	`4`	`}`
`6`	`5`
`7`	`6`	`group = "dev.arbjerg.lavalink"`
`8`	`7`	`version = "1.0"`
`9`	`8`
`10`	`9`	`application {`
`11`		`- mainClass.set("lavalink.testbot.TestbotKt")`
	`10`	`+ mainClass = "lavalink.testbot.TestbotKt"`
`12`	`11`	`}`
`13`	`12`
`14`	`13`	`repositories {`