Skip to content

Commit 1330e33

Browse files
authored
Update RELEASING.md
Update release docs
1 parent f319e48 commit 1330e33

1 file changed

Lines changed: 10 additions & 7 deletions

File tree

RELEASING.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,16 @@
55
Assuming you are making a release to get the latest Rust code, you should bump
66
the version of `matrix-rust-sdk` we are depending on in `Cargo.lock`.
77

8-
At time of writing, Cargo.toml has `git = "https://github.com/matrix-org/matrix-rust-sdk"`,
9-
which picks up the latest version on the default branch in Git. This means that
10-
we can update the version by following these steps:
11-
12-
1. Ensure `.cargo/config` does **not** contain the `patch` section for local
13-
development recommended in `README.md`.
14-
2. Run `cargo update`.
8+
Ideally, release versions of `matrix-sdk-crypto-wasm` will depend on release
9+
versions of `matrix-rust-sdk`. The best way to upgrade is:
10+
1. Edit `Cargo.toml` to remove any `git` settings for `matrix-sdk-*`, and set
11+
`version` to the latest version (see [crates.io](https://crates.io/crates/matrix_sdk_crypto/versions)).
12+
2. Ensure `.cargo/config` does **not** contain the `patch` section for local
13+
development recommended in `README.md`.
14+
3. Run `cargo update`.
15+
16+
Occasionally, we may need to use a git version of `matrix-rust-sdk`. For that,
17+
you can `cargo xtask unstable-rust-sdk`.
1518

1619
## Doing the release
1720

0 commit comments

Comments
 (0)