Skip to content

Commit 84d4af0

Browse files
Update releasing docs for the API reference (#2307)
1 parent 0515f5b commit 84d4af0

File tree

1 file changed

+24
-4
lines changed

1 file changed

+24
-4
lines changed

RELEASING.md

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,8 @@ If review is not required, commit directly to `dev`.
4141
* Close the repository and wait for it to verify.
4242
* Release it.
4343

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).
4846

4947
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.
5048

@@ -56,3 +54,25 @@ If review is not required, commit directly to `dev`.
5654
```
5755

5856
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
68+
[on TeamCity](https://buildserver.labs.intellij.net/buildConfiguration/Kotlin_KotlinSites_KotlinlangTeamcityDsl_KotlinxSerializationBuildApiReference).
69+
70+
### KOTLINX_SERIALIZATION_RELEASE_TAG
71+
72+
The generated API reference documentation has the library version specified in the header. By default, the value
73+
of the `version` project property is taken. However, this property usually contains the upcoming version with
74+
the `-SNAPSHOT` suffix, so it cannot be used if you want to publish the updated documentation of the latest release.
75+
76+
For this reason, the [`KOTLINX_SERIALIZATION_RELEASE_TAG`](https://github.com/JetBrains/kotlin-web-site/blob/master/.teamcity/BuildParams.kt)
77+
property must be set during every release: its value will be used for all subsequent publications of the API docs to kotlinlang.org,
78+
and it will appear in the header.

0 commit comments

Comments
 (0)