Skip to content

Commit 458391b

Browse files
committed
docs: add section to upgrade Rust dependencies using dependi
1 parent 57884a7 commit 458391b

File tree

2 files changed

+15
-6
lines changed

2 files changed

+15
-6
lines changed

docs/runbook/upgrade-repository-dependencies/README.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,29 @@ This runbook provides step-by-step instructions to upgrade the dependencies in t
66

77
## Steps
88

9-
### Update Rust dependencies
9+
### Upgrade Rust outdated dependencies
1010

11-
From the root of the repository, run:
11+
We recommand using [Dependi](https://dependi.io/) VS Code extension to identify and update outdated dependencies.
1212

13-
```bash
14-
cargo update
15-
```
13+
To do this, verify the dependencies in the `Cargo.toml` file for each Rust crate in the repository.
14+
15+
- Bring up the Command Palette with `Ctrl+Shift+P` (or `Cmd+Shift+P` on macOS).
16+
- Type `dependi` and select `Update All Dependencies to Latest Version`.
17+
18+
![Run dependi](./img/run-dependi.png)
1619

1720
Create a dedicated commit, e.g.:
1821

1922
```bash
2023
chore: update Rust dependencies
24+
```
25+
26+
Next, ensure that upgrading the dependencies has not introduced any breaking changes in the codebase.
2127

22-
By running 'cargo update' command.
28+
If breaking changes are introduced, resolve them, and then create a dedicated commit, e.g.:
29+
30+
```bash
31+
fix: resolve breaking changes introduced by upgrading 'crate_name' from 'x.0.99' to 'x.1.0'
2332
```
2433

2534
### Bump Rust crates versions
103 KB
Loading

0 commit comments

Comments
 (0)