Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Discuss regarding merging meta.yaml and devfile.yaml #172

Closed
GeekArthur opened this issue Oct 13, 2020 · 1 comment · Fixed by #248
Closed

Discuss regarding merging meta.yaml and devfile.yaml #172

GeekArthur opened this issue Oct 13, 2020 · 1 comment · Fixed by #248
Assignees
Labels
area/registry Devfile registry for stacks and infrastructure

Comments

@GeekArthur
Copy link
Contributor

Is your feature request related to a problem? Please describe.
Currently the registry index generator generates the index.json based on the fields in meta.yaml of each devfile component, we may need to use fields in devfile.yaml of each devfile component as well. Therefore, merging meta.yaml and devfile.yaml can help us centralize all the fields in one file then we can parse and generate index.json from one place.

Two things we need to discuss here:

  • Does meta.yaml has any special usage for consumers (eg. Che, odo)?
  • Is there anything that blocks us from merging meta.yaml and devfile.yaml?

Describe alternatives you've considered
Alternative 1:
We still use meta.yaml and devfile.yaml separately + DON'T ADD fields from meta.yaml to devfile.yaml (Today's version) -> we need to handle the case where there is a conflict exists between meta.yaml and devfile.yaml

Alternative 2:
We still use meta.yaml and devfile.yaml separately + ADD fields from meta.yaml to devfile.yaml -> only parse devfile.yaml then generate index.json

@elsony @davidfestal Please feel free to add questions and comments and we can discuss from there, thanks!

@GeekArthur GeekArthur added the area/registry Devfile registry for stacks and infrastructure label Oct 13, 2020
@GeekArthur GeekArthur self-assigned this Oct 13, 2020
@GeekArthur
Copy link
Contributor Author

GeekArthur commented Nov 19, 2020

I already checked the meta.yaml schema in che repo, in summary, we need to add the following fields from meta.yaml to devfile.yaml

displayName: String
description: String
tags: String[]
icon: String
globalMemoryLimit: String

My plan is to move those fields under metadata field/struct of devfile.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/registry Devfile registry for stacks and infrastructure
Projects
None yet
1 participant