-
Notifications
You must be signed in to change notification settings - Fork 272
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Add a document that announces a stable "modern implementation"-only 1.0.0 release, with the following contents: - the scheduled release date - contents of release (metadata API, ngclient, no legacy code) - legacy code deprecation note (adr 2) - note about lack of repository rool (adr 10) - migration instructions * Add "important notice" to head of main README, pointing to above document. Signed-off-by: Lukas Puehringer <[email protected]>
- Loading branch information
Showing
2 changed files
with
50 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,43 @@ | ||
# 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 we are very excited to announce a | ||
stable 1.0.0 release scheduled for January 2022. 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 | ||
|
||
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 applies 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.* | ||
|
||
For the reasons outlined in [ADR 10](docs/adr/0010-repository-library-design.md | ||
), this release *will not* include a new *repository tool*. However, the new | ||
*metadata API* makes it easy to replicate the desired functionality tailored to | ||
the specific needs of a any given repository (see *Migration* for details). | ||
|
||
|
||
|
||
|
||
## Migration | ||
|
||
Given the clean cut with the legacy reference implementation, we provide the | ||
following migration support: | ||
|
||
- detailed code documentation on | ||
[https://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 initiative 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