theupdateframework / theupdateframework/specification
Why filenames instead of rolenames in snapshot?
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 405
- Forks
- 59
- Avg merge
- 3d 4h
- Merged PRs (30d)
- 1
Description
Previously, we used to allow metadata files nested inside directories, which explains the following text in the specification:
METAFILES is an object whose format is the following:
{ METAPATH : {
"version" : VERSION,
("length" : LENGTH,)
("hashes" : HASHES) }
, ...
}
METAPATH is the file path of the metadata on the repository relative to the
metadata base URL. For snapshot.json, these are top-level targets metadata
and delegated targets metadata.
However, I don't think we need METAPATH anymore. Instead, all we need is to list valid targets rolenames instead, correct?
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with section 4, “Document Formats,” of the linked specification and review the METAFILES and METAPATH definitions in the snapshot format. Determine whether snapshot metadata should list repository file paths or valid target rolenames, then update the specification once that format decision is agreed.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100