Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Introduce semantic versioning 2.0.0 and disambiguates spec versions #51

Merged
merged 6 commits into from
Sep 17, 2019

Conversation

lukpueh
Copy link
Member

@lukpueh lukpueh commented Sep 13, 2019

Closes #36 and #33

  • Updates readme to mention use of semantic versioning for the specification
  • Changes spec version "1.0" to "1.0.0", to follow semantic versioning, and bumps the "Last modified" date in the specification working document.
  • Updates specification text to clarify that the SPEC_VERSION field in TUF metadata must be a string that follows semantic versioning.
  • Moves tuf-spec.0.9.txt to historical/tuf-spec.0.9.txt to avoid confusion with current specification working document, i.e. tuf-spec.md, which currently is a draft for 1.0.0.

Move tuf-spec.0.9.txt to subdir to avoid confusion with current
specification working document, i.e. tuf-spec.md.
- Changes "1.0" to "1.0.0" and bumps the "Last modified" date in
  the specification working document.
  NOTE: the "(Draft)" supplement is not part of semantic versioning
- Mentions use of semantic versioning in the spec's readme
Copy link
Member

@JustinCappos JustinCappos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need the "Draft" tag for version 1.0.0? Otherwise it looks good to merge.

Copy link
Collaborator

@mnm678 mnm678 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

Copy link
Member

@JustinCappos JustinCappos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we also want to update the TAPs to say what version they are included in? (If not, I'm fine merging this as-is.)

@lukpueh
Copy link
Member Author

lukpueh commented Sep 16, 2019

Do we need the "Draft" tag for version 1.0.0?

I'd only remove it if this revision is the final 1.0.0 version of the specification. In that case we should also tag it as such. Does anyone, more familiar with the specification, want to make the call? @JustinCappos, @mnm678, @SantiagoTorres, @trishankatdatadog?

Copy link
Member

@JustinCappos JustinCappos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removing draft tag from spec.

README.rst Outdated Show resolved Hide resolved
tuf-spec.md Outdated Show resolved Hide resolved
@JustinCappos JustinCappos merged commit 9f14855 into master Sep 17, 2019
lukpueh added a commit to lukpueh/specification that referenced this pull request Oct 17, 2019
theupdateframework#51 updates the format of the
"spec_version" field in any tuf metadata to strictly require a
string that conforms to the Semantic Versioning 2.0.0 standard.

This commit updates the metadata examples in the specification
accordingly.
@trishankatdatadog trishankatdatadog deleted the disambiguate-spec-versions branch November 4, 2019 12:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Clarifying the format of "spec_version"
4 participants