osbuild: first step towards stage separation - allow meta.json for stages
#1460
Conversation
| long_description = meta.get("description", "no description provided") | ||
| if isinstance(long_description, list): | ||
| long_description = "\n".join(long_description) |
There was a problem hiding this comment.
I understand why, and I can't come up with a better plan, but I don't like having to join a list to have multi-line strings in JSON :(
There was a problem hiding this comment.
Yeah, it's really not great but I couldn't think of a better way (with plain json)
| info = { | ||
| "schema": { | ||
| "1": meta.get("schema", {}), | ||
| "2": meta.get("schema_2", {}), | ||
| }, | ||
| "desc": meta.get("summary", "no summary provided"), | ||
| "info": long_description, | ||
| "caps": meta.get("capabilities", set()), | ||
| } |
There was a problem hiding this comment.
Let's describe what's in -meta.json with a jsonschema and validate it when loading.
There was a problem hiding this comment.
I added a schema now, please let me know if that is what you have/had in mind or if it too broad still?
mvo5
force-pushed
the
stage-separation-json
branch
2 times, most recently
from
f079fb0
to
9f0ad27
Compare
Instead of always parsing the python stage to load meta information
allow the user of a new `{stage}-meta.json` file. This is a first
step towards allowing modules to be written in a different language
than python. It also has some practical advantages:
- slightly faster as it avoids calling python to output the schemas
- easier to write schemas as this can be done in a real json editor
now
- more extensible in a future where stages maybe binaries with
shlib dependencies that are only satisfied in the buildroot
but not on the host
Some existing code/test assumes that anything in `stages/` is executable. This commit fixes this and excludes e.g. json from lintables.
With `.meta-json` it's a "real" file extension. The `-meta.json` feels a like bit too ad-hoc.
mvo5
force-pushed
the
stage-separation-json
branch
from
9f0ad27
to
716a56e
Compare
|
This PR is stale because it has been open 30 days with no activity. Remove "Stale" label or comment or this will be closed in 7 days. |
|
Seems a slightly bad time to get reviews currently so I close this for now |
|
Can you re-open this? I'd like to review and get this in in one shape or another. |
Instead of always parsing the python stage to load meta information
allow the user of a new
{stage}-meta.jsonfile. This is a firststep towards allowing modules to be written in a different language
than python. It also has some practical advantages:
now
shlib dependencies that are only satisfied in the buildroot
but not on the host
An example/toy stage that uses this can be seen in https://github.com/osbuild/osbuild/compare/main...mvo5:stage-separation-json-2?expand=1 (the last two commits)