From 2a16961ba7e581da3a72a5a9b202eb4553bb117e Mon Sep 17 00:00:00 2001
From: Paul Meyer <49727155+katexochen@users.noreply.github.com>
Date: Tue, 9 Jul 2024 09:26:44 +0200
Subject: [PATCH] azure-cli: document update procedure

Signed-off-by: Paul Meyer <49727155+katexochen@users.noreply.github.com>
---
 pkgs/tools/admin/azure-cli/README.md | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/pkgs/tools/admin/azure-cli/README.md b/pkgs/tools/admin/azure-cli/README.md
index 30936ded0a75..ec98c8cb7d24 100644
--- a/pkgs/tools/admin/azure-cli/README.md
+++ b/pkgs/tools/admin/azure-cli/README.md
@@ -1,5 +1,22 @@
 # Azure CLI
 
+## Updating the CLI
+
+- Update `version` and `src.hash` in default.nix
+- Check out the changes made to the azure-cli [setup.py](https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/setup.py) since the last release
+- Try build the CLI, will likely fail with `ModuleNotFoundError`, for example
+  ```
+   ModuleNotFoundError: No module named 'azure.mgmt.storage.v2023_05_01'
+  ```
+  Sometimes it will also fail with other import errors.
+- Check the referenced module (`azure-mgmt-storage`) in the setup.py
+- Find the actual version required, for example
+  ```
+    'azure-mgmt-storage==21.2.0',
+  ```
+- Update version and hash of this dependency in python-packages.nix
+- Repeat until it builds
+
 ## Extensions
 
 There are two sets of extensions: the one in `extensions-generated.nix` is generated with the script