Versions

As kotlinx.rpc uses Kotlin compiler plugin, we rely on internal functionality that may change over time with any new Kotlin version. To prevent the library from breaking with an incompatible Kotlin version, we use version prefix for artifacts with code generating functionality.

We provide core version updates for all stable versions of the last three major Kotlin releases. So if the last stable Kotlin version is 2.0.21, as at the time of writing this guide, the following versions of Kotlin are supported:

2.0.0, 2.0.10, 2.0.20, 2.0.21

Our code generation will support these versions (See more on code generation artifacts). Runtime artifacts are configured with language-version and api-version parameters for the oldest supported minor version of Kotlin.

Project configuration

To simplify project configuration, both our Gradle plugins are able to set proper runtime dependencies versions automatically based on the project's Kotlin version and the Gradle plugin version which is used as a core library version.

            plugins {
                // project's Kotlin plugin
                kotlin("jvm") version "2.0.21"
                // kotlinx.rpc plugin
                id("org.jetbrains.kotlinx.rpc.plugin") version "0.4.0"
            }

            dependencies {
                // for kotlinx.rpc runtime dependencies,
                //  Gradle plugin sets version 0.4.0
                implementation("org.jetbrains.kotlinx:kotlinx-rpc-krpc-client")
                implementation("org.jetbrains.kotlinx:kotlinx-rpc-krpc-server")
            }
        

Code generation artifacts

To ensure everything works as intended for all supported Kotlin versions, we provide a separate code-generation artifact for each Kotlin version. For example, if a project has this setup:

        plugins {
            kotlin("jvm") version "2.0.21"
            id("org.jetbrains.kotlinx.rpc.plugin") version "0.4.0"
        }
        

Our Gradle plugin will add these dependencies to all applicable configurations:

            org.jetbrains.kotlinx:kotlinx-rpc-compiler-plugin-cli:2.0.21-0.4.0
            org.jetbrains.kotlinx:kotlinx-rpc-compiler-plugin-common:2.0.21-0.4.0
            org.jetbrains.kotlinx:kotlinx-rpc-compiler-plugin-k2:2.0.21-0.4.0
            org.jetbrains.kotlinx:kotlinx-rpc-compiler-plugin-backend:2.0.21-0.4.0
        

Such dependencies are managed automatically, and should not be used explicitly.

Last modified: 05 November 2024