Skip to content

Commit 59be731

Browse files
authored
Merge pull request #66 from elezar/specversioning
[README] Add notes on versioning to SPEC.md
2 parents a97a05e + b65c2eb commit 59be731

File tree

2 files changed

+11
-2
lines changed

2 files changed

+11
-2
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# CDI - The Container Device Interface
22
## What is CDI?
33

4-
CDI (Container Device Interface), is a specification, for container runtimes, to support third party devices.
4+
CDI (Container Device Interface), is a [specification](SPEC.md), for container runtimes, to support third party devices.
55

66
CDI concerns itself only with enabling container to be device aware. Areas like resource management are explicitly left out of CDI (and is expected to be handled by the orchestrator). Because of this focus, the CDI specification is simple to implement and allows great flexibility to runtimes and orchestrators.
77

SPEC.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,23 @@
1010

1111
This is CDI **spec** version **0.3.0**.
1212

13-
#### Released versions
13+
### Update policy
14+
15+
Any modifications to the **spec** will result in at least a minor version bump. When releasing changes
16+
that only affect the API also implemented in this repository, the patch version will be bumped.
17+
18+
*Note*: The **spec** is still under active development and there exists the posibility of breaking changes being
19+
introduced with new versions.
20+
### Released versions
1421

1522
Released versions of the spec are available as Git tags.
1623

1724
| Tag | Spec Permalink | Change |
1825
| -----| -----------------| -------|
1926
| v0.3.0 | | Initial tagged release of Spec |
2027

28+
*Note*: The initial release of a **spec** with version `v0.x.0` will be tagged as
29+
`v0.x.0` with subsequent changes to the API applicable to this version tagged as `v0.x.y`.
2130
## Overview
2231

2332
The _Container Device Interface_, or _CDI_ describes a mechanism for container runtimes to create containers which are able to interact with third party devices.

0 commit comments

Comments
 (0)