python-tuf/docs/1.0.0-ANNOUNCEMENT.md
Lukas Puehringer b678de8c8b doc: reword announcement about upcoming 1.0.0
Change docs in preparation of close v1.0.0 release.

- Remove important notice about upcoming 1.0.0 release from README
- Reword 1.0.0-ANNOUNCEMENT.md to not sound outdated after release

Co-authored-by: Joshua Lock <jlock@vmware.com>
Signed-off-by: Jussi Kukkonen <jkukkonen@vmware.com>
2022-02-18 15:23:37 +02:00

2.1 KiB
Raw Permalink Blame History

Announcing TUF 1.0.0

Python-TUF v1.0.0 is a rewritten stable reference implementation of the TUF specification, which currently includes:

  • a modern low-level metadata API
  • a fully specification-compliant updater client, serving as a more robust and yet more flexible stand-in replacement for the legacy client updater

For the reasons outlined in ADR 10, this release does not yet include repository tool-like functionality. However, the new metadata API makes it easy to replicate the desired functionality tailored to the specific needs of any given repository (see Migration for details).

As discussed in ADR 2, this release does 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 applies as follows:

Bugs reported with tuf versions prior to 1.0.0 will likely not be addressed directly by tufs 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: