Clarify Syntax of the #VERSION Header
#55
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
This PR clarifies the supported and intended syntax of the
#VERSIONheader.Following the discussion in #13 this PR clarifies that valid values of the version header look like
1.2.3and are intended to be have similarly to SermVer. However not all of the SemVer syntax is being used (e.g. prereleases).Closes Issue(s)
Relates to #13.
Motivation
I feel like stating that the
#VERSIONheader can be any valid SemVer is misleading if there is no intent of making use of prereleases or metadata. Having the syntax stated more clearly avoids misunderstandings and simplifies implementations.