Versioning reform #4706
Merged
Versioning reform #4706
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
mossheim
added
comp: build
this commit updates how versioning is communicated across the codebase. the most important change is that SCVersion.txt now separates the 'patch' and 'tweak' version components in new CMake variables called SC_VERSION_[MAJOR,MINOR,PATCH,TWEAK]. 'patch' is always numeric, while 'tweak' is the optional component used for '-beta1', '-rc2'. the old variables are kept for backwards compatibility. we use these to set the VERSION in the CMake call to project(), which fixes #4648. however, this requires that we strip the 'tweak' component since only digits and periods are allowed in version strings. so, we replace references to PROJECT_VERSION with SC_VERSION where appropriate. this also allows us to be more precise with versioning in the class library. previously, we only had a method that would return the ".4-beta1" part of the version string, Main.scVersionPostfix. this commit deprecates that method and replaces it with Main.scVersionPatch and Main.scVersionTweak. now, we can also update Main.versionAtMost and Main.versionAtLeast to check the patch version as well. scsynth and supernova's `/version.reply` contents are kept the same for backwards compatibility. documentation added/updated for all affected methods. tests added for Main.versionAtMost/Least testing checklist: - try re-configuring cmake multiple times to confirm #4648 is fixed - check that outputs of Main.version, Main.scVersionFoo commands are unchanged - check that scsynth and supernova replies to /version are unchanged
|
ready for review. i've tested everything i listed above that's relevant to this PR, but there is probably more testing that could be done |
telephon
approved these changes
Dec 30, 2019
|
I also tested and can confirm that:
|
|
just want to note, i anticipate that this will some way or another break something in the future in a way we haven't thought of.. it's too much editing of the build system for Murphy's law not to apply 😆 . i'll hold myself responsible for fixing that when it comes up. |
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.
Purpose and Motivation
this commit updates how versioning is communicated across the codebase.
the most important change is that SCVersion.txt now separates the
'patch' and 'tweak' version components in new CMake variables called
SC_VERSION_[MAJOR,MINOR,PATCH,TWEAK]. 'patch' is always numeric, while
'tweak' is the optional component used for '-beta1', '-rc2'. the old
variables are kept for backwards compatibility.
we use these to set the VERSION in the CMake call to project(), which
fixes #4648. however, this requires that we strip the 'tweak' component
since only digits and periods are allowed in version strings. so, we
replace references to PROJECT_VERSION with SC_VERSION where appropriate.
this also allows us to be more precise with versioning in the class
library. previously, we only had a method that would return the
".4-beta1" part of the version string, Main.scVersionPostfix. this
commit deprecates that method and replaces it with Main.scVersionPatch
and Main.scVersionTweak. now, we can also update Main.versionAtMost and
Main.versionAtLeast to check the patch version as well.
scsynth and supernova's
/version.replycontents are kept the same forbackwards compatibility.
documentation added/updated for all affected methods.
testing checklist:
unchanged
i have tested the above points and found no issues.
Types of changes
To-do list