Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release 0.3.0 #211

Merged
merged 7 commits into from
Oct 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ env:
ALGOLIA_INDEX_NAME: 'prod_kotlin_rpc'
ALGOLIA_KEY: '${{ secrets.ALGOLIA_KEY }}'
CONFIG_JSON_PRODUCT: 'kotlinx-rpc'
CONFIG_JSON_VERSION: '0.2.4'
CONFIG_JSON_VERSION: '0.3.0'

jobs:
build:
Expand Down
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ build
!.idea/detekt.xml
!.idea/kotlinTestDataPluginTestDataPaths.xml

samples/**/.idea/*

.DS_Store

# Ignore generated Detekt reports
Expand Down
42 changes: 42 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,45 @@
# 0.3.0
> Published 1 October 2024

### Features 🎉
* Wasm Support by @Mr3zee in https://github.com/Kotlin/kotlinx-rpc/pull/190

### Breaking Changes 🔴
* Move kRPC declarations from core by @Mr3zee in https://github.com/Kotlin/kotlinx-rpc/pull/186

### Bug fixes 🐛
* Fix kotlin/js code and samples by @Mr3zee in https://github.com/Kotlin/kotlinx-rpc/pull/179
* Fix regression of nested declarations in RPC interfaces by @Mr3zee in https://github.com/Kotlin/kotlinx-rpc/pull/181

### Documentation 📗
* Wording fixes by @Mr3zee in https://github.com/Kotlin/kotlinx-rpc/pull/175

### Infra 🚧
* Infra enhancements by @Mr3zee in https://github.com/Kotlin/kotlinx-rpc/pull/206
* Fixed Wasm Publication by @Mr3zee in https://github.com/Kotlin/kotlinx-rpc/pull/208
* Update renovate configs by @Mr3zee in https://github.com/Kotlin/kotlinx-rpc/pull/185
* Configure JPMS checks by @Mr3zee in https://github.com/Kotlin/kotlinx-rpc/pull/187
* Update some ide configs by @Mr3zee in https://github.com/Kotlin/kotlinx-rpc/pull/188
* Added Gradle Doctor to the build by @Mr3zee in https://github.com/Kotlin/kotlinx-rpc/pull/189
* Added build cache and develocity plugin by @Mr3zee in https://github.com/Kotlin/kotlinx-rpc/pull/192
* Support variable Kotlin and project versions by @Mr3zee in https://github.com/Kotlin/kotlinx-rpc/pull/201
* Update renovate and some deps by @Mr3zee in https://github.com/Kotlin/kotlinx-rpc/pull/198

### Other Changes 🧹
* Bump version to 0.3.0-SNAPSHOT by @Mr3zee in https://github.com/Kotlin/kotlinx-rpc/pull/174
* Fix compiler tests after #172 by @Mr3zee in https://github.com/Kotlin/kotlinx-rpc/pull/180
* Remove unused and inactive annotation by @kez-lab in https://github.com/Kotlin/kotlinx-rpc/pull/182
* Use built-in JsClass getter by @Mr3zee in https://github.com/Kotlin/kotlinx-rpc/pull/184
* Update actions/configure-pages action to v5 by @renovate in https://github.com/Kotlin/kotlinx-rpc/pull/200
* Update Samples dependencies by @renovate in https://github.com/Kotlin/kotlinx-rpc/pull/199
* Update Core dependencies (non-major) by @renovate in https://github.com/Kotlin/kotlinx-rpc/pull/194
* Update Core dependencies (non-major) by @renovate in https://github.com/Kotlin/kotlinx-rpc/pull/205

## New Contributors
* @kez-lab made their first contribution in https://github.com/Kotlin/kotlinx-rpc/pull/182

**Full Changelog**: https://github.com/Kotlin/kotlinx-rpc/compare/0.2.4...0.3.0

# 0.2.4
> Published 20 August 2024

Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ Example of plugins setup in a project's `build.gradle.kts`:
plugins {
kotlin("jvm") version "2.0.10"
kotlin("plugin.serialization") version "2.0.10"
id("org.jetbrains.kotlinx.rpc.plugin") version "0.2.4"
id("org.jetbrains.kotlinx.rpc.plugin") version "0.3.0"
}
```

Expand All @@ -106,7 +106,7 @@ plugins {
kotlin("jvm") version "1.9.25"
kotlin("plugin.serialization") version "1.9.25"
id("com.google.devtools.ksp") version "1.9.25-1.0.20"
id("org.jetbrains.kotlinx.rpc.plugin") version "0.2.4"
id("org.jetbrains.kotlinx.rpc.plugin") version "0.3.0"
}
```
### Runtime dependencies
Expand Down Expand Up @@ -166,11 +166,11 @@ based on the project's Kotlin version:
```kotlin
plugins {
kotlin("jvm") version "2.0.10"
id("org.jetbrains.kotlinx.rpc.plugin") version "0.2.4"
id("org.jetbrains.kotlinx.rpc.plugin") version "0.3.0"
}

dependencies {
// version 0.2.4 is set by the Gradle plugin
// version 0.3.0 is set by the Gradle plugin
implementation("org.jetbrains.kotlinx:kotlinx-rpc-core")
}
```
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/kotlinx-rpc/help-versions.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
[
{"version":"0.2.4","url":"/kotlinx-rpc/0.2.4/","isCurrent":true}
{"version":"0.3.0","url":"/kotlinx-rpc/0.3.0/","isCurrent":true}
]
1 change: 1 addition & 0 deletions docs/pages/kotlinx-rpc/rpc.tree
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
</toc-element>
<toc-element topic="versions.topic"/>
<toc-element toc-title="Migration guides">
<toc-element topic="0-3-0.topic"/>
<toc-element topic="0-2-4.topic"/>
<toc-element topic="0-2-1.topic"/>
</toc-element>
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/kotlinx-rpc/topics/0-2-4.topic
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
title="Migration to 0.2.4" id="0-2-4">

<p>
Version <code>0.2.4</code> does introduce any breaking changes.
Version <code>0.2.4</code> does not introduce any breaking changes.
However, it includes some updates that may require additional modifications in user projects.
</p>
<chapter title="Removal of KSP plugin for Kotlin 2.0" id="removal-of-ksp-plugin-for-kotlin-2-0">
Expand Down
254 changes: 254 additions & 0 deletions docs/pages/kotlinx-rpc/topics/0-3-0.topic
Original file line number Diff line number Diff line change
@@ -0,0 +1,254 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
- Copyright 2023-2024 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
-->

<!DOCTYPE topic
SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd">
<topic xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
title="Migration to 0.3.0" id="0-3-0">

<p>
Version <code>0.3.0</code> introduces breaking changes.
</p>
<chapter title="Packages and artifacts changes" id="package-and-artifacts-changes">
This release resolves the issue of kRPC declarations being incorrectly included in non-kRPC artifacts.
All package names have been reviewed and updated to match artifact names and ensure uniqueness across the project.
All APIs were moved permanently without a deprecation cycle due to the size of the change.
The table below contains the full list of the changes.
<p>Removed declarations</p>
<table>
<tr>
<td><code>0.2.4</code></td>
<td><code>0.3.0</code></td>
</tr>
<tr>
<td><code>kotlinx.rpc.client.withService</code></td>
<td>Removed (was deprecated in 0.2.4)</td>
</tr>
<tr>
<td><code>kotlinx.rpc.client.awaitFieldInitialization</code></td>
<td>Removed (was deprecated in 0.2.4)</td>
</tr>
<tr>
<td><code>kotlinx.rpc.client.UninitializedRPCFieldException</code></td>
<td>Removed (was deprecated in 0.2.4)</td>
</tr>
</table>
<p>Declarations that changed the artifact location and package</p>
<table>
<tr>
<td><code>0.2.4</code></td>
<td><code>0.3.0</code></td>
</tr>
<tr>
<td>
<code>kotlinx.rpc.RPCConfig</code>
<p>Artifact: <code>kotlinx-rpc-core</code></p>
</td>
<td>
<code>kotlinx.rpc.krpc.RPCConfig</code>
<p>Artifact: <code>kotlinx-rpc-krpc-core</code></p>
</td>
</tr>
<tr>
<td>
<code>kotlinx.rpc.RPCConfigBuilder</code>
<p>Artifact: <code>kotlinx-rpc-core</code></p>
</td>
<td>
<code>kotlinx.rpc.krpc.RPCConfigBuilder</code>
<p>Artifact: <code>kotlinx-rpc-krpc-core</code></p>
</td>
</tr>
<tr>
<td>
<code>kotlinx.rpc.rpcClientConfig</code>
<p>Artifact: <code>kotlinx-rpc-core</code></p>
</td>
<td>
<code>kotlinx.rpc.krpc.rpcClientConfig</code>
<p>Artifact: <code>kotlinx-rpc-krpc-core</code></p>
</td>
</tr>
<tr>
<td>
<code>kotlinx.rpc.rpcServerConfig</code>
<p>Artifact: <code>kotlinx-rpc-core</code></p>
</td>
<td>
<code>kotlinx.rpc.krpc.rpcServerConfig</code>
<p>Artifact: <code>kotlinx-rpc-krpc-core</code></p>
</td>
</tr>
<tr>
<td>
<code>kotlinx.rpc.RPCTransport</code>
<p>Artifact: <code>kotlinx-rpc-core</code></p>
</td>
<td>
<code>kotlinx.rpc.krpc.RPCTransport</code>
<p>Artifact: <code>kotlinx-rpc-krpc-core</code></p>
</td>
</tr>
<tr>
<td>
<code>kotlinx.rpc.RPCTransportMessage</code>
<p>Artifact: <code>kotlinx-rpc-core</code></p>
</td>
<td>
<code>kotlinx.rpc.krpc.RPCTransportMessage</code>
<p>Artifact: <code>kotlinx-rpc-krpc-core</code></p>
</td>
</tr>
<tr>
<td>
<code>kotlinx.rpc.invokeOnStreamScopeCompletion</code>
<p>Artifact: <code>kotlinx-rpc-core</code></p>
</td>
<td>
<code>kotlinx.rpc.krpc.invokeOnStreamScopeCompletion</code>
<p>Artifact: <code>kotlinx-rpc-krpc-core</code></p>
</td>
</tr>
<tr>
<td>
<code>kotlinx.rpc.streamScoped</code>
<p>Artifact: <code>kotlinx-rpc-core</code></p>
</td>
<td>
<code>kotlinx.rpc.krpc.streamScoped</code>
<p>Artifact: <code>kotlinx-rpc-krpc-core</code></p>
</td>
</tr>
</table>
<p>Declarations that only changed the package</p>
<table>
<tr>
<td><code>0.2.4</code></td>
<td><code>0.3.0</code></td>
</tr>
<tr>
<td>
<code>kotlinx.rpc.client.KRPCClient</code>
</td>
<td>
<code>kotlinx.rpc.krpc.client.KRPCClient</code>
</td>
</tr>
<tr>
<td>
<code>kotlinx.rpc.client.withService</code>
</td>
<td>
<code>kotlinx.rpc.krpc.client.withService</code>
</td>
</tr>
<tr>
<td>
<code>kotlinx.rpc.transport.ktor.client.rpc</code>
</td>
<td>
<code>kotlinx.rpc.krpc.ktor.client.rpc</code>
</td>
</tr>
<tr>
<td>
<code>kotlinx.rpc.transport.ktor.client.KtorRPCClient</code>
</td>
<td>
<code>kotlinx.rpc.krpc.ktor.client.KtorRPCClient</code>
</td>
</tr>
<tr>
<td>
<code>kotlinx.rpc.transport.ktor.client.RPC</code>
</td>
<td>
<code>kotlinx.rpc.krpc.ktor.client.RPC</code>
</td>
</tr>
<tr>
<td>
<code>kotlinx.rpc.transport.ktor.server.RPC</code>
</td>
<td>
<code>kotlinx.rpc.krpc.ktor.server.RPC</code>
</td>
</tr>
<tr>
<td>
<code>kotlinx.rpc.transport.ktor.server.rpc</code>
</td>
<td>
<code>kotlinx.rpc.krpc.ktor.server.rpc</code>
</td>
</tr>
<tr>
<td>
<code>kotlinx.rpc.transport.ktor.server.RPCRoute</code>
</td>
<td>
<code>kotlinx.rpc.krpc.ktor.server.RPCRoute</code>
</td>
</tr>
<tr>
<td>
<code>kotlinx.rpc.serialization.cbor</code>
</td>
<td>
<code>kotlinx.rpc.krpc.serialization.cbor.cbor</code>
</td>
</tr>
<tr>
<td>
<code>kotlinx.rpc.serialization.json</code>
</td>
<td>
<code>kotlinx.rpc.krpc.serialization.json.json</code>
</td>
</tr>
<tr>
<td>
<code>kotlinx.rpc.serialization.protobuf</code>
</td>
<td>
<code>kotlinx.rpc.krpc.serialization.protobuf.protobuf</code>
</td>
</tr>
<tr>
<td>
<code>kotlinx.rpc.serialization.RPCSerialFormat</code>
</td>
<td>
<code>kotlinx.rpc.krpc.serialization.RPCSerialFormat</code>
</td>
</tr>
<tr>
<td>
<code>kotlinx.rpc.serialization.RPCSerialFormatBuilder</code>
</td>
<td>
<code>kotlinx.rpc.krpc.serialization.RPCSerialFormatBuilder</code>
</td>
</tr>
<tr>
<td>
<code>kotlinx.rpc.serialization.RPCSerialFormatConfiguration</code>
</td>
<td>
<code>kotlinx.rpc.krpc.serialization.RPCSerialFormatConfiguration</code>
</td>
</tr>
<tr>
<td>
<code>kotlinx.rpc.server.KRPCServer</code>
</td>
<td>
<code>kotlinx.rpc.krpc.server.KRPCServer</code>
</td>
</tr>
</table>
</chapter>
</topic>
2 changes: 1 addition & 1 deletion docs/pages/kotlinx-rpc/v.list
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<var name="host" value="https://kotlin.github.io"/>

<!-- Library versions -->
<var name="kotlinx-rpc-version" value="0.2.4"/>
<var name="kotlinx-rpc-version" value="0.3.0"/>
<var name="kotlin-version" value="2.0.10"/>
<var name="ksp-version" value="1.9.25-1.0.20"/>
</vars>
4 changes: 2 additions & 2 deletions docs/pages/kotlinx-rpc/writerside.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,5 @@
<images dir="images" web-path="images/"/>
<categories src="c.list"/>
<vars src="v.list"/>
<instance src="rpc.tree" version="0.2.4" web-path="/kotlinx-rpc/"/>
</ihp>
<instance src="rpc.tree" version="0.3.0" web-path="/kotlinx-rpc/"/>
</ihp>
Loading