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

rename component-descriptors inside the target OCI repository into: componentversions #1053

Open
hilmarf opened this issue Nov 5, 2024 · 5 comments
Labels
area/ipcei Important Project of Common European Interest kind/feature new feature, enhancement, improvement, extension
Milestone

Comments

@hilmarf
Copy link
Member

hilmarf commented Nov 5, 2024

What would you like to be added:

The ocm-cli is speaking from componentversions, e.g.

ocm transfer componentversions

But at the target OCI repository is then a folder component-descriptors been created. Why do we have this naming clash?

Why is this needed:

Are we transporting component-descriptors or componentversions? Or are componentversions transferred and turned automatically during transfer into component-descriptors? It's too confusing. Let's please keep things as simple as possible:

Create a new component version out of a component-constructor.yaml with:

ocm add componentversion --create --file ctf .\component-constructor.yaml

and then transfer it. There is no 'component-descriptor' involved.

@hilmarf hilmarf added the kind/feature new feature, enhancement, improvement, extension label Nov 5, 2024
@hilmarf hilmarf added this to the 2024-Q4 milestone Nov 5, 2024
@github-actions github-actions bot added the area/ipcei Important Project of Common European Interest label Nov 5, 2024
@jakobmoellerdev
Copy link
Contributor

Im only wondering if

ocm add componentversion --create --type ctf [--file] .\component-constructor.yaml

makes more sense?

@hilmarf
Copy link
Member Author

hilmarf commented Nov 5, 2024

Synopsis:
  ocm add componentversions [<options>] [--version <version>] [<ctf archive>] {<component-constructor.yaml>}

Flags:
  -F, --file string               target file/directory (default "transport-archive")
  -t, --type string               archive format (directory, tar, tgz) (default "directory")
  -O, --output string             output file for dry-run

@ikhandamirov
Copy link
Contributor

On the other hand, the users likely got used to the name component-descriptors, which is how the folder is called for years. The name is probably mentioned on a number of documentation pages. I can imagine that renaming it would be confusing to existing users, i.e. is a kind of breaking change.

In our attempt to simplify things we should try to avoid creating even more chaos.

@jakobmoellerdev
Copy link
Contributor

The issue is also that every componentversion is described by a, you guessed it, component-descriptor. So technically the old name is still valid :D

@jakobmoellerdev
Copy link
Contributor

I vote to leave the existing syntax as it is integral to not introduce unnecessary breaking changes even if some of them are not 100% convenient for first time users

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/ipcei Important Project of Common European Interest kind/feature new feature, enhancement, improvement, extension
Projects
Status: 🆕 ToDo
Development

No branches or pull requests

3 participants