Skip to content

Commit d42c4dd

Browse files
Update RELEASING.md (#470)
1 parent 5e95a32 commit d42c4dd

3 files changed

Lines changed: 35 additions & 34 deletions

File tree

RELEASING.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
11
# Releasing
22

3-
In order to be able to release, you'll need write access to the repo.
3+
To be able to release, you'll need write access to the repo.
44

55
Steps:
66

7-
1. Make sure any PR's are applied and the release is ready to be published.
8-
2. Switch to the branch you'll release from, and `git pull` the latest.
7+
1. Make sure any PRs are merged and the release is ready to be published.
8+
2. Switch to a new release branch and `git pull` the latest.
99
3. Change the version in `gradle.properties`.
10-
4. Git add/commit with message "Version _._._"
11-
5. Update `CHANGELOG.md` with a summary of changes
12-
6. Push that change (directly to the branch, no PR).
13-
7. Open Actions, select the `release` workflow on the left.
14-
8. Select `Run Workflow` on the right, pick the branch, and click `Run Workflow`.
10+
4. Update `CHANGELOG.md` with a summary of changes.
11+
5. Make sure to update the lock files by running the `kotlinUpgradePackageLock` and `kotlinWasmUpgradePackageLock` tasks.
12+
6. Push the changes with the message "Version x.y.z."
13+
7. Open a PR to merge the release branch into `main`.
14+
8. After the PR got merged, open `Actions` and select the `release` workflow on the left.
15+
9. Select `Run Workflow` on the right, pick the `main` branch, and click `Run Workflow`.
1516
10. To check status, look for the library in [https://repo1.maven.org/maven2/co/touchlab/](https://repo1.maven.org/maven2/co/touchlab/), find an artifact, and refresh until the version you just published shows up.

kotlin-js-store/package-lock.json

Lines changed: 13 additions & 13 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

kotlin-js-store/wasm/package-lock.json

Lines changed: 13 additions & 13 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)