diff options
author | Ignat Beresnev <ignat.beresnev@jetbrains.com> | 2023-05-25 21:36:37 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-05-25 21:36:37 +0200 |
commit | 84d4af04a688286ad1b51a72130ccda691caff75 (patch) | |
tree | 4a6df663adcd15e5c6a920e2d6fb5ac9391fa870 | |
parent | 0515f5bab98937ef5512adab97776554164cd1c9 (diff) | |
download | kotlinx.serialization-84d4af04a688286ad1b51a72130ccda691caff75.tar.gz |
Update releasing docs for the API reference (#2307)
-rw-r--r-- | RELEASING.md | 28 |
1 files changed, 24 insertions, 4 deletions
diff --git a/RELEASING.md b/RELEASING.md index fe4d7b1a..f8b90e9b 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -41,10 +41,8 @@ If review is not required, commit directly to `dev`. * Close the repository and wait for it to verify. * Release it. -5. Propose the website documentation update:<br> - * 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. - * The website team will be notified about the pull request, review your changes, and merge it to master after all checks pass. - * 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. +5. 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. To find out why it is needed, [read this](#kotlinxserializationreleasetag). 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. @@ -56,3 +54,25 @@ If review is not required, commit directly to `dev`. ``` 5. Announce new release in [Slack](https://kotlinlang.slack.com). + +# API reference documentation + +The [API reference documentation](https://kotlinlang.org/api/kotlinx.serialization/) is built and deployed automatically +for every commit in `master`, typically within the same day. + +**Note**: KDoc / API reference changes targeting `master` should not contain information which is irrelevant to or is +incorrect in relation to the latest release, because these changes will be deployed live automatically, and they might +confuse readers. + +The build configuration responsible for assembling the documentation can be found +[on TeamCity](https://buildserver.labs.intellij.net/buildConfiguration/Kotlin_KotlinSites_KotlinlangTeamcityDsl_KotlinxSerializationBuildApiReference). + +### KOTLINX_SERIALIZATION_RELEASE_TAG + +The generated API reference documentation has the library version specified in the header. By default, the value +of the `version` project property is taken. However, this property usually contains the upcoming version with +the `-SNAPSHOT` suffix, so it cannot be used if you want to publish the updated documentation of the latest release. + +For this reason, the [`KOTLINX_SERIALIZATION_RELEASE_TAG`](https://github.com/JetBrains/kotlin-web-site/blob/master/.teamcity/BuildParams.kt) +property must be set during every release: its value will be used for all subsequent publications of the API docs to kotlinlang.org, +and it will appear in the header. |