Merge pull request #1926 from input-output-hk/djo/enhance-upgrade-dep-run-book

Enhance upgrade dependency runbook

Author: Alenar

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

@@ -6,18 +6,18 @@ This runbook provides step-by-step instructions to upgrade the dependencies in t
 
 ## Update dependencies tool
 
-The `update_dependencies.sh` script allows you to to update dependencies performing all the steps described in the next chapter.
+The `update_dependencies.sh` script allows you to update dependencies performing all the steps described in the next chapter.
 
 It requires having `cargo-edit` installed, which can be done with the following command:
 
 ```
 cargo install cargo-edit
 ```
 
-To start the update, execute the command:
+To start the update, execute the command below from the root of the repository:
 
 ```
-. ../docs/runbook/upgrade-repository-dependencies/upgrade-dependencies.sh
+. ./docs/runbook/upgrade-repository-dependencies/upgrade_dependencies.sh
 ```
 
 By default, Rust dependencies are updated to the latest version. If you want to only update to the latest compatible versions, add the `--incompatible` option to the command.
@@ -28,7 +28,7 @@ By default, Rust dependencies are updated to the latest version. If you want to
 
 ### Upgrade Rust outdated dependencies
 
-We recommand using [Dependi](https://dependi.io/) VS Code extension to identify and update outdated dependencies.
+We recommend 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.
 
@@ -37,6 +37,12 @@ To do this, verify the dependencies in the `Cargo.toml` file for each Rust crate
 
 ![Run dependi](./img/run-dependi.png)
 
+After the version upgrade, upgrade the dependencies in the `Cargo.lock` file that are not directly listed in any `Cargo.toml` (ie dependencies of dependencies) by running:
+
+```bash
+cargo update
+```
+
 Create a dedicated commit, e.g.:
 
 ```bash

docs/runbook/upgrade-repository-dependencies/upgrade_dependencies.sh

@@ -8,8 +8,8 @@ CARGO_UPGRADE_OPTIONS=${*:-"--incompatible"}
 # Need to install `cargo-edit` to execute `cargo upgrade` and `cargo set-version` commands
 
 # Upgrade Rust outdated dependencies
-cargo upgrade "${CARGO_UPGRADE_OPTIONS}" --verbose 
-# cargo upgrade -i allow --verbose 
+cargo upgrade "${CARGO_UPGRADE_OPTIONS}" --verbose
+cargo update
 # Let the CI run the tests at the end of the script
 # cargo test --all-features
 git commit -am "chore: update Rust dependencies"
@@ -82,11 +82,10 @@ mkdir -p "$TMP_SCRIPT_DIR"
 echo "git config --global --add safe.directory '*'
 nix --extra-experimental-features 'nix-command flakes' flake update" > "$TMP_SCRIPT_DIR/$FLAKE_UPDATE_SCRIPT"
 
-# The nix update is deactivated while waiting to be compatible with the latest version
-# # Upgrade Nix Flake dependencies
-# docker run -v "$(pwd)":/mithril -v "$TMP_SCRIPT_DIR":/scripts/mithril -w /mithril nixos/nix /bin/sh -c ". /scripts/mithril/$FLAKE_UPDATE_SCRIPT"
-# rm "$TMP_SCRIPT_DIR/$FLAKE_UPDATE_SCRIPT"
-# 
-# git commit -am "chore: update nix flake dependencies
-# 
-# By running 'nix flake update' command."
+ # Upgrade Nix Flake dependencies
+ docker run -v "$(pwd)":/mithril -v "$TMP_SCRIPT_DIR":/scripts/mithril -w /mithril nixos/nix /bin/sh -c ". /scripts/mithril/$FLAKE_UPDATE_SCRIPT"
+ rm "$TMP_SCRIPT_DIR/$FLAKE_UPDATE_SCRIPT"
+
+ git commit -am "chore: update nix flake dependencies
+
+ By running 'nix flake update' command."