Prepare 1.0.0 release

Co-authored-by: Vsevolod Tolstopyatov <qwwdfsad@gmail.com>

Author: sandwwraith

CHANGELOG.md

@@ -1,3 +1,20 @@
+1.0.0 / 2020-10-08
+==================
+
+The first public stable release, yay!
+The definitions of stability and backwards compatibility guarantees are located in the [corresponding document](docs/compatibility.md).
+We now also have a GitHub Pages site with [full API reference](https://kotlin.github.io/kotlinx.serialization/).
+
+Compared to RC2, no new features apart from #947 were added and all previously deprecated declarations and migrations were deleted. 
+If you are using RC/RC2 along with deprecated declarations, please, migrate before updating to 1.0.0.
+In case you are using pre-1.0 versions (e.g. 0.20.0), please refer to our [migration guide](docs/migration.md).
+  
+### Bugfixes and improvements
+
+  * Support nullable types at top-level for JsonElement decoding (#1117)
+  * Add CBOR ignoreUnknownKeys option (#947) (thanks to [Travis Wyatt](https://github.com/twyatt))
+  * Fix incorrect documentation of `encodeDefaults` (#1108) (thanks to [Anders Carling](https://github.com/anderscarling))
+  
 1.0.0-RC2 / 2020-09-21
 ==================
 

README.md

@@ -3,7 +3,7 @@
 [![official JetBrains 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)
-[![Download](https://api.bintray.com/packages/kotlin/kotlinx/kotlinx.serialization.runtime/images/download.svg?version=1.0.0-RC2) ](https://bintray.com/kotlin/kotlinx/kotlinx.serialization.runtime/1.0.0-RC2)
+[![Download](https://api.bintray.com/packages/kotlin/kotlinx/kotlinx.serialization.runtime/images/download.svg?version=1.0.0) ](https://bintray.com/kotlin/kotlinx/kotlinx.serialization.runtime/1.0.0)
 
 Kotlin serialization consists of a compiler plugin, that generates visitor code for serializable classes,
  runtime library with core serialization API and support libraries with various serialization formats.
@@ -61,6 +61,8 @@ Project(name=kotlinx.serialization, language=Kotlin)
 
 **Read the [Kotlin Serialization Guide](docs/serialization-guide.md) for all details.**
 
+You can find auto-generated documentation website on [GitHub Pages](https://kotlin.github.io/kotlinx.serialization/).
+
 ## Setup
 
 Kotlin serialization plugin is shipped with the Kotlin compiler distribution, and the IDEA plugin is bundled into the Kotlin plugin.
@@ -93,7 +95,7 @@ plugins {
 }
 ```
 
-> Kotlin versions before are not supported by the stable release of Kotlin serialization
+> Kotlin versions before 1.4.0 are not supported by the stable release of Kotlin serialization
 
 #### Using `apply plugin` (the old way)
 
@@ -141,30 +143,31 @@ Kotlin DSL:
 
 ```kotlin
 repositories {
-    // artifacts are published to JCenter
+    // Artifacts are also available on Maven Central
     jcenter()
 }
 
 dependencies {
     implementation(kotlin("stdlib", KotlinCompilerVersion.VERSION)) // or "stdlib-jdk8"
-    implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:1.0.0-RC2") // JVM dependency
+    implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:1.0.0")
 }
 ```
 
 Groovy DSL:
 
 ```gradle
 repositories {
+    // Artifacts are also available on Maven Central
     jcenter()
 }
 
 dependencies {
     implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version" // or "kotlin-stdlib-jdk8"
-    implementation "org.jetbrains.kotlinx:kotlinx-serialization-json:1.0.0-RC2" // JVM dependency
+    implementation "org.jetbrains.kotlinx:kotlinx-serialization-json:1.0.0"
 }
 ```
 
->We also provide kotlinx-serialization-core artifact that contains all serialization API but does not have bundled serialization format with it
+>We also provide `kotlinx-serialization-core` artifact that contains all serialization API but does not have bundled serialization format with it
 
 ### Android
 
@@ -192,8 +195,8 @@ You can add dependency to the required module right to the common source set:
 ```gradle
 commonMain {
     dependencies {
+        // Works as common dependency as well as the platform one
         implementation "org.jetbrains.kotlinx:kotlinx-serialization-json:$serialization_version"
-        implementation "org.jetbrains.kotlinx:kotlinx-serialization-protobuf:$serialization_version"
     }
 }
 ```
@@ -206,7 +209,7 @@ Ensure the proper version of Kotlin and serialization version:
 ```xml
 <properties>
     <kotlin.version>1.4.10</kotlin.version>
-    <serialization.version>1.0.0-RC2</serialization.version>
+    <serialization.version>1.0.0</serialization.version>
 </properties>
 ```
 

docs/compatibility.md

@@ -14,36 +14,36 @@ since Kotlin/Native and Kotlin/JS are experimental themselves and currently do n
 ## Core library compatibility
 
 Core library public API comes in three flavours: general (stable), experimental, and internal.
-ll public API except stable is marked with the corresponding annotation.
+All public API except stable is marked with the corresponding annotation.
 To learn how to use declarations that require opt-in, please refer to [corresponding documentation page](https://kotlinlang.org/docs/reference/opt-in-requirements.html#non-propagating-use).
 
 ### Stable API
 
 Stable API is guaranteed to preserve its ABI and documented semantics:
 
-* It cannot change its semantics expressed in its documentation
+* It cannot change its semantics expressed in its documentation.
 * It is binary backwards-compatible: during update of `kotlinx.serialization` version, previously compiled code will continue to work.
     For example, for a library that depends only on `kotlinx.serialization` stable API,
     clients of the library can easily depend on a next `kotlinx.serialization` version and expect everything to work.
 * It is source backwards compatible modulo major deprecation. Most of the API is here to stay forever,
-unless an unfixable security or design flaw is exposed. Minor releases never add source-incompatible changes to stable API
+unless an unfixable security or design flaw is exposed. Minor releases never add source-incompatible changes to the stable API.
 
 #### Deprecation cycle
 
 When API is deprecated, it goes through multiple stages and there is at least one major release between each stages.
 
-Feature is deprecated with compilation warning. Most of the time, proper replacement (and corresponding `replaceWith` declaration) is provided to automatically migrate deprecated usages with a help of IntelliJ IDEA.
-Deprecation level is increased to error or hidden. It is no longer possible to compile new code against deprecated API, though it is still present in the ABI.
-API is completely removed. While we give our best efforts not to do so and have no plans of removing any API, we still are leaving this option in case of unforeseen problems such as security issues. 
+1. Feature is deprecated with compilation warning. Most of the time, proper replacement (and corresponding `replaceWith` declaration) is provided to automatically migrate deprecated usages with a help of IntelliJ IDEA.
+2. Deprecation level is increased to error or hidden. It is no longer possible to compile new code against deprecated API, though it is still present in the ABI.
+3. API is completely removed. While we give our best efforts not to do so and have no plans of removing any API, we still are leaving this option in case of unforeseen problems such as security issues. 
 
 
 ### Experimental API
 
 This API marked as `@ExperimentalSerializationApi`. API is marked experimental when its design has potential open questions which may eventually lead to either semantics changes of the API or its deprecation.
-By default, most of the new API is marked as experimental and becomes stable in one of the next major releases if no new issues arise. Otherwise, either semantics is fixed without changes in ABI or API goes through deprecation cycle.
+By default, most of the new API is marked as experimental and becomes stable in one of the next releases if no new issues arise. Otherwise, either semantics is fixed without changes in ABI or API goes through deprecation cycle.
 
 However, we'll try to provide best-effort compatibility — such declarations won't be deleted or changed instantly,
-they will go through deprecation cycle if this is possible. However, these deprecation cycle may be faster than usual.
+they will go through deprecation cycle if this is possible. However, this deprecation cycle may be faster than usual.
 
 Usage notes:
 

docs/migration.md

@@ -7,12 +7,13 @@ with automatic replacements.
 
 To simplify your migrations path, it is recommended to enable star imports in IDE (so all extensions are imported automatically) first.
 
-1. Update `kotlinx.serialization` to version 1.0.0-RC2 (this is the last version that has migrations for pre-1.0.0 versions)
-2. Rename dependency from `kotlinx-serialization-runtime` to `kotlinx-serialization-json`
+1. Update `kotlinx.serialization` to version `1.0.0-RC2` (this is the last version that has migrations for pre-1.0.0 versions. 1.0.0 version itself does not have any migration aids.)
+2. Rename dependency from `kotlinx-serialization-runtime` to `kotlinx-serialization-json`.
 3. For multiplatform usages, remove dependencies to platform-specific artifacts (e.g. `kotlinx-serialization-runtime-js`), they are [no longer required](/README.md#multiplatform-common-js-native) by Gradle.
-4. Update Kotlin to 1.4.0
-5. Start applying replacements for the deprecated code
-6. If some signatures are not resolved, try to hit `alt + Enter` and import the signature
-7. If methods are still not resolved, it is recommended to use star imports for `kotlinx.serialization` signatures in the problematic file
+4. Update Kotlin to 1.4.0 or higher.
+5. Start applying replacements for the deprecated code.
+6. If some signatures are not resolved, try to hit `alt + Enter` and import the signature.
+7. If methods are still not resolved, it is recommended to use star imports for `kotlinx.serialization` signatures in the problematic file.
+8. When there are no usages of deprecated code left, you can change dependency version from `1.0.0-RC2` to `1.0.0`.
 
-For less trivial issues, it is recommended to study [the changelog](../CHANGELOG.md#100-rc--2020-08-17) or to ask for help in `#serialization` Slack channel.
+For less trivial issues, it is recommended to study [the changelog](../CHANGELOG.md#100-rc--2020-08-17) or to ask for help in `#serialization` Kotlin's Slack channel.

gradle.properties

@@ -3,7 +3,7 @@
 #
 
 group=org.jetbrains.kotlinx
-version=1.0.0-RC2
+version=1.0.0
 
 kotlin.version=1.4.10
 

integration-test/gradle.properties

@@ -3,7 +3,7 @@
 #
 
 mainKotlinVersion=1.4.10
-mainLibVersion=1.0.0-RC2
+mainLibVersion=1.0.0
 
 kotlin.code.style=official
 kotlin.js.compiler=both