Skip to content

Commit d06ca61

Browse files
committed
doc: announce 1.0.0 stable release
* 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 tool (adr 10) - migration instructions * Add "important notice" to head of main README, pointing to above document. Signed-off-by: Lukas Puehringer <[email protected]>
1 parent 03cf333 commit d06ca61

File tree

2 files changed

+50
-0
lines changed

2 files changed

+50
-0
lines changed

1.0.0-ANNOUNCEMENT.md

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
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

README.md

+7
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,13 @@
66
[![CII](https://bestpractices.coreinfrastructure.org/projects/1351/badge)](https://bestpractices.coreinfrastructure.org/projects/1351)
77
[![PyPI](https://img.shields.io/pypi/v/tuf)](https://pypi.org/project/tuf/)
88

9+
----------------------------
10+
*__IMPORTANT NOTICE:__ A stable 1.0.0 release of the modern implementation only
11+
is scheduled for January 2022. Please see the [*1.0.0
12+
announcement*](1.0.0-ANNOUNCEMENT.md) page for more details about the release
13+
and the deprecation of the legacy implementation, including migration
14+
instructions.*
15+
916
----------------------------
1017
This repository is the **reference implementation** of
1118
[The Update Framework (TUF)](https://theupdateframework.github.io/).

0 commit comments

Comments
 (0)