ADR0003: where to develop TUF 1.0.0

Document the outcome of theupdateframework#1126 to develop TUF 1.0.0 in a subdirectory of the current TUF implementation. Signed-off-by: Teodora Sechkova <[email protected]>
sechkova · Nov 23, 2020 · 8db81fd · joshuagl · Nov 23, 2020 · joshuagl
1 parent 6333a4e
commit 8db81fd
Show file tree

Hide file tree

Showing 2 changed files with 47 additions and 0 deletions.
diff --git a/docs/adr/0003-where-to-develop-TUF-1-0-0.md b/docs/adr/0003-where-to-develop-TUF-1-0-0.md
@@ -0,0 +1,46 @@
+# Develop TUF 1.0.0 in a subdirectory of the current TUF implementation
+
+* Status: accepted
+* Date: 2020-11-23
+
+Technical Story: https://github.com/theupdateframework/tuf/issues/1126
+
+## Context and Problem Statement
+
+The plan is to implement a refactored TUF (1.0.0) alongside the current
+code base, in order to not disrupt existing usage and keep providing
+a Python 2.7 client.
+
+We need to decide on the best place to do this development.
+
+## Decision Drivers
+
+* Developing the new code in piecemeal
+* Continuing to make releases in the interim
+* Avoiding maintenance overhead
+
+## Considered Options
+
+Develop TUF 1.0.0:
+
+* In its own repository
+* In a separate develop branch of the current TUF implementation
+* In the default branch, archiving the current implementation
+* In a subdirectory of the current TUF implementation
+
+## Decision Outcome
+
+Chosen option: "Develop TUF 1.0.0 in a subdirectory of the current TUF
+implementation", because we want to add the new TUF code gradually
+while keep maintaining the current implementation given a limited
+maintenance resources.
+
+### Negative Consequences
+
+* In progress development in the default branch causes messiness
+  in plain sight.
+
+## Links
+
+* [Discussion of Python version support in TUF 1.0.0](https://github.com/theupdateframework/tuf/issues/1125)
+* [Discussion of deprecation policy for the pre-1.0, Python 2.7 supporting, code](https://github.com/theupdateframework/tuf/issues/1127)
diff --git a/docs/adr/index.md b/docs/adr/index.md
@@ -6,6 +6,7 @@ This log lists the architectural decisions for tuf.
 
 - [ADR-0000](0000-use-markdown-architectural-decision-records.md) - Use Markdown Architectural Decision Records
 - [ADR-0001](0001-python-version-3-6-plus.md) - Default to Python 3.6 or newer for new development
+- [ADR-0003](0003-where-to-develop-TUF-1-0-0.md) - Develop TUF 1.0.0 in a subdirectory of the current TUF implementation
 
 <!-- adrlogstop -->