search

galaxyproject / planemo

Command-line utilities to assist in developing Galaxy and Common Workflow Language artifacts - including tools, workflows, and training materials.
https://planemo.readthedocs.io/
MIT License
86 stars 85 forks source link

Fix parsing of training ``metadata.yaml`` files #1439

Closed nsoranzo closed 3 months ago

nsoranzo commented 4 months ago

Fix https://github.com/galaxyproject/planemo/issues/1415 .

hexylena commented 3 months ago

Do we test or should we somehow test that the generated yaml file is valid (wrt to a schema)? Does GTN has one? Should we request one?

the gtn has one, yes. but we are also considering alternative implementations that would be more integrated into the GTN, so, i'm not sure if it's worth the effort.

the schema is here: https://github.com/galaxyproject/training-material/blob/main/bin/schema-tutorial.yaml, but it does some non-standard things (namely replacing keywords like CONTRIBUTORS with their associated key upon parsing, and the 'examples' key that isn't part of kwalify, because those lists are also controlled but in separate data sources.)

We could emit a proper schema at an api endpoint that would be up-to-date if need be, just name the preferred format.

I kind of do not understood why those internal (variable) names need to be renamed

for me it would've been equivalent, yes, but i can see wanting to be sure all references are updated correctly.

nsoranzo commented 3 months ago

I kind of do not understood why those internal (variable) names need to be renamed

for me it would've been equivalent, yes, but i can see wanting to be sure all references are updated correctly.

Indeed, keeping variable names synced with the corresponding references was easy enough.