Skip to content

Commit 43e3378

Browse files
authored
Merge pull request #238 from bart0sh/PR024-document-version-match
Document version match process
2 parents 4054ed6 + ab9d0aa commit 43e3378

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

SPEC.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,11 @@ Released versions of the spec are available as Git tags.
3333
| | | Add `AdditionalGIDs` to `ContainerEdits` |
3434
| v0.8.0 | | Remove .ToOCI() functions from specs-go package. |
3535

36+
*Note*: spec loading fails on unknown fields and when the minimum required version is higher than the version specified in the spec. The minimum required version is determined based on the usage of fields mentioned in the table above. For example the minimum required version is v0.6.0 if the `Annotations` field is used in the spec, but `IntelRdt` is not.
37+
`MinimumRequiredVersion` API can be used to get the minimum required version.
38+
39+
*Note*: Golang zero default values are used for all new fields so that the spec remains valid when loading older spec versions.
40+
3641
*Note*: The initial release of a **spec** with version `v0.x.0` will be tagged as
3742
`v0.x.0` with subsequent changes to the API applicable to this version tagged as `v0.x.y`.
3843
## Overview

0 commit comments

Comments
 (0)