add documentation about upgrading the recipe

(blu) Reviewed-on: #3

.env.sample

@@ -41,16 +41,21 @@ QUEUE_DRIVER=database
 #MAIL_PASSWORD="SMTP Password"
 #MAIL_ENCRYPTION=tls
 
-COMPANY_NAME=""
-COMPANY_REPRESENTATIVES=""
-COMPANY_STREET=""
-COMPANY_BUILDING=""
-COMPANY_POSTALCODE=""
-COMPANY_CITY=""
-COMPANY_COUNTRY=""
-COMPANY_TELEPHONE=""
-COMPANY_EMAIL=""
+INSTANCE_REPO="https://codeberg.org/eotl/open-inventory"
+INSTANCE_NAME=""
+INSTANCE_DESCRIPTION=""
+INSTANCE_REPRESENTATIVES=""
+INSTANCE_ADDRESS=""
+INSTANCE_POSTALCODE=""
+INSTANCE_CITY=""
+INSTANCE_COUNTRY=""
+INSTANCE_TELEPHONE=""
+INSTANCE_EMAIL=""
 
-#EOTL_PATH_DATA="/home/eotl/data"
-#EOTL_URL_DISPATCH="http://localhost:8082"
-#EOTL_URL_SEXTANT="http://localhost:8081"
+EOTL_URL_DISPATCH="http://localhost:8082"
+EOTL_URL_SEXTANT="http://localhost:8081"
+
+OSMR_NOMINATIM_URL=https://nominatim.openstreetmap.org/search.php
+IDENTIFICATOR_URL=https://eotl.link
+IDENTIFICATOR_USERNAME=
+IDENTIFICATOR_PASSWORD=

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)

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.

abra.sh

@@ -14,12 +14,16 @@ initial_setup() {
   # clear config cache, where a previous invalid APP_KEY might still be present
   clear_cache
 
+  run_migrations
+
+  create_first_admin_user
+}
+
+run_migrations() {
   echo "DB migrations status:"
   php artisan migrate:status
   echo "Starting DB migrations..."
   php artisan migrate
-
-  create_first_admin_user
 }
 
 clear_cache() {

compose.yml

@@ -3,7 +3,7 @@ version: '3.8'
 services:
   app:
     # Dockerfile here: https://codeberg.org/eotl/open-inventory/src/branch/main/docker/prod/Dockerfile
-    image: codeberg.org/eotl/open-inventory:0.0.10
+    image: codeberg.org/eotl/open-inventory:0.0.11
     depends_on:
       - db
     networks:
@@ -32,8 +32,7 @@ services:
         - "traefik.http.routers.${STACK_NAME}.rule=Host(`${DOMAIN}`)"
         - "traefik.http.routers.${STACK_NAME}.entrypoints=web-secure"
         - "traefik.http.routers.${STACK_NAME}.tls.certresolver=${LETS_ENCRYPT_ENV}"
-        - "coop-cloud.${STACK_NAME}.version=1.0.0+0.0.5"
-
+        - "coop-cloud.${STACK_NAME}.version=1.0.12"
   db:
     image: mariadb:10.5
     init: true