Skip to content

Commit 57884a7

Browse files
committed
docs: create repository dependencies upgrade runbook
1 parent 062d150 commit 57884a7

File tree

2 files changed

+132
-0
lines changed

2 files changed

+132
-0
lines changed

docs/runbook/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,4 @@ This page gathers the available guides to operate a Mithril network.
2323
| **Publish packages to npm manually** | [manual-publish-npm](./manual-publish-npm/README.md) | Manually publish packages to npm registry. |
2424
| **Client multi-platform test** | [test-client-multiplatform](./test-client-multiplatform/README.md) | Run multi-platform client CLI binaries, docker and WASM package tests. |
2525
| **Maintain the networks configuration file** | [maintain-networks-configuration-file](./maintain-networks-configuration-file/README.md) | Maintain the `networks.json` file |
26+
| **Upgrade the repository dependencies** | [upgrade-repository-dependencies](./upgrade-repository-dependencies/README.md) | Upgrade the project's dependencies in the repository |
Lines changed: 131 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,131 @@
1+
# Upgrade the project's dependencies in the repository
2+
3+
## Introduction
4+
5+
This runbook provides step-by-step instructions to upgrade the dependencies in the repository, including Rust crates, documentation, and JavaScript packages.
6+
7+
## Steps
8+
9+
### Update Rust dependencies
10+
11+
From the root of the repository, run:
12+
13+
```bash
14+
cargo update
15+
```
16+
17+
Create a dedicated commit, e.g.:
18+
19+
```bash
20+
chore: update Rust dependencies
21+
22+
By running 'cargo update' command.
23+
```
24+
25+
### Bump Rust crates versions
26+
27+
Increment the patch versions in the `Cargo.toml` by 1 (eg. from `x.x.1` to `x.x.2`) for each Rust crate in the repository.
28+
29+
Create a dedicated commit, e.g:
30+
31+
```bash
32+
chore: bump crates versions
33+
```
34+
35+
### Upgrade the documentation website dependencies
36+
37+
From the root of the repository, run:
38+
39+
```bash
40+
cd docs/website
41+
make upgrade
42+
```
43+
44+
Create a dedicated commit, e.g.:
45+
46+
```bash
47+
chore: upgrade doc dependencies
48+
49+
By running 'make upgrade' command.
50+
```
51+
52+
### Upgrade the explorer dependencies
53+
54+
From the root of the repository, run:
55+
56+
```bash
57+
cd mithril-explorer
58+
make upgrade
59+
```
60+
61+
Create a dedicated commit, e.g.:
62+
63+
```bash
64+
chore: upgrade explorer dependencies
65+
66+
By running 'make upgrade' command.
67+
```
68+
69+
### Upgrade `www/` and `www-test/` dependencies
70+
71+
From the root of the repository, run:
72+
73+
```bash
74+
cd mithril-client-wasm
75+
make upgrade-www-deps
76+
```
77+
78+
Create a dedicated commit, e.g.:
79+
80+
```bash
81+
chore: upgrade mithril client wasm 'www' and 'www-test' dependencies
82+
83+
By running 'make upgrade-www-deps' command.
84+
```
85+
86+
### Bump Javascript packages versions
87+
88+
Increment the patch versions in the `package.json` by 1 (eg. from `x.x.1` to `x.x.2`) for each Javascript package in the repository (`www`, `www-test` and `mithril-explorer`, `docs/website`).
89+
90+
Then, from the root of the repository, run the commands:
91+
92+
```bash
93+
cd mithril-client-wasm
94+
make www-install && make www-test-install
95+
```
96+
97+
```bash
98+
cd mithril-explorer
99+
make install
100+
```
101+
102+
```bash
103+
cd docs/website
104+
make install
105+
```
106+
107+
Create a dedicated commit, e.g.:
108+
109+
```bash
110+
chore: bump mithril client wasm 'www' and 'www-test' dependencies
111+
112+
By running:
113+
- 'make www-install' command in 'mithril-client-wasm'.
114+
- 'make www-test-install' command in 'mithril-client-wasm'.
115+
- 'make install' command in 'mithril-explorer'.
116+
- 'make install' command in 'docs/website'.
117+
```
118+
119+
### Upgrade Nix Flake dependencies
120+
121+
```bash
122+
nix flake update
123+
```
124+
125+
Create a dedicated commit, e.g.:
126+
127+
```bash
128+
chore: update nix flake dependencies
129+
130+
By running 'nix flake update' command.
131+
```

0 commit comments

Comments
 (0)