Skip to content

Commit c1af60d

Browse files
committed
Add tagged release process to spec
Signed-off-by: Marcela Melara <[email protected]>
1 parent b382eb5 commit c1af60d

File tree

2 files changed

+20
-2
lines changed

2 files changed

+20
-2
lines changed

spec/README.md

+11
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,16 @@ The source of this diagram can be found [here](../images/envelope_relationships.
2424
The [validation model] provides pseudocode showing how these layers fit
2525
together. See the [documentation] for more background and examples.
2626

27+
## Tagged Releases
28+
29+
The latest [tagged release] version matches the [SemVer](https://semver.org)
30+
MAJ.MIN version of the Attestation Framework spec.
31+
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
35+
specifications and/or backwards-compatible changes to the language bindings.
36+
2737
## Keywords
2838

2939
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD",
@@ -41,5 +51,6 @@ this specification are to be interpreted as described in [RFC 2119].
4151
[Statement]: v1/statement.md
4252
[documentation]: ../docs
4353
[in-toto-verify]: https://github.com/in-toto/in-toto#verification
54+
[tagged release]: https://github.com/in-toto/attestation/releases
4455
[v1.1]: v1/README.md
4556
[validation model]: ../docs/validation.md

spec/versioning.md

+9-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,16 @@
11
# Versioning Rules
22

3+
Predicate specifications are versioned independently from the Attestation
4+
Framework specification in order to allow for predicates to evolve as needed
5+
without depending on the evolution of the Statement layer, for example.
6+
7+
The following rules apply to both Statement and predicate specification
8+
versioning.
9+
310
## Objective
411

5-
This document explains how version changes and extension fields are handled. For
6-
a summary, see [parsing rules](v1/README.md#parsing-rules) in the README.
12+
This document explains how version changes and extension fields are handled.
13+
For a summary, see [parsing rules](v1/README.md#parsing-rules) in the README.
714

815
## Versioning rules
916

0 commit comments

Comments
 (0)