Specify in which order metadata should be published to the repository #126
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 |
|---|---|---|
| @@ -1,8 +1,8 @@ | ||
| # <p align="center">The Update Framework Specification | ||
|
|
||
| Last modified: **06 October 2020** | ||
|
|
||
| Version: **1.0.10** | ||
|
|
||
| We strive to make the specification easy to implement, so if you come across | ||
| any inconsistencies or experience any difficulty, do let us know by sending an | ||
|
|
@@ -17,7 +17,7 @@ repo](https://github.com/theupdateframework/specification/issues). | |
| - [2. System Overview](#2-system-overview) | ||
| - [3. The Repository](#3-the-repository) | ||
| - [4. Document Formats](#4-document-formats) | ||
| - [5. Detailed Client Workflow](#5-detailed-client-workflow) | ||
| - [6. Usage](#6-usage) | ||
| - [7. Consistent Snapshots](#7-consistent-snapshots) | ||
| - [F. Future Directions and Open Questions](#f-future-directions-and-open-questions) | ||
|
|
@@ -462,6 +462,23 @@ repo](https://github.com/theupdateframework/specification/issues). | |
| Delegated target roles are authorized by the keys listed in the directly | ||
| delegating target role. | ||
|
|
||
| * **3.2 Repository metadata creation** | ||
|
|
||
| Metadata SHOULD be generated in the following sequence, in order to ensure | ||
| that metadata are not referenced in the repository before they have been | ||
| created. The below sequence assumes that all targets files referenced by | ||
| the metadata are available to the repository before the metadata is written. | ||
| When mirrors metadata is published by a repository it MAY be written at | ||
| any point after the initial metadata for the mirrored repository has been | ||
| created. | ||
|
|
||
| * **3.2.1** delegated targets metadata (DELEGATED_ROLE.EXT) | ||
| * **3.2.2** root metadata (root.EXT) | ||
| * **3.2.3** top-level targets metadata (targets.EXT) | ||
| * **3.2.4** snapshot metadata (snapshot.EXT) | ||
| * **3.2.5** timestamp metadata (timestamp.EXT) | ||
|
There was a problem hiding this comment. When would the mirror metadata be written? There was a problem hiding this comment. Oh yes, I forgot about mirror. I think it could be written at any point after the root metadata, because it's not actually referenced by or referencing any metadata explicitly. It may make sense to list it as 3.2.6, because then we can have some confidence that an implementation conforming to the spec won't write any mirrors metadata until all of the metadata it is mirroring has been written? There was a problem hiding this comment. Listing it as 3.2.6 makes sense to me. We can also mention it in the paragraph above to state that it can be written at any point. |
||
| * **3.2.6** mirrors metadata (mirrors.EXT) | ||
|
|
||
| ## **4. Document formats** | ||
|
|
||
| All of the formats described below include the ability to add more | ||
|
|
@@ -1064,9 +1081,7 @@ repo](https://github.com/theupdateframework/specification/issues). | |
| This behavior can be modified by the client code that uses the framework to, | ||
| for example, randomly select from the listed mirrors. | ||
|
|
||
| ## **5. Detailed Client Workflow** | ||
|
There was a problem hiding this comment. This contradicts the capitalisation change in #127 |
||
|
|
||
| Note: If a step in the following workflow does not succeed (e.g., the update | ||
| is aborted because a new metadata file was not signed), the client should | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I had originally written that as files but then, with #103 in mind, removed it. Happy to add files back in if you think it is an improvement. I'm anticipating that #103 may require a more intentional set of edits to the specification.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Omitting the word file does makes more sense in the context of #103. I find the plural use of metadata a bit confusing, but I think it's technically correct.