diff options
Diffstat (limited to 'RELEASING.md')
| -rw-r--r-- | RELEASING.md | 26 |
1 files changed, 24 insertions, 2 deletions
diff --git a/RELEASING.md b/RELEASING.md index 5b95f0dc..f8b90e9b 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -41,8 +41,8 @@ If review is not required, commit directly to `dev`. * Close the repository and wait for it to verify. * Release it. -5. Update documentation website:<br> - `./update_docs.sh <version> push` +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. @@ -54,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. |