Skip to content

Commit 65303aa

Browse files
authored
Document the procedure of upgrading to the new Kotlin version (#4557)
Fixes #4521
1 parent e3fa37b commit 65303aa

File tree

2 files changed

+40
-2
lines changed

2 files changed

+40
-2
lines changed

KOTLIN_UPGRADE.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Checklist for upgrading to the new Kotlin version
2+
3+
1. Create a new branch based off `develop`:
4+
```sh
5+
git fetch
6+
git checkout -b kotlin-<version> origin/develop
7+
```
8+
9+
1. In `gradle.properties`,
10+
set `kotlin_version` to the `<version>`.
11+
12+
2. Likewise, set `kotlin_version` in `integration-testing/gradle.properties`.
13+
14+
3. In `README.md`,
15+
replace the occurrences of the old version with the `<version>`.
16+
These are:
17+
- A badge at the top of the file.
18+
- The Kotlin version corresponding to the latest release,
19+
mentioned in the first paragraph.
20+
- Maven and Gradle configuration blocks.
21+
22+
4. In `README.md`, find the link to https://pl.kotl.in/ and open it.
23+
Set the compiler version of Kotlin Playground to the same major version as `<version>`,
24+
click "Copy link", and replace the original link in `README.md` with the new one.
25+
26+
5. Perform a full build: `gradle clean check publishToMavenLocal`,
27+
followed by `gradle clean check` in the `integration-testing` directory.
28+
Fix any issues that arise.
29+
30+
6. Commit and push all changes to GitHub:
31+
```sh
32+
git commit -am 'Upgrade to Kotlin <version>'
33+
git push -u origin kotlin-<version>
34+
```
35+
36+
7. Wait for the TeamCity continuous integration builds to finish.
37+
38+
8. Open a new pull request, receive approval, and merge.

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@ This is a companion version for the Kotlin `2.2.20` release.
1414
```kotlin
1515
suspend fun main() = coroutineScope {
1616
launch {
17-
delay(1000)
17+
delay(1.seconds)
1818
println("Kotlin Coroutines World!")
1919
}
2020
println("Hello")
2121
}
2222
```
2323

24-
> Play with coroutines online [here](https://pl.kotl.in/Wf3HxgZvx)
24+
> Play with coroutines online [here](https://pl.kotl.in/xdbDf0NNk)
2525
2626
## Modules
2727

0 commit comments

Comments
 (0)