From 0d39d0aadd484ddedfdbf08a023d1ce9d11f4c2c Mon Sep 17 00:00:00 2001
From: blu <blustream@posteo.net>
Date: Mon, 30 Sep 2024 10:54:15 +0200
Subject: [PATCH] add documentation about upgrading the recipe

---
 README.md  |  3 +++
 UPGRADE.md | 21 +++++++++++++++++++++
 2 files changed, 24 insertions(+)
 create mode 100644 UPGRADE.md

diff --git a/README.md b/README.md
index a298360..0373435 100644
--- a/README.md
+++ b/README.md
@@ -43,3 +43,6 @@ You can run them as, for example:
 ```bash
 $ abra app cmd open-inventory.example.net app clear_cache
 ```
+
+## How to upgrade the recipe
+Have a look here: [UPGRADE.md](UPGRADE.md)
diff --git a/UPGRADE.md b/UPGRADE.md
new file mode 100644
index 0000000..991b9b6
--- /dev/null
+++ b/UPGRADE.md
@@ -0,0 +1,21 @@
+# open-inventory
+
+## How to upgrade the recipe _(after a new upstream open-inventory release)_
+
+
+1. Update  `open-inventory-recipe/compose.yml`
+   - Update the open-inventory docker image version
+     - in `compose.yml -> services -> app -> image`
+       - `image: codeberg.org/eotl/open-inventory:0.0.13` (example)
+       - (optional - if you are an open-inventory maintainer) to have the image pushed to codeberg, from the `open-inventory` repository, there is a specific Make command for that:
+         - `make VERSION=0.0.13 build-production-image-and-push`
+   - Bump up the open-inventory service version: 
+     - in the `labels` section:
+     - `        - "coop-cloud.${STACK_NAME}.version=1.0.13"` (example)
+2. Commit the changes
+   - `git add compose.yml && git commit -m "Upgrade to 0.0.13""`
+3. Create an annotated tag _(simple tags wouldn't work with `abra`)_
+   - `git tag -a v1.0.13 -m "commit message, example: upgrade to version v1.0.13"`
+5. Push the newly created tag
+   - `git push origin tag v1.0.13`
+- Done: now you can run `abra app upgrade inventory.example.net` and you will be offered to choose the new version.
\ No newline at end of file