@@ -27,13 +27,30 @@ together. See the [documentation] for more background and examples.
27
27
## Tagged Releases
28
28
29
29
The latest [ tagged release] version matches the [ SemVer] ( https://semver.org )
30
- MAJ.MIN version of the Attestation Framework spec.
30
+ MAJOR.MINOR version of the Attestation Framework spec.
31
31
32
32
Backwards-compatible semantic updates to the spec (except predicates) are
33
- indicated through new tagged minor version releases.
34
- We use new tagged patch version releases to indicate updates to predicate
33
+ indicated through new tagged MINOR version releases.
34
+ We use new tagged PATCH version releases to indicate updates to predicate
35
35
specifications and/or backwards-compatible changes to the language bindings.
36
36
37
+ ### Examples
38
+ - Attestation Framework tagged release v1.0.2 (PATCH version) incorporates
39
+ refinements to the predicate specification process, a new predicate type,
40
+ and a small patch to the Golang language bindings. None of these changes
41
+ affects the semantics of the core spec. The ` _type ` of a ` Statement ` is
42
+ still ` https://in-toto.io/Statement/v1 ` .
43
+ - Tagged release v1.1.0 (MINOR version) generalizes the semantics of the
44
+ ` DigestSet ` field type to support any type of immutable identifier.
45
+ This change is backwards comptabile because cryptographic digests are
46
+ strongly recommended to achieve immutability, so any implementations that
47
+ only support cryptographic ` DigestSet ` still meet the modified semantics.
48
+ The ` _type ` of a ` Statement ` is still ` https://in-toto.io/Statement/v1 `
49
+ but a new entry in the ` v1 ` CHANGELOG is added.
50
+ - Tagged release v2.0.0 (MAJOR version) changes the meaning of the
51
+ ` predicateType ` field. A new ` v2 ` directory is added to ` /spec ` and the
52
+ ` _type ` of a ` Statement ` becomes ` https://in-toto.io/Statement/v2 ` .
53
+
37
54
## Keywords
38
55
39
56
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD",
0 commit comments