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

fix!: spec version field to follow semver #512

Conversation

rdimitrov
Copy link
Contributor

@rdimitrov rdimitrov commented Jul 3, 2023

The following PR updates the initial spec_version values for all metadata roles so they comply with the specification by following the SemVer format.

Note that if there's an implementation that depends on a non-spec compliant versioning it may be affected by this change, so thus why it is marked as breaking.

Related #206

Release Notes:

Types of changes:

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected). Please ensure that your PR title is a Conventional Commit breaking change (with a !, as in feat!: change foo).

Description of the changes being introduced by the pull request:

Please verify and check that the pull request fulfills the following requirements:

  • Tests have been added for the bug fix or new feature
  • Docs have been added for the bug fix or new feature

@rdimitrov rdimitrov self-assigned this Jul 3, 2023
@rdimitrov rdimitrov added bug go Pull requests that update Go code breaking labels Jul 3, 2023
Copy link
Member

@trishankatdatadog trishankatdatadog left a comment

Choose a reason for hiding this comment

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

Would this break new clients on old metadata? Could/should we make it tolerant of the exact string "1.0"?

@rdimitrov
Copy link
Contributor Author

Would this break new clients on old metadata? Could/should we make it tolerant of the exact string "1.0"?

From what I've seen I haven't found a place where go-tuf actually takes into account the format of the spec_version value, so thus why I think it shouldn't break any new or existing go-tuf clients.

Nevertheless, I've marked it as breaking due to the fact that there might be some other client implementation (go or something else) that actually takes into account this format.

@rdimitrov
Copy link
Contributor Author

Closing this one since the code base change and is no longer relevant

@rdimitrov rdimitrov closed this Jan 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking bug go Pull requests that update Go code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants