docs(conventions): define artefact-linking label convention - #146
Draft
bedirhan-yilmaz wants to merge 4 commits into
Draft
docs(conventions): define artefact-linking label convention#146bedirhan-yilmaz wants to merge 4 commits into
bedirhan-yilmaz wants to merge 4 commits into
Conversation
…ationships Signed-off-by: Bedirhan Yilmaz (bedirhan-yilmaz) <bedirhan.yilmaz@sap.com>
8R0WNI3
reviewed
Jul 23, 2026
a-thaler
reviewed
Jul 24, 2026
a-thaler
reviewed
Jul 24, 2026
Signed-off-by: Bedirhan Yilmaz (bedirhan-yilmaz) <bedirhan.yilmaz@sap.com>
fabianburth
reviewed
Jul 28, 2026
| type: sbom | ||
| extraIdentity: | ||
| architecture: arm64 | ||
| labels: |
Contributor
There was a problem hiding this comment.
- name: ocm.software/artefactReferences # check whether we want different conventions than camel case
version: v1
value:
- identity:
name: my-image
version: 1.2.3
foo: bar
metadata: # once we need it
Contributor
There was a problem hiding this comment.
even for in-house labels, we might want to prefix with ocm.software
There was a problem hiding this comment.
If we want to follow conventions on K8s annotations & labels, it would be good to have ocm.software as a prefix :-)
8R0WNI3
reviewed
Jul 28, 2026
…e structure Signed-off-by: Bedirhan Yilmaz (bedirhan-yilmaz) <bedirhan.yilmaz@sap.com>
bedirhan-yilmaz
force-pushed
the
feat/artefact-linking-label-convention
branch
from
July 28, 2026 11:31
ee2a87e to
ef044c9
Compare
Author
|
Since the K8S docs and ODG labels use kebab-case, I suggest we take the same approach for the label format |
fabianburth
requested changes
Jul 28, 2026
| ### Label Name | ||
|
|
||
| ``` | ||
| ocm.software/artefact-references |
Contributor
There was a problem hiding this comment.
nit: Do we think we will move towards a new spec version with artifacts instead of resources and sources soon? Currently, it seems rather like we will deprecate sources and keep the rest of the spec. So maybe ocm.software/resource-references would be more fitting?
| and is appended, separated by a slash (`/`). | ||
| organization (for example `odg.ocm.software/binary-scan-policy`). | ||
| The local name MUST use kebab-case and is appended, separated by a slash (`/`). | ||
|
|
Contributor
There was a problem hiding this comment.
nit: might want to restructure a little bit as the dns prefix convention now also applies to the predefined labels
Signed-off-by: Bedirhan Yilmaz (bedirhan-yilmaz) <bedirhan.yilmaz@sap.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What this PR does / why we need it
Adds a convention to the OCM spec for expressing cross-artefact relationships via labels. This allows a derived resource (e.g. an SBoM) to declare which subject resource it relates to within the same component version, using a structured label placed on the derived artefact.
Which issue(s) this PR is related to
Fixes open-component-model/open-delivery-gear#126