-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update the documentation for the release procedure (#3076)
- Loading branch information
1 parent
e0a080c
commit d220071
Showing
1 changed file
with
46 additions
and
44 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,78 +1,80 @@ | ||
| # kotlinx.coroutines release checklist | ||
|
|
||
| To release new `<version>` of `kotlinx-coroutines`: | ||
| To release a new `<version>` of `kotlinx-coroutines`: | ||
|
|
||
| 1. Checkout `develop` branch: <br> | ||
| 1. Checkout the `develop` branch: <br> | ||
| `git checkout develop` | ||
|
|
||
| 2. Retrieve the most recent `develop`: <br> | ||
| 2. Retrieve the most recent `develop`: <br> | ||
| `git pull` | ||
|
|
||
| 3. Make sure the `master` branch is fully merged into `develop`: | ||
| `git merge origin/master` | ||
| `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) | ||
| * 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` | ||
|
|
||
| As an alternative approach, you can use `./bump-version.sh old_version new_version` | ||
|
|
||
| 5. Write release notes in [`CHANGES.md`](CHANGES.md): | ||
| * Use old releases as example of style. | ||
| * Use the old releases for style guidance. | ||
| * Write each change on a single line (don't wrap with CR). | ||
| * Study commit message from previous release. | ||
| * Look through the commit messages since the previous release. | ||
|
|
||
| 6. Create the branch for this release: | ||
| `git checkout -b version-<version>` | ||
|
|
||
| 7. Commit updated files to a new version branch:<br> | ||
| 7. Commit the updated files to the new version branch:<br> | ||
| `git commit -a -m "Version <version>"` | ||
| 8. Push the new version into the branch:<br> | ||
|
|
||
| 8. Push the new version to GitHub:<br> | ||
| `git push -u origin version-<version>` | ||
| 9. Create Pull-Request on GitHub from `version-<version>` branch into `master`: | ||
|
|
||
| 9. Create a Pull-Request on GitHub from the `version-<version>` branch into `master`: | ||
| * Review it. | ||
| * Make sure it build on CI. | ||
| * Make sure it builds on CI. | ||
| * Get approval for it. | ||
|
|
||
| 0. Merge new version branch into `master`:<br> | ||
| `git checkout master`<br> | ||
| `git merge version-<version>`<br> | ||
| `git push` | ||
|
|
||
| 1. On [TeamCity integration server](https://teamcity.jetbrains.com/project.html?projectId=KotlinTools_KotlinxCoroutines): | ||
| 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. | ||
| * 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. | ||
|
|
||
| 2. In [GitHub](https://github.com/kotlin/kotlinx.coroutines) interface: | ||
| * Create a release named `<version>`. | ||
| * Cut & paste lines from [`CHANGES.md`](CHANGES.md) into description. | ||
|
|
||
| 3. Build and publish documentation for web-site | ||
| (make sure you have [Docker](https://www.docker.com/) installed first): <br> | ||
| `site/deploy.sh <version> push` | ||
|
|
||
| 4. In [Nexus](https://oss.sonatype.org/#stagingRepositories) admin interface: | ||
| 1. In [Nexus](https://oss.sonatype.org/#stagingRepositories) admin interface: | ||
| * Close the repository and wait for it to verify. | ||
| * Release the repository. | ||
|
|
||
| 5. Announce new release in [Slack](https://kotlinlang.slack.com) | ||
|
|
||
| 6. Switch into `develop` branch:<br> | ||
| 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. Build and publish the documentation for the web-site: <br> | ||
| `site/deploy.sh <version> push` | ||
|
|
||
| 5. Announce the new release in [Slack](https://kotlinlang.slack.com) | ||
|
|
||
| 6. Switch onto the `develop` branch:<br> | ||
| `git checkout develop` | ||
|
|
||
| 7. Fetch the latest `master`:<br> | ||
| `git fetch` | ||
| 8. Merge release from `master`:<br> | ||
| `git fetch` | ||
|
|
||
| 8. Merge the release from `master`:<br> | ||
| `git merge origin/master` | ||
| 9. Push updates to `develop`:<br> | ||
| `git push` | ||
|
|
||
| 9. Push the updates to GitHub:<br> | ||
| `git push` |