Skip to content

Commit bc3d2f1

Browse files
authored
Update README.md
Signed-off-by: Radoslav Dimitrov <radoslav@stacklok.com>
1 parent 6ad7fe5 commit bc3d2f1

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

README.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,34 @@
11
# go-tuf
22

3-
[![build](https://github.com/theupdateframework/go-tuf/workflows/build/badge.svg)](https://github.com/theupdateframework/go-tuf/actions?query=workflow%3Abuild) [![Coverage Status](https://coveralls.io/repos/github/theupdateframework/go-tuf/badge.svg)](https://coveralls.io/github/theupdateframework/go-tuf) [![PkgGoDev](https://pkg.go.dev/badge/github.com/theupdateframework/go-tuf)](https://pkg.go.dev/github.com/theupdateframework/go-tuf) [![Go Report Card](https://goreportcard.com/badge/github.com/theupdateframework/go-tuf)](https://goreportcard.com/report/github.com/theupdateframework/go-tuf)
3+
![ci](https://github.com/theupdateframework/go-tuf/actions/workflows/ci.yml/badge.svg) [![Coverage Status](https://coveralls.io/repos/github/theupdateframework/go-tuf/badge.svg)](https://coveralls.io/github/theupdateframework/go-tuf) [![PkgGoDev](https://pkg.go.dev/badge/github.com/theupdateframework/go-tuf)](https://pkg.go.dev/github.com/theupdateframework/go-tuf) [![Go Report Card](https://goreportcard.com/badge/github.com/theupdateframework/go-tuf)](https://goreportcard.com/report/github.com/theupdateframework/go-tuf)
44

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
9+
10+
Hey, everyone! 👋
11+
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.
13+
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.
31+
832
## Directory layout
933

1034
A TUF repository has the following directory layout:

0 commit comments

Comments
 (0)