You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: RELEASING.md
+24-4Lines changed: 24 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -41,10 +41,8 @@ If review is not required, commit directly to `dev`.
41
41
* Close the repository and wait for it to verify.
42
42
* Release it.
43
43
44
-
5. Propose the website documentation update:<br>
45
-
* Set a new value for [`KOTLINX_SERIALIZATION_RELEASE_TAG`](https://github.com/JetBrains/kotlin-web-site/blob/master/.teamcity/BuildParams.kt), creating a pull request in the website's repository.
46
-
* The website team will be notified about the pull request, review your changes, and merge it to master after all checks pass.
47
-
* Once the pull request is merged to the main branch, it automatically will trigger the website's update, which will be done within an hour.
44
+
5. Set a new value for [`KOTLINX_SERIALIZATION_RELEASE_TAG`](https://github.com/JetBrains/kotlin-web-site/blob/master/.teamcity/BuildParams.kt),
45
+
creating a pull request in the website's repository. To find out why it is needed, [read this](#kotlinxserializationreleasetag).
48
46
49
47
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.
50
48
@@ -56,3 +54,25 @@ If review is not required, commit directly to `dev`.
56
54
```
57
55
58
56
5. Announce new release in [Slack](https://kotlinlang.slack.com).
57
+
58
+
# API reference documentation
59
+
60
+
The [API reference documentation](https://kotlinlang.org/api/kotlinx.serialization/) is built and deployed automatically
61
+
for every commit in `master`, typically within the same day.
62
+
63
+
**Note**: KDoc / API reference changes targeting `master` should not contain information which is irrelevant to or is
64
+
incorrect in relation to the latest release, because these changes will be deployed live automatically, and they might
65
+
confuse readers.
66
+
67
+
The build configuration responsible for assembling the documentation can be found
0 commit comments