[IDP-672] Remove FullBuildMetaData from our library versioning #49
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 are the changes
Instead of using
assembly-informational-format: '{InformationalVersion}', we decided to useNuGetVersion. The original value combines the MajorMinorPatch along with the full build metadata which yields a result similar to this:3.22.11-beta.99+88.Branch.release/3.022.011.Sha.28c853159a46b5a87e6cc9c4f6e940c59d6bc68a. That value is being used as the library version displayed in our telemetry library field. Instead, using NuGetVersion yields a result of MajorMinorPatch appended with a prerelease tag if relevant such as:3.22.11-preview0099How was it validated?
We updated the GitVersion.yml of our MediaTR project to use NuGetVersion instead and installed it to send telemetry to a private honeycomb sink. On the honeycomb, we verified that the library version was indeed the appropriate field.
Additionally, our auditing repo already uses NuGetVersion as seen here.
References:
https://gitversion.net/docs/reference/variables