Merge branch 'master' into enh/licensed-items-from-backend

Author: odeimaiz

.github/workflows/ci-testing-pull-request.yml

@@ -31,13 +31,15 @@ jobs:
           enable-cache: false
       - name: checkout source branch
         uses: actions/checkout@v4
-      - name: Regenerate specs and check
+      - name: Generate openapi specs
         run: |
           make devenv
           source .venv/bin/activate
           make openapi-specs
+      - name: Check openapi specs are up to date
+        run: |
           if ! ./ci/github/helpers/openapi-specs-diff.bash diff \
-            https://raw.githubusercontent.com/${{ github.event.pull_request.head.repo.full_name }}/refs/heads/${{ github.event.pull_request.head.ref }} \
+            https://raw.githubusercontent.com/${{ github.event.pull_request.head.repo.full_name }}/${{ github.event.after }} \
             .; then \
             echo "::error:: OAS are not up to date. Run 'make openapi-specs' to update them"; exit 1; \
           fi
@@ -57,7 +59,7 @@ jobs:
       - name: check api-server backwards compatibility
         run: |
           ./scripts/openapi-diff.bash breaking --fail-on ERR\
-            https://raw.githubusercontent.com/${{ github.event.pull_request.base.repo.full_name }}/refs/heads/${{ github.event.pull_request.base.ref }}/services/api-server/openapi.json \
+            https://raw.githubusercontent.com/${{ github.event.pull_request.base.repo.full_name }}/${{ github.event.after }}/services/api-server/openapi.json \
             /specs/services/api-server/openapi.json
 
   all-oas-breaking:
@@ -76,5 +78,5 @@ jobs:
       - name: Check openapi-specs backwards compatibility
         run: |
           ./ci/github/helpers/openapi-specs-diff.bash breaking \
-            https://raw.githubusercontent.com/${{ github.event.pull_request.base.repo.full_name }}/refs/heads/${{ github.event.pull_request.base.ref }} \
+            https://raw.githubusercontent.com/${{ github.event.pull_request.base.repo.full_name }}/${{ github.event.after }} \
             .

packages/service-integration/README.md

@@ -5,3 +5,11 @@ This is the o2sparc's service integration library or ``ooil`` in short
 
 
 SEE how is it used in Makefiles in https://github.com/ITISFoundation/cookiecutter-osparc-service
+
+
+#### What is the .osparc folder and its content?
+'osparc config' is a set of stardard file forms (yaml) that the user fills provides in order to describe how her service works and integrates with osparc. It may contain:
+  - config files are stored under '.osparc/' folder in the root repo folder (analogous to other configs like .github, .vscode, etc)
+  - configs are parsed and validated into pydantic models
+  - models can be serialized/deserialized into label annotations on images. This way, the config is attached to the service during it's entire lifetime.
+  - config should provide enough information about that context to allow building an image and running a container on a single command call.

packages/service-integration/src/service_integration/cli/_compose_spec.py

@@ -192,6 +192,14 @@ def create_compose(
             if file_path.exists():
                 configs_kwargs_map[config_name][arg_name] = file_path
 
+    # warn about subfolders without metadata.yml
+    for subdir in filter(lambda p: p.is_dir(), basedir.rglob("*")):
+        if not (subdir / "metadata.yml").exists():
+            relative_subdir = subdir.relative_to(basedir)
+            rich.print(
+                f"[warning] Subfolder '{relative_subdir}' does not contain a 'metadata.yml' file. Skipping."
+            )
+
     if not configs_kwargs_map:
         rich.print(f"[warning] No config files were found in '{config_path}'")