Refactor next version calculator (get rid of `taggedSemanticVersion`) #3244

AlexPykavy · 2022-10-24T20:38:01Z

Suggest to review by commits :) I tried to make them as atomic as possible.

Description

Minor changes:

Rearranging code
Renaming variables
Reusing existing functionality

Change next version calculator to act according to the next algorithm:

Calculate next version candidate based on the base one
Look for the latest PreReleaseTag matching Major, Minor and Patch of the next version candidate.
Append the PreReleaseTag, if found, to the next version candidate.
Compare the next version candidate with Context.CurrentCommitTaggedVersion including the PreReleaseTag comparison.
Increment the PreReleaseTag of the next version candidate if versions mismatch.
Return the next version candidate.

Related Issue

Motivation and Context

I found NextVersionCalculator logic complicated and decided to simplify it.

How Has This Been Tested?

By running all existing tests.

Screenshots (if appropriate):

Checklist:

My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have added tests to cover my changes.
All new and existing tests passed.

HHobeck · 2022-10-28T07:01:40Z

I like your refactoring Alex. 👍 Good work. When I execute the unit tests I got some NullReferenceExceptions.

AlexPykavy · 2022-11-01T18:15:55Z

I like your refactoring Alex. 👍 Good work. When I execute the unit tests I got some NullReferenceExceptions.

I fixed failing unit tests and they pass locally but I still have issues with some CI jobs:

FindsVersionInDynamicRepo("GV_main","https://github.com/GitTools/GitVersion","main","efddf2f92c539a9c27f1904d952dcab8fb955f0e","5.8.2+56") test fails on MacOS and it looks like some connectivity issue SecureTransport error: connection closed via error.
Also there are many failing jobs which test the artifact using .NET 7 SDK on Arm64. The majority of them are caused by MSB4018 error. I suspect that it can be the issue of the .NET itself because 7.0.100-rc.2.22477.23 version used for tests which may contain issues. Also, found an issue .Net 7 preview 7 is broken on linux arm64 via QEMU dotnet/sdk#27190 that may be related.

AlexPykavy · 2022-11-29T18:29:23Z

@HHobeck , all failing tests are due to the .NET 7 instability on ARM. Can this PR be merged or it needs some corrections?

arturcic · 2022-11-29T18:45:47Z

@AlexPykavy - can you please fix the warnings as well? https://github.com/GitTools/GitVersion/actions/runs/3577000238

AlexPykavy · 2022-11-29T19:38:11Z

@AlexPykavy - can you please fix the warnings as well? https://github.com/GitTools/GitVersion/actions/runs/3577000238

Fixed, but I'm not sure about adding Context.CurrentCommitTaggedVersion != null before calling semver.CompareTo(Context.CurrentCommitTaggedVersion) because the method handles null arguments. Maybe it would be better to use null-forgiving operator to suppress the warning?

HHobeck · 2022-11-30T16:36:58Z

@AlexPykavy - can you please fix the warnings as well? https://github.com/GitTools/GitVersion/actions/runs/3577000238

Fixed, but I'm not sure about adding Context.CurrentCommitTaggedVersion != null before calling semver.CompareTo(Context.CurrentCommitTaggedVersion) because the method handles null arguments. Maybe it would be better to use null-forgiving operator to suppress the warning?

This might be also possible:

if (Context.CurrentCommitTaggedVersion?.CompareTo(semver) == 0)
{
...
}

src/GitVersion.Core/VersionCalculation/NextVersionCalculator.cs

HHobeck · 2023-01-06T16:57:09Z

@arturcic: May I ask you is it possible to go away from .net standard? It makes no sense in my opinion if we move to .net 6 and 7 or I'm wrong? It would be nice to use the Init Only Setters feature.

arturcic · 2023-01-06T17:06:15Z

Honestly I was considering that. We need to check the libgit2sharp if can pe used in this case

HHobeck · 2023-01-06T17:28:33Z

Honestly I was considering that. We need to check the libgit2sharp if can pe used in this case

~~But libgit2sharp is only referenced in GitVersion.App.csproj (Target Framework net6.0;net7.0) and not in GitVersion.Core.csproj (Target Framework .NET Standard 2.0)~~

Forget my post. I haven't seen the indirect dependency via GitVersion.LibGit2Sharp project

HHobeck · 2023-01-07T09:24:40Z

@AlexPykavy Could you please take a look on all references of the property PreReleaseTag and BuildMetaData and remove the following null checks?

e.g. PreReleaseTag?.HasTag(), PreReleaseTag?.Number, PreReleaseTag == null and PreReleaseTag.ShouldNotBeNull()
e.g. BuildMetaData?.Sha, BuildMetaData == null and PreReleaseTag.ShouldNotBeNull()

HHobeck · 2023-01-07T09:29:50Z

From my point of view the next refactoring steps are the following:

removing the .net standard target framework and change it to .net 6.0 and .net 7.0
fix all warnings because of the nullable feature (which is enabled by default)
change the SemanticVersionPreReleaseTag and SemanticVersionBuildMetaData to a struct data type and make it immutable
change the properties in SemanticVersionPreReleaseTag and SemanticVersionBuildMetaData to read only using Init Only Setters feature of c#
remove all mock setups which returning empty SemanticVersionPreReleaseTag and SemanticVersionBuildMetaData

What do you think? (Maybe in a separate PR)

arturcic · 2023-01-09T11:57:43Z

@HHobeck I can take this one in a separate PR:

removing the .net standard target framework and change it to .net 6.0 and .net 7.0

As for the others, you can work on them if you have a bit of time

AlexPykavy · 2023-01-10T19:52:44Z

@AlexPykavy Could you please take a look on all references of the property PreReleaseTag and BuildMetaData and remove the following null checks?

e.g. PreReleaseTag?.HasTag(), PreReleaseTag?.Number, PreReleaseTag == null and PreReleaseTag.ShouldNotBeNull()

e.g. BuildMetaData?.Sha, BuildMetaData == null and PreReleaseTag.ShouldNotBeNull()

Done if I understood you correctly :)

HHobeck · 2023-01-11T07:54:22Z

Done if I understood you correctly :)

It looks quite good. :) Could you take a look to the following lines?

and

AlexPykavy · 2023-01-11T19:41:45Z

@HHobeck, updated. You got me there: I forgot about checking != null.

HHobeck · 2023-01-12T08:18:40Z

Okay thank your very much @AlexPykavy for your work!! :) From my point of view the PR can be merged to main. @arturcic @asbjornu

HHobeck · 2023-02-19T10:33:23Z

I'm not sure why the second tests fails. Maybe you can help me? @arturcic, @AlexPykavy

Is it because of the refactoring in the PR? This two tests are new and comming from the main branch:

Message:
Shouldly.ShouldAssertException : variables.FullSemVer
should be
"1.4.0"
but was
"1.4.0-rc"

…g test Because release branch has 'beta' prefix configured.

To improve readability.

To make the method logic more understandable.

…and Patch

Because `this.mainlineVersionCalculator.FindMainlineModeVersion(nextVersion.BaseVersion)` method calculates BuildMetaData on its own.

Change next version calculator to act according to the next algorithm: 1. Calculate next version candidate based on the base one 2. Look for the latest `PreReleaseTag` matching Major, Minor and Patch of the next version candidate. 3. Append the `PreReleaseTag`, if found, to the next version candidate. 4. Compare the next version candidate with `Context.CurrentCommitTaggedVersion` including the `PreReleaseTag` comparison. 5. Increment the `PreReleaseTag` of the next version candidate if versions mismatch. 6. Return the next version candidate.

…lable type Because they are always set in SemanticVersion's constructor. They can be null only if explicitly set by the client of the class and there are plans to forbid this functionality.

AlexPykavy · 2023-02-19T13:00:34Z

Fixed by considering empty preRelaseTag as a edge case and moving out the corresponding if block. I've also rebased my previous PR on top of current main instead of merging because I like prefer rebase in such cases :)

mergify · 2023-02-19T13:51:44Z

Thank you @AlexPykavy for your contribution!

arturcic · 2023-03-02T21:47:29Z

🎉 This issue has been resolved in version 6.0.0-beta.1 🎉
The release is available on:

Your GitReleaseManager bot 📦🚀

AlexPykavy force-pushed the refactor-next-version-calculator branch from c95b521 to 059375f Compare October 29, 2022 21:11

AlexPykavy force-pushed the refactor-next-version-calculator branch from 0977561 to c718ee0 Compare November 24, 2022 17:49

arturcic force-pushed the refactor-next-version-calculator branch from c718ee0 to e7e7be5 Compare November 29, 2022 18:34

AlexPykavy force-pushed the refactor-next-version-calculator branch from e7e7be5 to 20a8fe7 Compare November 29, 2022 19:27

HHobeck requested changes Nov 30, 2022

View reviewed changes

AlexPykavy force-pushed the refactor-next-version-calculator branch from 20a8fe7 to 0e6554e Compare December 11, 2022 15:06

AlexPykavy force-pushed the refactor-next-version-calculator branch from 4a3d092 to e9edd32 Compare January 6, 2023 15:31

arturcic mentioned this pull request Jan 9, 2023

[Improvement] Target .net6.0 and .net7.0 instead of netstandard2.0 #3334

Closed

AlexPykavy force-pushed the refactor-next-version-calculator branch from e9edd32 to 85603d4 Compare January 10, 2023 19:52

AlexPykavy force-pushed the refactor-next-version-calculator branch from 85603d4 to 9b19750 Compare January 11, 2023 15:41

HHobeck added this to the 6.x milestone Feb 8, 2023

HHobeck added the improvement label Feb 8, 2023

Fix CanTakePreReleaseVersionFromReleasesBranchWithNumericPreReleaseTa…

c31abe3

…g test Because release branch has 'beta' prefix configured.

AlexPykavy added 10 commits February 19, 2023 13:22

Rearrange actions in the UpdatePreReleaseTag method

e151052

To improve readability.

Rename UpdatePreReleaseTag variables

67e6722

To make the method logic more understandable.

Reuse existing logic in the MajorMinorPatchEqual method

26d9ac3

Search for the first prefixed semver only if it matches Major, Minor …

3442d5a

…and Patch

Calculate semver BuildMetaData if versioning mode is not mainline

4828d78

Because `this.mainlineVersionCalculator.FindMainlineModeVersion(nextVersion.BaseVersion)` method calculates BuildMetaData on its own.

Don't use taggedSemanticVersion to decide which version to take

15efee0

Introduce a baseVersion variable to shorten the property call

471d1e0

Remove baseVersionBuildMetaData == null check

e1bd3a9

Change SemanticVersion's PreReleaseTag and BuildMetaData to a non-nul…

5767382

…lable type Because they are always set in SemanticVersion's constructor. They can be null only if explicitly set by the client of the class and there are plans to forbid this functionality.

AlexPykavy force-pushed the refactor-next-version-calculator branch from 22fa5fc to 5767382 Compare February 19, 2023 12:56

arturcic approved these changes Feb 19, 2023

View reviewed changes

arturcic merged commit ce53e2a into GitTools:main Feb 19, 2023

arturcic modified the milestones: 6.x, 6.0.0-beta.1 Mar 2, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor next version calculator (get rid of `taggedSemanticVersion`) #3244

Refactor next version calculator (get rid of `taggedSemanticVersion`) #3244

AlexPykavy commented Oct 24, 2022 •

edited

HHobeck commented Oct 28, 2022

AlexPykavy commented Nov 1, 2022

AlexPykavy commented Nov 29, 2022

arturcic commented Nov 29, 2022

AlexPykavy commented Nov 29, 2022

HHobeck commented Nov 30, 2022

HHobeck commented Jan 6, 2023 •

edited

arturcic commented Jan 6, 2023

HHobeck commented Jan 6, 2023 •

edited

HHobeck commented Jan 7, 2023

HHobeck commented Jan 7, 2023 •

edited

arturcic commented Jan 9, 2023

AlexPykavy commented Jan 10, 2023

HHobeck commented Jan 11, 2023

AlexPykavy commented Jan 11, 2023

HHobeck commented Jan 12, 2023 •

edited

HHobeck commented Feb 19, 2023 •

edited

AlexPykavy commented Feb 19, 2023

mergify bot commented Feb 19, 2023

arturcic commented Mar 2, 2023

Refactor next version calculator (get rid of taggedSemanticVersion) #3244

Refactor next version calculator (get rid of taggedSemanticVersion) #3244

Conversation

AlexPykavy commented Oct 24, 2022 • edited

Description

Related Issue

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Checklist:

HHobeck commented Oct 28, 2022

AlexPykavy commented Nov 1, 2022

AlexPykavy commented Nov 29, 2022

arturcic commented Nov 29, 2022

AlexPykavy commented Nov 29, 2022

HHobeck commented Nov 30, 2022

HHobeck commented Jan 6, 2023 • edited

arturcic commented Jan 6, 2023

HHobeck commented Jan 6, 2023 • edited

HHobeck commented Jan 7, 2023

HHobeck commented Jan 7, 2023 • edited

arturcic commented Jan 9, 2023

AlexPykavy commented Jan 10, 2023

HHobeck commented Jan 11, 2023

AlexPykavy commented Jan 11, 2023

HHobeck commented Jan 12, 2023 • edited

HHobeck commented Feb 19, 2023 • edited

AlexPykavy commented Feb 19, 2023

mergify bot commented Feb 19, 2023

arturcic commented Mar 2, 2023

Refactor next version calculator (get rid of `taggedSemanticVersion`) #3244

Refactor next version calculator (get rid of `taggedSemanticVersion`) #3244

AlexPykavy commented Oct 24, 2022 •

edited

HHobeck commented Jan 6, 2023 •

edited

HHobeck commented Jan 6, 2023 •

edited

HHobeck commented Jan 7, 2023 •

edited

HHobeck commented Jan 12, 2023 •

edited

HHobeck commented Feb 19, 2023 •

edited