|
| 1 | +# Announcing TUF 1.0.0 |
| 2 | + |
| 3 | +In the past year we have made an effort to revise, redesign and rewrite this |
| 4 | +python-tuf reference implementation, and we are very excited to announce a |
| 5 | +stable 1.0.0 release scheduled for January 2022. The release *will* include: |
| 6 | +- a modern low-level [*metadata |
| 7 | + API*](https://theupdateframework.readthedocs.io/en/latest/api/tuf.api.html) |
| 8 | +- a fully specification-compliant [*updater |
| 9 | + client*](https://theupdateframework.readthedocs.io/en/latest/api/tuf.ngclient.html), |
| 10 | + serving as a more robust and yet more flexible stand-in replacement |
| 11 | + for the legacy client updater |
| 12 | + |
| 13 | +As discussed in [ADR 2](docs/adr/0002-pre-1-0-deprecation-strategy.md), this |
| 14 | +release *will not* include any legacy code, as its maintenance has become |
| 15 | +infeasible for the python-tuf team. The pre-1.0.0 deprecation strategy from ADR |
| 16 | +2 applies as follows: |
| 17 | + |
| 18 | +> *Bugs reported with tuf versions prior to 1.0.0 will likely not be addressed |
| 19 | +directly by tuf’s maintainers. Pull Requests to fix bugs in the last release |
| 20 | +prior to 1.0.0 will be considered, and merged (subject to normal review |
| 21 | +processes). Note that there may be delays due to the lack of developer resources |
| 22 | +for reviewing such pull requests.* |
| 23 | + |
| 24 | +For the reasons outlined in [ADR 10](docs/adr/0010-repository-library-design.md |
| 25 | +), this release *will not yet* include a new *repository tool*. However, the new |
| 26 | +*metadata API* makes it easy to replicate the desired functionality tailored to |
| 27 | +the specific needs of any given repository (see *Migration* for details). |
| 28 | + |
| 29 | + |
| 30 | + |
| 31 | + |
| 32 | +## Migration |
| 33 | + |
| 34 | +Given the clean cut with the legacy reference implementation, we provide the |
| 35 | +following migration support: |
| 36 | + |
| 37 | +- detailed code documentation on |
| 38 | + [https://theupdateframework.readthedocs.io](https://theupdateframework.readthedocs.io/) |
| 39 | +- verbose [code examples](examples/) for *client updater* usage, and |
| 40 | + repository-side operations based on the low-level *metadata API* |
| 41 | +- individual migration support upon |
| 42 | + [request](https://github.com/theupdateframework/python-tuf#contact) |
| 43 | +- targeted migration support initiative for known users |
0 commit comments