Skip to content

Commit 72b18ce

Browse files
Mr3zeeMr3zee
committed
Migration guide for 0.3.0 (#212)
1 parent d72ec68 commit 72b18ce

File tree

3 files changed

+256
-1
lines changed

3 files changed

+256
-1
lines changed

‎docs/pages/kotlinx-rpc/rpc.tree

+1
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
</toc-element>
2727
<toc-element topic="versions.topic"/>
2828
<toc-element toc-title="Migration guides">
29+
<toc-element topic="0-3-0.topic"/>
2930
<toc-element topic="0-2-4.topic"/>
3031
<toc-element topic="0-2-1.topic"/>
3132
</toc-element>

‎docs/pages/kotlinx-rpc/topics/0-2-4.topic

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
title="Migration to 0.2.4" id="0-2-4">
1111

1212
<p>
13-
Version <code>0.2.4</code> does introduce any breaking changes.
13+
Version <code>0.2.4</code> does not introduce any breaking changes.
1414
However, it includes some updates that may require additional modifications in user projects.
1515
</p>
1616
<chapter title="Removal of KSP plugin for Kotlin 2.0" id="removal-of-ksp-plugin-for-kotlin-2-0">

‎docs/pages/kotlinx-rpc/topics/0-3-0.topic

+254
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,254 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!--
3+
- Copyright 2023-2024 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
4+
-->
5+
6+
<!DOCTYPE topic
7+
SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd">
8+
<topic xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
9+
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
10+
title="Migration to 0.3.0" id="0-3-0">
11+
12+
<p>
13+
Version <code>0.3.0</code> introduces breaking changes.
14+
</p>
15+
<chapter title="Packages and artifacts changes" id="package-and-artifacts-changes">
16+
This release resolves the issue of kRPC declarations being incorrectly included in non-kRPC artifacts.
17+
All package names have been reviewed and updated to match artifact names and ensure uniqueness across the project.
18+
All APIs were moved permanently without a deprecation cycle due to the size of the change.
19+
The table below contains the full list of the changes.
20+
<p>Removed declarations</p>
21+
<table>
22+
<tr>
23+
<td><code>0.2.4</code></td>
24+
<td><code>0.3.0</code></td>
25+
</tr>
26+
<tr>
27+
<td><code>kotlinx.rpc.client.withService</code></td>
28+
<td>Removed (was deprecated in 0.2.4)</td>
29+
</tr>
30+
<tr>
31+
<td><code>kotlinx.rpc.client.awaitFieldInitialization</code></td>
32+
<td>Removed (was deprecated in 0.2.4)</td>
33+
</tr>
34+
<tr>
35+
<td><code>kotlinx.rpc.client.UninitializedRPCFieldException</code></td>
36+
<td>Removed (was deprecated in 0.2.4)</td>
37+
</tr>
38+
</table>
39+
<p>Declarations that changed the artifact location and package</p>
40+
<table>
41+
<tr>
42+
<td><code>0.2.4</code></td>
43+
<td><code>0.3.0</code></td>
44+
</tr>
45+
<tr>
46+
<td>
47+
<code>kotlinx.rpc.RPCConfig</code>
48+
<p>Artifact: <code>kotlinx-rpc-core</code></p>
49+
</td>
50+
<td>
51+
<code>kotlinx.rpc.krpc.RPCConfig</code>
52+
<p>Artifact: <code>kotlinx-rpc-krpc-core</code></p>
53+
</td>
54+
</tr>
55+
<tr>
56+
<td>
57+
<code>kotlinx.rpc.RPCConfigBuilder</code>
58+
<p>Artifact: <code>kotlinx-rpc-core</code></p>
59+
</td>
60+
<td>
61+
<code>kotlinx.rpc.krpc.RPCConfigBuilder</code>
62+
<p>Artifact: <code>kotlinx-rpc-krpc-core</code></p>
63+
</td>
64+
</tr>
65+
<tr>
66+
<td>
67+
<code>kotlinx.rpc.rpcClientConfig</code>
68+
<p>Artifact: <code>kotlinx-rpc-core</code></p>
69+
</td>
70+
<td>
71+
<code>kotlinx.rpc.krpc.rpcClientConfig</code>
72+
<p>Artifact: <code>kotlinx-rpc-krpc-core</code></p>
73+
</td>
74+
</tr>
75+
<tr>
76+
<td>
77+
<code>kotlinx.rpc.rpcServerConfig</code>
78+
<p>Artifact: <code>kotlinx-rpc-core</code></p>
79+
</td>
80+
<td>
81+
<code>kotlinx.rpc.krpc.rpcServerConfig</code>
82+
<p>Artifact: <code>kotlinx-rpc-krpc-core</code></p>
83+
</td>
84+
</tr>
85+
<tr>
86+
<td>
87+
<code>kotlinx.rpc.RPCTransport</code>
88+
<p>Artifact: <code>kotlinx-rpc-core</code></p>
89+
</td>
90+
<td>
91+
<code>kotlinx.rpc.krpc.RPCTransport</code>
92+
<p>Artifact: <code>kotlinx-rpc-krpc-core</code></p>
93+
</td>
94+
</tr>
95+
<tr>
96+
<td>
97+
<code>kotlinx.rpc.RPCTransportMessage</code>
98+
<p>Artifact: <code>kotlinx-rpc-core</code></p>
99+
</td>
100+
<td>
101+
<code>kotlinx.rpc.krpc.RPCTransportMessage</code>
102+
<p>Artifact: <code>kotlinx-rpc-krpc-core</code></p>
103+
</td>
104+
</tr>
105+
<tr>
106+
<td>
107+
<code>kotlinx.rpc.invokeOnStreamScopeCompletion</code>
108+
<p>Artifact: <code>kotlinx-rpc-core</code></p>
109+
</td>
110+
<td>
111+
<code>kotlinx.rpc.krpc.invokeOnStreamScopeCompletion</code>
112+
<p>Artifact: <code>kotlinx-rpc-krpc-core</code></p>
113+
</td>
114+
</tr>
115+
<tr>
116+
<td>
117+
<code>kotlinx.rpc.streamScoped</code>
118+
<p>Artifact: <code>kotlinx-rpc-core</code></p>
119+
</td>
120+
<td>
121+
<code>kotlinx.rpc.krpc.streamScoped</code>
122+
<p>Artifact: <code>kotlinx-rpc-krpc-core</code></p>
123+
</td>
124+
</tr>
125+
</table>
126+
<p>Declarations that only changed the package</p>
127+
<table>
128+
<tr>
129+
<td><code>0.2.4</code></td>
130+
<td><code>0.3.0</code></td>
131+
</tr>
132+
<tr>
133+
<td>
134+
<code>kotlinx.rpc.client.KRPCClient</code>
135+
</td>
136+
<td>
137+
<code>kotlinx.rpc.krpc.client.KRPCClient</code>
138+
</td>
139+
</tr>
140+
<tr>
141+
<td>
142+
<code>kotlinx.rpc.client.withService</code>
143+
</td>
144+
<td>
145+
<code>kotlinx.rpc.krpc.client.withService</code>
146+
</td>
147+
</tr>
148+
<tr>
149+
<td>
150+
<code>kotlinx.rpc.transport.ktor.client.rpc</code>
151+
</td>
152+
<td>
153+
<code>kotlinx.rpc.krpc.ktor.client.rpc</code>
154+
</td>
155+
</tr>
156+
<tr>
157+
<td>
158+
<code>kotlinx.rpc.transport.ktor.client.KtorRPCClient</code>
159+
</td>
160+
<td>
161+
<code>kotlinx.rpc.krpc.ktor.client.KtorRPCClient</code>
162+
</td>
163+
</tr>
164+
<tr>
165+
<td>
166+
<code>kotlinx.rpc.transport.ktor.client.RPC</code>
167+
</td>
168+
<td>
169+
<code>kotlinx.rpc.krpc.ktor.client.RPC</code>
170+
</td>
171+
</tr>
172+
<tr>
173+
<td>
174+
<code>kotlinx.rpc.transport.ktor.server.RPC</code>
175+
</td>
176+
<td>
177+
<code>kotlinx.rpc.krpc.ktor.server.RPC</code>
178+
</td>
179+
</tr>
180+
<tr>
181+
<td>
182+
<code>kotlinx.rpc.transport.ktor.server.rpc</code>
183+
</td>
184+
<td>
185+
<code>kotlinx.rpc.krpc.ktor.server.rpc</code>
186+
</td>
187+
</tr>
188+
<tr>
189+
<td>
190+
<code>kotlinx.rpc.transport.ktor.server.RPCRoute</code>
191+
</td>
192+
<td>
193+
<code>kotlinx.rpc.krpc.ktor.server.RPCRoute</code>
194+
</td>
195+
</tr>
196+
<tr>
197+
<td>
198+
<code>kotlinx.rpc.serialization.cbor</code>
199+
</td>
200+
<td>
201+
<code>kotlinx.rpc.krpc.serialization.cbor.cbor</code>
202+
</td>
203+
</tr>
204+
<tr>
205+
<td>
206+
<code>kotlinx.rpc.serialization.json</code>
207+
</td>
208+
<td>
209+
<code>kotlinx.rpc.krpc.serialization.json.json</code>
210+
</td>
211+
</tr>
212+
<tr>
213+
<td>
214+
<code>kotlinx.rpc.serialization.protobuf</code>
215+
</td>
216+
<td>
217+
<code>kotlinx.rpc.krpc.serialization.protobuf.protobuf</code>
218+
</td>
219+
</tr>
220+
<tr>
221+
<td>
222+
<code>kotlinx.rpc.serialization.RPCSerialFormat</code>
223+
</td>
224+
<td>
225+
<code>kotlinx.rpc.krpc.serialization.RPCSerialFormat</code>
226+
</td>
227+
</tr>
228+
<tr>
229+
<td>
230+
<code>kotlinx.rpc.serialization.RPCSerialFormatBuilder</code>
231+
</td>
232+
<td>
233+
<code>kotlinx.rpc.krpc.serialization.RPCSerialFormatBuilder</code>
234+
</td>
235+
</tr>
236+
<tr>
237+
<td>
238+
<code>kotlinx.rpc.serialization.RPCSerialFormatConfiguration</code>
239+
</td>
240+
<td>
241+
<code>kotlinx.rpc.krpc.serialization.RPCSerialFormatConfiguration</code>
242+
</td>
243+
</tr>
244+
<tr>
245+
<td>
246+
<code>kotlinx.rpc.server.KRPCServer</code>
247+
</td>
248+
<td>
249+
<code>kotlinx.rpc.krpc.server.KRPCServer</code>
250+
</td>
251+
</tr>
252+
</table>
253+
</chapter>
254+
</topic>

0 commit comments

Comments
 (0)