Skip to content

Commit

Permalink
merge master into 7099-improve-backwards-compatibility-checks
Browse files Browse the repository at this point in the history
  • Loading branch information
bisgaard-itis committed Feb 3, 2025
2 parents cfd945a + a1614e8 commit d90ab69
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 0 deletions.
8 changes: 8 additions & 0 deletions packages/service-integration/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Original file line number Diff line number Diff line change
Expand Up @@ -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}'")

Expand Down

0 comments on commit d90ab69

Please sign in to comment.