Description
Whenever users of OCM want to build component versions, it is important to understand that the existing binding libraries offer support to create component versions with API Calls.
However, when working within the context of a CLI, the user experience is not as straightforward. There is a need for a more user-friendly approach to constructing component versions, especially for those who may not be familiar with the underlying API calls in the Go API directly.
As such we want to continue supporting commands in the form of
ocm add componentversions ./ctf component-constructor.yaml
This will require the support of the component constructor schema.
Currently the schema is available on the ocm website as a statically supported JSON scheme at https://ocm.software/schemas/configuration-schema.yaml
This schema is used to validate the component constructor YAML file and ensure that it adheres to the expected structure and data types.
The idea is to provide a similar experience as the existing OCM CLI that focuses on
- maintaining the format and structure of the
component-constructor.yaml file schema
- ensuring that input methods can be registered dynamically (via the plugin manager) or inbuilt (via the OCM CLI)
- reusing the existing binding libraries to interact with OCM repositories
Done Criteria
Description
Whenever users of OCM want to build component versions, it is important to understand that the existing binding libraries offer support to create component versions with API Calls.
However, when working within the context of a CLI, the user experience is not as straightforward. There is a need for a more user-friendly approach to constructing component versions, especially for those who may not be familiar with the underlying API calls in the Go API directly.
As such we want to continue supporting commands in the form of
This will require the support of the component constructor schema.
Currently the schema is available on the ocm website as a statically supported JSON scheme at https://ocm.software/schemas/configuration-schema.yaml
This schema is used to validate the component constructor YAML file and ensure that it adheres to the expected structure and data types.
The idea is to provide a similar experience as the existing OCM CLI that focuses on
component-constructor.yamlfile schemaDone Criteria