forked from theupdateframework/python-tuf
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add 1.0.0 announcment document and point to it in main README. TODO: - Commit message - PR (blocks on theupdateframework#1693, theupdateframework#1675, maybe theupdateframework#1700)
- Loading branch information
Showing
2 changed files
with
45 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
# Announcing TUF 1.0.0 | ||
|
||
In the past year we have made an effort to revise, redesign and rewrite this | ||
python-tuf reference implementation, and are very excited to announce a stable | ||
1.0.0 release. The release *will* include: | ||
- a modern low-level [Metadata | ||
API](https://theupdateframework.readthedocs.io/en/latest/api/tuf.api.html) | ||
- a fully specification-compliant [updater | ||
client](https://theupdateframework.readthedocs.io/en/latest/api/tuf.ngclient.html), | ||
serving as a more robust and yet more flexible stand-in replacement | ||
for the legacy client updater | ||
|
||
For the reasons outlined in [ADR 10](docs/adr/0010-repository-library-design.md | ||
), this release *will not* include a new repository tool. That said, the new | ||
Metadata API now makes it easy to replicate the desired functionality based on | ||
the specific needs of a given repository (more about *migration* below). | ||
|
||
As discussed in [ADR 2](docs/adr/0002-pre-1-0-deprecation-strategy.md), this | ||
release *will not* include any legacy code, as its maintenance has become | ||
infeasible for the python-tuf team. The pre-1.0.0 deprecation strategy from ADR | ||
2 reads as follows: | ||
|
||
> *Bugs reported with tuf versions prior to 1.0.0 will likely not be addressed | ||
directly by tuf’s maintainers. Pull Requests to fix bugs in the last release | ||
prior to 1.0.0 will be considered, and merged (subject to normal review | ||
processes). Note that there may be delays due to the lack of developer resources | ||
for reviewing such pull requests.* | ||
|
||
|
||
## Migration | ||
|
||
Given the clean cut with the legacy reference implementation, we provide the | ||
following migration support: | ||
|
||
- detailed code documentation on [theupdateframework.readthedocs.io](https://theupdateframework.readthedocs.io/) | ||
- verbose [code examples](examples/) for client updater usage, and | ||
repository-side operations based on the low-level metadata API | ||
- individual migration support upon [request](https://github.com/theupdateframework/python-tuf#contact) | ||
- targeted migration support for known users |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters