docs(oci): relax component version identification rules - #147
Open
piotrjanik wants to merge 2 commits into
Open
Conversation
<!-- markdownlint-disable MD041 --> #### What this PR does / why we need it Requiring the deprecated `software.ocm.componentversion` annotation on every tagged manifest is too strict: it forces writers to keep emitting a deprecated form and gives readers no sanctioned fallback when it is absent. This relaxes the OCI storage-backend spec so that annotation becomes optional (`MUST` → `MAY`), promotes the component-key annotations to the recommended verification form (`MAY` → `SHOULD`), and defines a deterministic fallback: when no annotation is present, clients identify a component version by the manifest config media type (current or legacy Gardener/cnudie) and derive the version from the tag. The compatibility section documents the two legacy config media types readers SHOULD accept and writers MUST NOT produce. #### Which issue(s) this PR fixes Fixes: https://github.com/open-component-model/ocm-spec/issues/2889 Signed-off-by: Piotr Janik <piotr.janik@sap.com>
Signed-off-by: Piotr Janik <piotr.janik@sap.com>
matthiasbruns
approved these changes
Jul 28, 2026
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
2 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
Requiring the deprecated
software.ocm.componentversionannotation on every tagged manifest is too strict: it forces writers to keep emitting a deprecated form and gives readers no sanctioned fallback when it is absent.This relaxes the OCI storage-backend spec so that annotation becomes optional (
MUST→MAY), promotes the component-key annotations to the recommended verification form (MAY→SHOULD), and defines a deterministic fallback: when no annotation is present, clients identify a component version by the manifest config media type (current or legacy Gardener/cnudie) and derive the version from the tag. The compatibility section documents the two legacy config media types readers SHOULD accept and writers MUST NOT produce.Which issue(s) this PR fixes
Fixes: open-component-model/open-component-model#2889
What this PR does / why we need it
Which issue(s) this PR is related to