Prepare 1.8.0-RC release (#2880)

Author: sandwwraith

CHANGELOG.md

@@ -1,3 +1,67 @@
+1.8.0-RC / 2024-13-10
+==================
+
+This is a release candidate for the next version. It is based on Kotlin 2.1.0 and includes a few new features, as well
+as bugfixes and improvements:
+
+## `@JsonIgnoreUnknownKeys` annotation
+
+Previously, only global setting `JsonBuilder.ignoreUnknownKeys` controlled whether Json parser would throw exception if
+input contained a property that was not declared in a `@Serializable` class.
+There were [a lot of complaints](https://github.com/Kotlin/kotlinx.serialization/issues/1420) that this setting is not
+flexible enough.
+To address them, we added new `@JsonIgnoreUnknownKeys` annotation that can be applied on a per-class basis.
+With this annotation, it is possible to allow unknown properties for annotated classes, while
+general decoding methods (such as `Json.decodeFromString` and others) would still reject them for everything else.
+See details in the corresponding [PR](https://github.com/Kotlin/kotlinx.serialization/pull/2874).
+
+## Stabilization of `SerialDescriptor` API and `@SealedSerializationApi` annotation
+
+`SerialDescriptor`, `SerialKind`, and related API has been around for a long time and has proven itself useful.
+The main reason `@ExperimentalSerializationApi` was on SerialDescriptor's properties is that we wanted to discourage
+people from subclassing it.
+Fortunately, Kotlin 2.1 provides a special mechanism for such a
+case — [SubclassOptInRequired](https://kotlinlang.org/docs/opt-in-requirements.html#opt-in-to-inherit-from-a-class-or-interface).
+New `kotlinx.serialization.SealedSerializationApi` annotation designates APIs
+as public for use, but closed for implementation — the case for SerialDescriptor, which is a non-sealed interface for
+technical reasons.
+Now you can use most of `SerialDescriptor` and its builders API without the need to opt-in into experimental
+serialization API.
+See the [PR](https://github.com/Kotlin/kotlinx.serialization/pull/2827) for more details.
+
+_Note_: All `SerialKind`s are stable API now, except `PolymorphicKind` — we may want to expand it in the future.
+
+## Generate Java 8's default method implementations in interfaces
+
+**TL;DR This change ensures better binary compatibility in the future for library. You should not experience any
+difference from it.**
+
+kotlinx.serialization library contains a lot of interfaces with default method implementations. Historically, Kotlin
+compiled a synthetic `DefaultImpls` class for them.
+[Starting from Kotlin 1.4](https://blog.jetbrains.com/kotlin/2020/07/kotlin-1-4-m3-generating-default-methods-in-interfaces/),
+it was possible to compile them using as Java 8's `default` methods to ensure
+that new methods can still be added to interfaces without the need for implementors to recompile.
+To preserve binary compatibility with existing clients, a special `all-compatbility` mode is supported in compiler
+to generate both `default` methods and synthetic `DefaultImpls` class.
+
+Now, kotlinx.serialization finally makes use of this `all-compatibility` mode,
+which potentially allows us to add new methods to interfaces such as `SerialDescriptor`, `Encoder`, `Decoder`, etc.,
+without breaking existing clients. This change is expected to have no effect on existing clients, and no action from
+your side is required.
+Note that Kotlin 2.2 plans to enable `all-compatibility`
+mode [by default](https://youtrack.jetbrains.com/issue/KTLC-269).
+
+## Other bugfixes and improvements
+
+* Correctly skip structures with Cbor.ignoreUnknownKeys setting (#2873)
+* Handle missing system property without NPE (#2867)
+* Fixed keeping INSTANCE field and serializer function for serializable objects in R8 full mode (#2865)
+* Correctly parse invalid numbers in JsonLiteral.long and other extensions (#2852)
+* Correctly handle serial name conflict for different classes in SerializersModule.overwriteWith (#2856)
+* Add inline reified version of encodeToString as a Json member to streamline the experience for newcomers. (#2853)
+* Do not check kind or discriminator collisions for subclasses' polymorphic serializers if Json.classDiscriminatorMode
+  is set to NONE (#2833)
+
 1.7.3 / 2024-09-19
 ==================
 

README.md

@@ -4,8 +4,8 @@
 [![JetBrains official project](https://jb.gg/badges/official.svg)](https://confluence.jetbrains.com/display/ALL/JetBrains+on+GitHub)
 [![GitHub license](https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg?style=flat)](http://www.apache.org/licenses/LICENSE-2.0)
 [![TeamCity build](https://img.shields.io/teamcity/http/teamcity.jetbrains.com/s/KotlinTools_KotlinxSerialization_Ko.svg)](https://teamcity.jetbrains.com/viewType.html?buildTypeId=KotlinTools_KotlinxSerialization_Ko&guest=1)
-[![Kotlin](https://img.shields.io/badge/kotlin-2.0.20-blue.svg?logo=kotlin)](http://kotlinlang.org)
-[![Maven Central](https://img.shields.io/maven-central/v/org.jetbrains.kotlinx/kotlinx-serialization-core/1.7.3)](https://central.sonatype.com/artifact/org.jetbrains.kotlinx/kotlinx-serialization-core/1.7.3)
+[![Kotlin](https://img.shields.io/badge/kotlin-2.1.0-blue.svg?logo=kotlin)](http://kotlinlang.org)
+[![Maven Central](https://img.shields.io/maven-central/v/org.jetbrains.kotlinx/kotlinx-serialization-core/1.8.0-RC)](https://central.sonatype.com/artifact/org.jetbrains.kotlinx/kotlinx-serialization-core/1.8.0-RC)
 [![KDoc link](https://img.shields.io/badge/API_reference-KDoc-blue)](https://kotlinlang.org/api/kotlinx.serialization/)
 [![Slack channel](https://img.shields.io/badge/chat-slack-blue.svg?logo=slack)](https://kotlinlang.slack.com/messages/serialization/)
 
@@ -95,17 +95,17 @@ Kotlin DSL:
 
 ```kotlin
 plugins {
-    kotlin("jvm") version "2.0.20" // or kotlin("multiplatform") or any other kotlin plugin
-    kotlin("plugin.serialization") version "2.0.20"
+    kotlin("jvm") version "2.1.0" // or kotlin("multiplatform") or any other kotlin plugin
+    kotlin("plugin.serialization") version "2.1.0"
 }
 ```       
 
 Groovy DSL:
 
 ```gradle
 plugins {
-    id 'org.jetbrains.kotlin.multiplatform' version '2.0.20'
-    id 'org.jetbrains.kotlin.plugin.serialization' version '2.0.20'
+    id 'org.jetbrains.kotlin.multiplatform' version '2.1.0'
+    id 'org.jetbrains.kotlin.plugin.serialization' version '2.1.0'
 }
 ```
 
@@ -123,7 +123,7 @@ buildscript {
     repositories { mavenCentral() }
 
     dependencies {
-        val kotlinVersion = "2.0.20"
+        val kotlinVersion = "2.1.0"
         classpath(kotlin("gradle-plugin", version = kotlinVersion))
         classpath(kotlin("serialization", version = kotlinVersion))
     }
@@ -134,7 +134,7 @@ Groovy DSL:
 
 ```gradle
 buildscript {
-    ext.kotlin_version = '2.0.20'
+    ext.kotlin_version = '2.1.0'
     repositories { mavenCentral() }
 
     dependencies {
@@ -164,7 +164,7 @@ repositories {
 }
 
 dependencies {
-    implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:1.7.3")
+    implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:1.8.0-RC")
 }
 ```
 
@@ -176,7 +176,7 @@ repositories {
 }
 
 dependencies {
-    implementation "org.jetbrains.kotlinx:kotlinx-serialization-json:1.7.3"
+    implementation "org.jetbrains.kotlinx:kotlinx-serialization-json:1.8.0-RC"
 }
 ```
 
@@ -266,8 +266,8 @@ Ensure the proper version of Kotlin and serialization version:
 
 ```xml
 <properties>
-    <kotlin.version>2.0.20</kotlin.version>
-    <serialization.version>1.7.3</serialization.version>
+    <kotlin.version>2.1.0</kotlin.version>
+    <serialization.version>1.8.0-RC</serialization.version>
 </properties>
 ```
 

gradle.properties

@@ -3,7 +3,7 @@
 #
 
 group=org.jetbrains.kotlinx
-version=1.7.4-SNAPSHOT
+version=1.8.0-SNAPSHOT
 jdk_toolchain_version=11
 
 # This version takes precedence if 'bootstrap' property passed to project

integration-test/gradle.properties

@@ -3,7 +3,7 @@
 #
 
 mainKotlinVersion=2.1.0
-mainLibVersion=1.7.4-SNAPSHOT
+mainLibVersion=1.8.0-SNAPSHOT
 
 kotlin.code.style=official
 kotlin.js.compiler=ir