Skip to content

Commit c2f3c71

Browse files
committed
Merge remote-tracking branch 'origin/master' into dev
2 parents df3a161 + 08bfef6 commit c2f3c71

13 files changed

+191
-233
lines changed

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -343,7 +343,7 @@ This patch release contains several feature improvements as well as bugfixes and
343343

344344
The first public stable release, yay!
345345
The definitions of stability and backwards compatibility guarantees are located in the [corresponding document](docs/compatibility.md).
346-
We now also have a GitHub Pages site with [full API reference](https://kotlin.github.io/kotlinx.serialization/).
346+
We now also have a GitHub Pages site with [full API reference](https://kotlinlang.org/api/kotlinx.serialization/).
347347

348348
Compared to RC2, no new features apart from #947 were added and all previously deprecated declarations and migrations were deleted.
349349
If you are using RC/RC2 along with deprecated declarations, please, migrate before updating to 1.0.0.

README.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
# Kotlin multiplatform / multi-format reflectionless serialization
22

3-
[![official JetBrains project](https://jb.gg/badges/official.svg)](https://confluence.jetbrains.com/display/ALL/JetBrains+on+GitHub)
3+
[![Kotlin Stable](https://kotl.in/badges/stable.svg)](https://kotlinlang.org/docs/components-stability.html)
4+
[![JetBrains official project](https://jb.gg/badges/official.svg)](https://confluence.jetbrains.com/display/ALL/JetBrains+on+GitHub)
45
[![GitHub license](https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg?style=flat)](http://www.apache.org/licenses/LICENSE-2.0)
56
[![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)
6-
[![Kotlin](https://img.shields.io/badge/kotlin-1.6.10-blue.svg?logo=kotlin)](http://kotlinlang.org)
7+
[![Kotlin](https://img.shields.io/badge/kotlin-1.6.21-blue.svg?logo=kotlin)](http://kotlinlang.org)
78
[![Maven Central](https://img.shields.io/maven-central/v/org.jetbrains.kotlinx/kotlinx-serialization-core/1.3.3)](https://search.maven.org/artifact/org.jetbrains.kotlinx/kotlinx-serialization-core/1.3.3/pom)
8-
[![KDoc link](https://img.shields.io/badge/API_reference-KDoc-blue)](https://kotlin.github.io/kotlinx.serialization/)
9+
[![KDoc link](https://img.shields.io/badge/API_reference-KDoc-blue)](https://kotlinlang.org/api/kotlinx.serialization/)
910
[![Slack channel](https://img.shields.io/badge/chat-slack-blue.svg?logo=slack)](https://kotlinlang.slack.com/messages/serialization/)
1011

1112
Kotlin serialization consists of a compiler plugin, that generates visitor code for serializable classes,
@@ -33,7 +34,7 @@ Kotlin serialization consists of a compiler plugin, that generates visitor code
3334

3435
* **Additional links**
3536
* [Kotlin Serialization Guide](docs/serialization-guide.md)
36-
* [Full API reference](https://kotlin.github.io/kotlinx.serialization/)
37+
* [Full API reference](https://kotlinlang.org/api/kotlinx.serialization/)
3738

3839
## Introduction and references
3940

@@ -68,7 +69,7 @@ Project(name=kotlinx.serialization, language=Kotlin)
6869

6970
**Read the [Kotlin Serialization Guide](docs/serialization-guide.md) for all details.**
7071

71-
You can find auto-generated documentation website on [GitHub Pages](https://kotlin.github.io/kotlinx.serialization/).
72+
You can find auto-generated documentation website on [kotlinlang.org](https://kotlinlang.org/api/kotlinx.serialization/).
7273

7374
## Setup
7475

@@ -88,17 +89,17 @@ Kotlin DSL:
8889

8990
```kotlin
9091
plugins {
91-
kotlin("jvm") version "1.6.10" // or kotlin("multiplatform") or any other kotlin plugin
92-
kotlin("plugin.serialization") version "1.6.10"
92+
kotlin("jvm") version "1.6.21" // or kotlin("multiplatform") or any other kotlin plugin
93+
kotlin("plugin.serialization") version "1.6.21"
9394
}
9495
```
9596

9697
Groovy DSL:
9798

9899
```gradle
99100
plugins {
100-
id 'org.jetbrains.kotlin.multiplatform' version '1.6.10'
101-
id 'org.jetbrains.kotlin.plugin.serialization' version '1.6.10'
101+
id 'org.jetbrains.kotlin.multiplatform' version '1.6.21'
102+
id 'org.jetbrains.kotlin.plugin.serialization' version '1.6.21'
102103
}
103104
```
104105

@@ -115,7 +116,7 @@ buildscript {
115116
repositories { mavenCentral() }
116117

117118
dependencies {
118-
val kotlinVersion = "1.6.10"
119+
val kotlinVersion = "1.6.21"
119120
classpath(kotlin("gradle-plugin", version = kotlinVersion))
120121
classpath(kotlin("serialization", version = kotlinVersion))
121122
}
@@ -126,7 +127,7 @@ Groovy DSL:
126127

127128
```gradle
128129
buildscript {
129-
ext.kotlin_version = '1.6.10'
130+
ext.kotlin_version = '1.6.21'
130131
repositories { mavenCentral() }
131132
132133
dependencies {
@@ -285,7 +286,7 @@ Ensure the proper version of Kotlin and serialization version:
285286

286287
```xml
287288
<properties>
288-
<kotlin.version>1.6.10</kotlin.version>
289+
<kotlin.version>1.6.21</kotlin.version>
289290
<serialization.version>1.3.3</serialization.version>
290291
</properties>
291292
```

RELEASING.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,8 @@ If review is not required, commit directly to `dev`.
4242
* Release it.
4343

4444
5. Update documentation website:<br>
45-
`./update_docs.sh <version> push`
45+
* Set new value for [`kotlinx.serialization.release.tag`](https://buildserver.labs.intellij.net/admin/editProject.html?projectId=Kotlin_KotlinSites_Builds_KotlinlangOrg_LibrariesAPIs&tab=projectParams)
46+
* And run deploy [configuration](https://buildserver.labs.intellij.net/buildConfiguration/Kotlin_KotlinSites_Builds_KotlinlangOrg_KotlinSerializationApi?branch=%3Cdefault%3E&mode=builds)
4647

4748
6. Create a new release in [Github releases](https://github.com/Kotlin/kotlinx.serialization/releases). Use created git tag for title and changelog message for body.
4849

build.gradle

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ apiValidation {
9090
}
9191

9292
knit {
93-
siteRoot = "https://kotlin.github.io/kotlinx.serialization"
93+
siteRoot = "https://kotlinlang.org/api/kotlinx.serialization/"
9494
moduleDocs = "build/dokka/htmlMultiModule"
9595
}
9696

docs/basic-serialization.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -687,14 +687,14 @@ The next chapter covers [Builtin classes](builtin-classes.md).
687687
<!--- MODULE /kotlinx-serialization-core -->
688688
<!--- INDEX kotlinx-serialization-core/kotlinx.serialization -->
689689

690-
[kotlinx.serialization.encodeToString]: https://kotlin.github.io/kotlinx.serialization/kotlinx-serialization-core/kotlinx.serialization/encode-to-string.html
691-
[Serializable]: https://kotlin.github.io/kotlinx.serialization/kotlinx-serialization-core/kotlinx.serialization/-serializable/index.html
692-
[kotlinx.serialization.decodeFromString]: https://kotlin.github.io/kotlinx.serialization/kotlinx-serialization-core/kotlinx.serialization/decode-from-string.html
693-
[Required]: https://kotlin.github.io/kotlinx.serialization/kotlinx-serialization-core/kotlinx.serialization/-required/index.html
694-
[Transient]: https://kotlin.github.io/kotlinx.serialization/kotlinx-serialization-core/kotlinx.serialization/-transient/index.html
695-
[EncodeDefault]: https://kotlin.github.io/kotlinx.serialization/kotlinx-serialization-core/kotlinx.serialization/-encode-default/index.html
696-
[EncodeDefault.Mode]: https://kotlin.github.io/kotlinx.serialization/kotlinx-serialization-core/kotlinx.serialization/-encode-default/-mode/index.html
697-
[SerialName]: https://kotlin.github.io/kotlinx.serialization/kotlinx-serialization-core/kotlinx.serialization/-serial-name/index.html
690+
[kotlinx.serialization.encodeToString]: https://kotlinlang.org/api/kotlinx.serialization/kotlinx-serialization-core/kotlinx.serialization/encode-to-string.html
691+
[Serializable]: https://kotlinlang.org/api/kotlinx.serialization/kotlinx-serialization-core/kotlinx.serialization/-serializable/
692+
[kotlinx.serialization.decodeFromString]: https://kotlinlang.org/api/kotlinx.serialization/kotlinx-serialization-core/kotlinx.serialization/decode-from-string.html
693+
[Required]: https://kotlinlang.org/api/kotlinx.serialization/kotlinx-serialization-core/kotlinx.serialization/-required/
694+
[Transient]: https://kotlinlang.org/api/kotlinx.serialization/kotlinx-serialization-core/kotlinx.serialization/-transient/
695+
[EncodeDefault]: https://kotlinlang.org/api/kotlinx.serialization/kotlinx-serialization-core/kotlinx.serialization/-encode-default/
696+
[EncodeDefault.Mode]: https://kotlinlang.org/api/kotlinx.serialization/kotlinx-serialization-core/kotlinx.serialization/-encode-default/-mode/
697+
[SerialName]: https://kotlinlang.org/api/kotlinx.serialization/kotlinx-serialization-core/kotlinx.serialization/-serial-name/
698698

699699
<!--- MODULE /kotlinx-serialization-json -->
700700
<!--- INDEX kotlinx-serialization-json/kotlinx.serialization.json -->

docs/builtin-classes.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -396,13 +396,13 @@ The next chapter covers [Serializers](serializers.md).
396396
<!--- MODULE /kotlinx-serialization-core -->
397397
<!--- INDEX kotlinx-serialization-core/kotlinx.serialization -->
398398

399-
[Serializable]: https://kotlin.github.io/kotlinx.serialization/kotlinx-serialization-core/kotlinx.serialization/-serializable/index.html
400-
[SerialName]: https://kotlin.github.io/kotlinx.serialization/kotlinx-serialization-core/kotlinx.serialization/-serial-name/index.html
399+
[Serializable]: https://kotlinlang.org/api/kotlinx.serialization/kotlinx-serialization-core/kotlinx.serialization/-serializable/index.html
400+
[SerialName]: https://kotlinlang.org/api/kotlinx.serialization/kotlinx-serialization-core/kotlinx.serialization/-serial-name/index.html
401401

402402
<!--- MODULE /kotlinx-serialization-core -->
403403
<!--- INDEX kotlinx-serialization-core/kotlinx.serialization.builtins -->
404404

405-
[LongAsStringSerializer]: https://kotlin.github.io/kotlinx.serialization/kotlinx-serialization-core/kotlinx.serialization.builtins/-long-as-string-serializer/index.html
405+
[LongAsStringSerializer]: https://kotlinlang.org/api/kotlinx.serialization/kotlinx-serialization-core/kotlinx.serialization.builtins/-long-as-string-serializer/
406406

407407
<!--- END -->
408408

0 commit comments

Comments
 (0)