Skip to content

Commit 148ce9f

Browse files
authored
Apply Joshua's feedback
Signed-off-by: Radoslav Dimitrov <radoslav@stacklok.com>
1 parent bc3d2f1 commit 148ce9f

File tree

1 file changed

+4
-20
lines changed

1 file changed

+4
-20
lines changed

README.md

Lines changed: 4 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -5,29 +5,13 @@
55
This is a Go implementation of [The Update Framework (TUF)](http://theupdateframework.com/),
66
a framework for securing software update systems.
77

8-
## News
8+
## API instability
99

10-
Hey, everyone! 👋
10+
**Note**: go-tuf's API is in flux and backwards compatibility with version 0.7.0 and earlier will _**not**_ be maintained.
1111

12-
We'd like to inform you that as a continuation of https://github.com/theupdateframework/go-tuf/issues/485, we have started the process of deprecating the existing https://github.com/theupdateframework/go-tuf code base in favour of https://github.com/rdimitrov/go-tuf-metadata.
12+
We recommend production users of go-tuf pin their dependency so that changes in main do not cause disruptions.
1313

14-
**Reasoning:**
15-
16-
* The reasoning behind this is explained in https://github.com/theupdateframework/go-tuf/issues/485, but essentially the new code base is much simpler, easier to work with and last but not least, easier to maintain and contribute to. The last two have been longstanding issues for go-tuf and we are looking forward to address them with this change.
17-
* Deep thank you to all of the people that helped shaping this effort!
18-
19-
**Details:**
20-
21-
* **This will not happen straight away!**
22-
* We'll continue to support this version in a separate branch(v0.7.0) until the migration process is considered as completed.
23-
* We advise all users to pin their dependencies of go-tuf to a certain release version (in case they haven't already) so they don't experience any inconveniences, i.e. `github.com/theupdateframework/go-tuf v0.7.0`
24-
* We'll continue to use the https://github.com/theupdateframework/go-tuf repository, but its content will be updated to accommodate the changes. We'll start introducing the go-tuf-metadata code base to the master branch of go-tuf, so technically there will be times where the master branch might be considered unstable (which is a general practice).
25-
* Even though go-tuf is pre-v1.0.0 and technically there are no API commitments to be followed, we won't release a v1.0.0 either with the new code base until it is well tested and we are sure of its stability.
26-
27-
Apologies for the disruption and thank you in advance for the understanding!
28-
29-
Yours,
30-
The go-tuf maintainers team.
14+
For more details on the changes, and the rationale for making them, see issue https://github.com/theupdateframework/go-tuf/issues/485 and the release notes for [v0.7.0](https://github.com/theupdateframework/go-tuf/releases/tag/v0.7.0)
3115

3216
## Directory layout
3317

0 commit comments

Comments
 (0)