Skip to content

Commit aa9e94c

Browse files
committed
Add spec version- and release mgmt instructions
- Add gitflow-based version- and release management instructions to the Versioning section of the README. - Add links to the "latest stable", "current draft", "new changes since latest stable" and "release history" of the specification to the header of the README document. Note that the version number of the latest stable version of the specification is no longer shown in the README, which eliminates the need to update the README with every new release.
1 parent 0f56aee commit aa9e94c

File tree

1 file changed

+31
-2
lines changed

1 file changed

+31
-2
lines changed

README.rst

Lines changed: 31 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
The Update Framework specification
22
----------------------------------
33

4-
Latest: `version 1.0.0 <https://github.com/theupdateframework/specification/blob/master/tuf-spec.md>`_
4+
- `latest stable <https://github.com/theupdateframework/specification/blob/master/tuf-spec.md>`_
5+
- `current draft <https://github.com/theupdateframework/specification/blob/draft/tuf-spec.md>`_
6+
- `new changes since latest stable <https://github.com/theupdateframework/specification/compare/master..draft>`_
7+
- `release history <https://github.com/theupdateframework/specification/tags>`_
58

69

710
Contact
@@ -31,7 +34,33 @@ Versioning
3134
----------
3235

3336
The TUF specification uses `Semantic Versioning 2.0.0 <https://semver.org/>`_
34-
for its version numbers.
37+
(semver) for its version numbers, and a gitflow-based release management:
38+
39+
- The 'master' branch of this repository always points to the latest stable
40+
version of the specification.
41+
- The 'draft' branch of this repository always points to the latest development
42+
version of the specification and must always be based off of the latest
43+
'master' branch.
44+
- Contributors must submit changes as pull requests against these branches,
45+
depending on the type of the change (see semver rules).
46+
- For patch-type changes, pull requests may be submitted directly against the
47+
'master' branch.
48+
- For major- and minor-type changes, pull requests must be submitted against
49+
the 'draft' branch.
50+
- Maintainers may, from time to time, decide that the 'draft' branch is ready
51+
for a new major or minor release, and submit a pull request from 'draft'
52+
against 'master'.
53+
- Before merging a branch with 'master' the 'last modified date' and 'version'
54+
in the specification header must be bumped.
55+
- Merges with 'master' that originate from the 'draft' branch must bump either
56+
the major or minor version number.
57+
- Merges with 'master' that originate from any other branch must bump the patch
58+
version number.
59+
- Merges with 'master' must be followed by a git tag for the new version
60+
number.
61+
- Merges with 'master' must be followed by a rebase of 'draft' onto 'master'.
62+
63+
3564

3665
Acknowledgements
3766
----------------

0 commit comments

Comments
 (0)