Merge pull request #1893 from input-output-hk/dlachaume/1813/create-repository-dependencies-upgrade-runbook

Create repository dependencies upgrade runbook

Author: dlachaume

docs/runbook/README.md

@@ -23,3 +23,4 @@ This page gathers the available guides to operate a Mithril network.
 | **Publish packages to npm manually**         | [manual-publish-npm](./manual-publish-npm/README.md)                                     | Manually publish packages to npm registry.                                |
 | **Client multi-platform test**               | [test-client-multiplatform](./test-client-multiplatform/README.md)                       | Run multi-platform client CLI binaries, docker and WASM package tests.    |
 | **Maintain the networks configuration file** | [maintain-networks-configuration-file](./maintain-networks-configuration-file/README.md) | Maintain the `networks.json` file                                         |
+| **Upgrade the repository dependencies**      | [upgrade-repository-dependencies](./upgrade-repository-dependencies/README.md)           | Upgrade the project's dependencies in the repository                      |

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

@@ -0,0 +1,140 @@
+# Upgrade the project's dependencies in the repository
+
+## Introduction
+
+This runbook provides step-by-step instructions to upgrade the dependencies in the repository, including Rust crates, documentation, and JavaScript packages.
+
+## Steps
+
+### Upgrade Rust outdated dependencies
+
+We recommand using [Dependi](https://dependi.io/) VS Code extension to identify and update outdated dependencies.
+
+To do this, verify the dependencies in the `Cargo.toml` file for each Rust crate in the repository.
+
+- Bring up the Command Palette with `Ctrl+Shift+P` (or `Cmd+Shift+P` on macOS).
+- Type `dependi` and select `Update All Dependencies to Latest Version`.
+
+![Run dependi](./img/run-dependi.png)
+
+Create a dedicated commit, e.g.:
+
+```bash
+chore: update Rust dependencies
+```
+
+Next, ensure that upgrading the dependencies has not introduced any breaking changes in the codebase.
+
+If breaking changes are introduced, resolve them, and then create a dedicated commit, e.g.:
+
+```bash
+fix: resolve breaking changes introduced by upgrading 'crate_name' from 'x.0.99' to 'x.1.0'
+```
+
+### Bump Rust crates versions
+
+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.
+
+Create a dedicated commit, e.g:
+
+```bash
+chore: bump crates versions
+```
+
+### Upgrade the documentation website dependencies
+
+From the root of the repository, run:
+
+```bash
+cd docs/website
+make upgrade
+```
+
+Create a dedicated commit, e.g.:
+
+```bash
+chore: upgrade doc dependencies
+
+By running 'make upgrade' command.
+```
+
+### Upgrade the explorer dependencies
+
+From the root of the repository, run:
+
+```bash
+cd mithril-explorer
+make upgrade
+```
+
+Create a dedicated commit, e.g.:
+
+```bash
+chore: upgrade explorer dependencies
+
+By running 'make upgrade' command.
+```
+
+### Upgrade `www/` and `www-test/` dependencies
+
+From the root of the repository, run:
+
+```bash
+cd mithril-client-wasm
+make upgrade-www-deps
+```
+
+Create a dedicated commit, e.g.:
+
+```bash
+chore: upgrade mithril client wasm 'www' and 'www-test' dependencies
+
+By running 'make upgrade-www-deps' command.
+```
+
+### Bump Javascript packages versions
+
+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`).
+
+Then, from the root of the repository, run the commands:
+
+```bash
+cd mithril-client-wasm
+make www-install && make www-test-install
+```
+
+```bash
+cd mithril-explorer
+make install
+```
+
+```bash
+cd docs/website
+make install
+```
+
+Create a dedicated commit, e.g.:
+
+```bash
+chore: bump mithril client wasm 'www' and 'www-test' dependencies
+
+By running:
+- 'make www-install' command in 'mithril-client-wasm'.
+- 'make www-test-install' command in 'mithril-client-wasm'.
+- 'make install' command in 'mithril-explorer'.
+- 'make install' command in 'docs/website'.
+```
+
+### Upgrade Nix Flake dependencies
+
+```bash
+nix flake update
+```
+
+Create a dedicated commit, e.g.:
+
+```bash
+chore: update nix flake dependencies
+
+By running 'nix flake update' command.
+```