Support Kotlin/Native

.github/workflows/docs-ci.yml

@@ -1,38 +1,12 @@
-# This workflow will build and deploy docs to GitHub Pages whenever something is pushed to the main branch
-
-name: Docs
-
+name: Documentation CI
 on:
   push:
-    branches:
-      - main
+  pull_request:
 
 permissions:
-  contents: write
+  id-token: write
+  pages: write
 
 jobs:
   docs:
-    name: Build and deploy docs
-    runs-on: ubuntu-latest
-    concurrency: # Allow one concurrent deployment
-      group: pages
-      cancel-in-progress: true
-    steps:
-      - uses: actions/checkout@v4
-      - name: Set up JDK
-        uses: actions/setup-java@v4
-        with:
-          distribution: temurin
-          java-version: 11
-      - name: Set up Gradle
-        uses: gradle/actions/setup-gradle@v3
-      - name: Build docs with Gradle
-        run: ./gradlew --stacktrace --info dokkaHtmlMultiModule
-      - name: Deploy docs to GitHub Pages
-        uses: JamesIves/github-pages-deploy-action@v4
-        with:
-          folder: build/dokka/htmlMultiModule
-          branch: gh-pages
-          git-config-name: GitHub Actions
-          git-config-email: [email protected]
-          commit-message: Update docs
+    uses: kordlib/.teamcity/.github/workflows/documentation.yml@main

README.md

@@ -37,18 +37,17 @@ mapping of the Voice API on Kotlin/JVM
 
 ## Modules
 
-| Module                   | Docs                                                    | Artifact          | JVM | JS | Native² |
-|--------------------------|---------------------------------------------------------|-------------------|-----|----|---------|
-| [common](common)         | [common](https://kordlib.github.io/kord/common)         | `kord-common`¹    | ✅   | ✅  | ❌       |
-| [rest](rest)             | [rest](https://kordlib.github.io/kord/rest)             | `kord-rest`¹      | ✅   | ✅  | ❌       |
-| [gateway](gateway)       | [gateway](https://kordlib.github.io/kord/gateway)       | `kord-gateway`¹   | ✅   | ✅  | ❌       |
-| [core](core)             | [core](https://kordlib.github.io/kord/core)             | `kord-core`¹      | ✅   | ✅  | ❌       |
-| [voice](voice)           | [voice](https://kordlib.github.io/kord/voice)           | `kord-voice`      | ✅   | ❌³ | ❌       |
-| [core-voice](core-voice) | [core-voice](https://kordlib.github.io/kord/core-voice) | `kord-core-voice` | ✅   | ❌  | ❌       |
+| Module                   | Docs                                                    | Artifact           | JVM | JS (NodeJS) | Native |
+|--------------------------|---------------------------------------------------------|--------------------|-----|-------------|--------|
+| [common](common)         | [common](https://kordlib.github.io/kord/common)         | `kord-common`¹     | ✅   | ✅           | ✅      |
+| [rest](rest)             | [rest](https://kordlib.github.io/kord/rest)             | `kord-rest`¹       | ✅   | ✅           | ✅      |
+| [gateway](gateway)       | [gateway](https://kordlib.github.io/kord/gateway)       | `kord-gateway`¹    | ✅   | ✅           | ✅      |
+| [core](core)             | [core](https://kordlib.github.io/kord/core)             | `kord-core`¹       | ✅   | ✅           | ✅      |
+| [voice](voice)           | [voice](https://kordlib.github.io/kord/voice)           | `kord-voice`¹      | ✅   | ✅           | ✅²     |
+| [core-voice](core-voice) | [core-voice](https://kordlib.github.io/kord/core-voice) | `kord-core-voice`¹ | ✅   | ✅           | ✅²     |
 
 ¹ These artifacts only supports Gradle Version 5.3 or higher, for older Gradle versions and Maven please append `-jvm`  
-² For Native Support please see #69  
-³ For Voice JS please see #69
+² Currently not on Windows(MinGW) targets, see #69  
 
 ## Installation
 

bom/build.gradle.kts

@@ -1,6 +1,6 @@
 plugins {
     `java-platform`
-    `maven-publish`
+    `kord-publishing`
 }
 
 val me = project
@@ -31,5 +31,3 @@ publishing {
         from(components["javaPlatform"])
     }
 }
-
-apply(plugin = "kord-publishing")

build.gradle.kts

@@ -2,9 +2,13 @@ plugins {
     org.jetbrains.dokka // for dokkaHtmlMultiModule task
 }
 
-repositories {
-    mavenCentral()
+allprojects {
+    repositories {
+        // TODO: Remove wants https://github.com/ktorio/ktor/pull/3950 lands
+        maven("https://europe-west3-maven.pkg.dev/mik-music/kord")
+        mavenCentral()
+        maven("https://oss.sonatype.org/content/repositories/snapshots/")
+    }
 }
 
 group = Library.group
-version = libraryVersion

buildSrc/build.gradle.kts

@@ -3,12 +3,16 @@ plugins {
 }
 
 repositories {
+    gradlePluginPortal()
     mavenCentral()
+    // Repo providing the Kord Gradle plugin
+    maven("https://europe-west3-maven.pkg.dev/mik-music/kord")
 }
 
 kotlin {
     compilerOptions {
         allWarningsAsErrors = true
+        freeCompilerArgs.add("-Xcontext-receivers")
     }
 }
 

buildSrc/src/main/kotlin/Documentation.kt

@@ -1,3 +1,4 @@
+import dev.kord.gradle.tools.util.commitHash
 import org.gradle.kotlin.dsl.assign
 import org.jetbrains.dokka.gradle.AbstractDokkaLeafTask
 import java.net.URI

buildSrc/src/main/kotlin/Projects.kt

@@ -1,33 +1,6 @@
-import org.gradle.api.Project
-
 object Library {
     const val name = "kord"
     const val group = "dev.kord"
     const val description = "Idiomatic Kotlin Wrapper for The Discord API"
     const val projectUrl = "https://github.com/kordlib/kord"
 }
-
-private val Project.tag
-    get() = git("tag", "--no-column", "--points-at", "HEAD")
-        .takeIf { it.isNotBlank() }
-        ?.lines()
-        ?.single()
-
-val Project.libraryVersion
-    get() = tag ?: run {
-        val snapshotPrefix = when (val branch = git("branch", "--show-current")) {
-            "main" -> providers.gradleProperty("nextPlannedVersion").get()
-            else -> branch.replace('/', '-')
-        }
-        "$snapshotPrefix-SNAPSHOT"
-    }
-
-val Project.commitHash get() = git("rev-parse", "--verify", "HEAD")
-val Project.shortCommitHash get() = git("rev-parse", "--short", "HEAD")
-
-val Project.isRelease get() = tag != null
-
-object Repo {
-    const val releasesUrl = "https://oss.sonatype.org/service/local/staging/deploy/maven2/"
-    const val snapshotsUrl = "https://oss.sonatype.org/content/repositories/snapshots/"
-}

buildSrc/src/main/kotlin/Targets.kt

@@ -0,0 +1,58 @@
+import org.gradle.api.tasks.TaskContainer
+import org.jetbrains.kotlin.gradle.ExperimentalKotlinGradlePluginApi
+import org.jetbrains.kotlin.gradle.dsl.KotlinMultiplatformExtension
+import org.jetbrains.kotlin.konan.target.HostManager
+
+@OptIn(ExperimentalKotlinGradlePluginApi::class)
+fun KotlinMultiplatformExtension.targets() {
+    jvm()
+
+    js {
+        nodejs {
+            testTask {
+                useMocha {
+                    // disable timeouts, some tests are too slow for default 2-second timeout:
+                    // https://mochajs.org/#-timeout-ms-t-ms
+                    timeout = "0"
+                }
+            }
+        }
+        useCommonJs()
+    }
+
+    linuxX64()
+    linuxArm64()
+
+    mingwX64()
+
+    macosArm64()
+    macosX64()
+
+    iosArm64()
+    iosX64()
+    iosSimulatorArm64()
+
+    watchosArm64()
+    watchosSimulatorArm64()
+
+    tvosX64()
+    tvosArm64()
+    tvosSimulatorArm64()
+
+    compilerOptions {
+        applyKordCompilerOptions()
+    }
+}
+
+// There are issues with linking the linux variant on windows.
+// Please use WSL if you need to work on the linux port.
+fun TaskContainer.disableLinuxLinkTestTasksOnWindows() {
+    if (HostManager.hostIsMingw) {
+        val linuxLinkTestTasks = listOf("linkDebugTestLinuxX64", "linkDebugTestLinuxArm64")
+        for (task in linuxLinkTestTasks) {
+            named(task) {
+                enabled = false
+            }
+        }
+    }
+}

buildSrc/src/main/kotlin/kord-internal-module.gradle.kts

@@ -1,5 +1,6 @@
 plugins {
     org.jetbrains.kotlin.jvm
+    dev.kord.`gradle-tools`
 }
 
 repositories {