theupdateframework / theupdateframework/specification

Repository operations: when to update metadata version

Open
#253 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
405
Forks
59
Avg merge
3d 4h
Merged PRs (30d)
1

Description

The repository operations section of the specification should make it crystal clear when the VERSION in metadata should be increased.

This has come up recently for two repository implementations:

  1. https://github.com/theupdateframework/python-tuf/issues/2020
  2. https://github.com/sigstore/root-signing/pull/410

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the repository operations section of the specification and the linked VERSION metadata definition. Compare the wording with the python-tuf issue and sigstore/root-signing pull request, then clarify exactly when metadata VERSION must increase; done means the specification leaves no ambiguity for repository implementations.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
Half a day
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.