Skip to content

Commit 70570f8

Browse files
Mr3zeeMr3zee
committed
Migration guide for 0.3.0
1 parent ee50949 commit 70570f8

File tree

3 files changed

+238
-1
lines changed

3 files changed

+238
-1
lines changed

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

Lines changed: 1 addition & 0 deletions
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‎

Lines changed: 1 addition & 1 deletion
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‎

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

0 commit comments

Comments
 (0)