blob: ef7cc23365af74f0e832002f885d9d6c0e2f0f4c (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
|
# kotlinx.coroutines release checklist
To release a new `<version>` of `kotlinx-coroutines`:
1. Checkout the `develop` branch: <br>
`git checkout develop`
2. Retrieve the most recent `develop`: <br>
`git pull`
3. Make sure the `master` branch is fully merged into `develop`:
`git merge origin/master`
4. Search & replace `<old-version>` with `<version>` across the project files. Should replace in:
* Docs
* [`README.md`](README.md) (native, core, test, debug, modules)
* [`kotlinx-coroutines-debug/README.md`](kotlinx-coroutines-debug/README.md)
* [`kotlinx-coroutines-test/README.md`](kotlinx-coroutines-test/README.md)
* [`coroutines-guide-ui.md`](ui/coroutines-guide-ui.md)
* Properties
* [`gradle.properties`](gradle.properties)
* Make sure to **exclude** `CHANGES.md` from replacements.
As an alternative approach, you can use `./bump-version.sh old_version new_version`
5. Write release notes in [`CHANGES.md`](CHANGES.md):
* Use the old releases for style guidance.
* Write each change on a single line (don't wrap with CR).
* Look through the commit messages since the previous release.
6. Create the branch for this release:
`git checkout -b version-<version>`
7. Commit the updated files to the new version branch:<br>
`git commit -a -m "Version <version>"`
8. Push the new version to GitHub:<br>
`git push -u origin version-<version>`
9. Create a Pull-Request on GitHub from the `version-<version>` branch into `master`:
* Review it.
* Make sure it builds on CI.
* Get approval for it.
0. On [TeamCity integration server](https://teamcity.jetbrains.com/project.html?projectId=KotlinTools_KotlinxCoroutines):
* Wait until "Build" configuration for committed `master` branch passes tests.
* Run "Deploy (Configure, RUN THIS ONE)" configuration with the corresponding new version:
- Use the `version-<version>` branch
- Set the `DeployVersion` build parameter to `<version>`
* Wait until all four "Deploy" configurations finish.
1. In [Nexus](https://oss.sonatype.org/#stagingRepositories) admin interface:
* Close the repository and wait for it to verify.
* Release the repository.
2. Merge the new version branch into `master`:<br>
`git checkout master`<br>
`git merge version-<version>`<br>
`git push`
3. In [GitHub](https://github.com/kotlin/kotlinx.coroutines) interface:
* Create a release named `<version>`, creating the `<version>` tag.
* Cut & paste lines from [`CHANGES.md`](CHANGES.md) into description.
4. Announce the new release in [Slack](https://kotlinlang.slack.com)
5. Switch onto the `develop` branch:<br>
`git checkout develop`
6. Fetch the latest `master`:<br>
`git fetch`
7. Merge the release from `master`:<br>
`git merge origin/master`
8. Push the updates to GitHub:<br>
`git push`
9. Build and publish the documentation for the web-site: <br>
* Set new value for [`kotlinx.coroutines.release.tag`](https://buildserver.labs.intellij.net/admin/editProject.html?projectId=Kotlin_KotlinSites_Builds_KotlinlangOrg_LibrariesAPIs&tab=projectParams)
* And run deploy [configuration](https://buildserver.labs.intellij.net/buildConfiguration/Kotlin_KotlinSites_Builds_KotlinlangOrg_KotlinCoroutinesApi?branch=%3Cdefault%3E&buildTypeTab=overview&mode=builds)
|
