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

Clarifying SVN vs. Version. #1715

Merged
merged 1 commit into from
Mar 31, 2023
Merged

Conversation

matajoh
Copy link
Member

@matajoh matajoh commented Mar 30, 2023

This PR updates framework_svn and api_svn to be named framework_version and api_version, respectively. The original names were to represent a semantic version number, which was confusing in this context where SVN more commonly means security version number. Accordingly, the minimum_svn and svn fields for fragments will remain with the existing naming scheme but their support has been expanded to allow these strings to also be monotonically increasing integers, to be more in line with expectations around SVNs.

To provide a smooth transition, support for semantically versioned fragments and the *_svn naming scheme remain in the framework, but in a deprecated state. As part of this, the policy engline will provide a new error when the type of SVN is different between the SVN of the fragment and the minimum_svn property of a fragment policy object: fragment svn and the specified minimum are different types.

This commit updates `framework_svn` and `api_svn` to be named `framework_version` and `api_version`,
respectively. The original names were to represent a *semantic* version number, which was confusing
in this context where SVN more commonly means *security* version number. Accordingly, the
`minimum_svn` and `svn` fields for fragments will remain with the existing naming scheme but their
support has been expanded to allow these strings to also be monotonically increasing integers, to
be more in line with expectations around SVNs.

To provide a smooth transition, support for semantically versioned fragments and the `*_svn` naming
scheme remain in the framework, but in a deprecated state. As part of this, the policy engline will
provide a new error when the type of SVN is different between the SVN of the fragment and the
`minimum_svn` property of a fragment policy object: `fragment svn and the specified minimum are different types`.

Signed-off-by: Matthew A Johnson <matjoh@microsoft.com>
@matajoh matajoh requested a review from a team as a code owner March 30, 2023 08:27
@anmaxvl anmaxvl merged commit 50e1059 into microsoft:main Mar 31, 2023
takuro-sato pushed a commit to takuro-sato/hcsshim that referenced this pull request Apr 25, 2023
princepereira pushed a commit to princepereira/hcsshim that referenced this pull request Aug 29, 2024
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.

3 participants