Why did GitVersion choose 1.0.0-alpha.4 in this case

[bitbonk]

I am using the default GitVersion setup with GitVersion.yml only containing next-version: 1.0.
Below is the GitVersion diagnositcs log of one of the latest CI build of the develop branch.

For some reason GitVersion chose 1.0.0-alpha.4 as the next version where as previous builds of the develop branch already produced greater alpha version up to 1.1.0-alpha.19.
But (presumably) after I merged release\1.0.0 ( because I made changes in CHANGELOG.md there) back to develop the version dropped down to alpha.4.

So I have three questions:

1. Why exactly did it choose 1.0.0-alpha.4 (instead of 1.1.0-alpha.20) as the next version?
2. What did I do wrong? Does the default GitVersion flow "prohibit" merging from release\* back to develop?
3. What is the best way fix this and make it continue with 1.1.0-alpha.20 on the develop branch?

Dumping commit graph: 
*   8c12bbb 50 minutes ago  (tag: 1.0.0-beta6, origin/release/1.0.0, tags/1.0.0-beta6, release/1.0.0, 8c12bbba846ffb13e040b0195e6754acef5849d3)
\  
 | * c78eda2 51 minutes ago  (pull/51/merge, pull/51/merge, c78eda2af2bd934291405fd327909e48a8cc418e)
 |/| 
/|/  
 * f12aea9 52 minutes ago  (preparerelease/changelog)
/  
   3848b97 57 minutes ago  (3848b9707ac8017d0e2e1c34de3a502bc23ac79f)
\  
 | * 60ec880 58 minutes ago  (pull/50/merge, pull/50/merge, 60ec880d82309c7ec9a18c2574fcf7a68a15eadf)
 |/| 
/|/  
 *   dc5629f 79 minutes ago  (HEAD -> develop, origin/develop, origin/dc5629f39c4724872d6fc3800d95019ee331051a, dc5629f39c4724872d6fc3800d95019ee331051a)
 |\  
 | | * 4c91fc3 81 minutes ago  (pull/49/merge, pull/49/merge, 4c91fc3a5e30685f359925ec6bf2460d95d9f300)
 | |/| 
 |/|/  
 | * 6c4c927 82 minutes ago  (feature/update-to-tc-5.6.0)
 |/  
 *   cf15df8 88 minutes ago  (cf15df8a4abe6fcdc60ce77d06041619cdbafec0)
 |\  
 | | * acaee6c 2 hours ago  (pull/48/merge, pull/48/merge, acaee6cba06083b8b66e0e28b90a7deb71a39276)
 | |/| 
 |/|/  
 | * 7b7d501 2 hours ago  (feature/udpatechangelog)
 |/  
/|   
 | * 6bc0292 2 hours ago  (6bc02928a632c5ad3443174a4038ab7160eb5633)
 |/| 
 |/  
/|   
 |   a127ddc 8 days ago  (tag: 1.0.0-beta5)
\ \  
 * | 1cfacce 8 days ago 
/ /  
 | c575978 8 days ago 
\| 
 |   e96adbb 5 weeks ago  (tag: 1.0.0-beta4)
\ \  
 \ \   0e2d4a0 5 weeks ago  (tag: 1.0.0-beta3)
\ \ \  
 \ \ \   c42f7c3 3 months ago  (tag: 1.0.0-beta1)
\ \ \ \  
 \ \ \ \   493392b 3 months ago 
\ \ \ \ \  
 \ \ \ \ \   1cb12cb 3 months ago 
\ \ \ \ \ \  
 | | | | | | *   23b8147 3 hours ago  (origin/feature/code_generation, feature/code_generation)
 | | | | | | |\  
 | | | | | | | * da86c90 24 hours ago 
 | | | | | | | * 302e012 25 hours ago 
 | | | | | | * | 23436f0 3 hours ago 
 | | | | | | * | 164495c 3 hours ago 
 | | | | | | |/  
 | | | | | | * c9e06f6 28 hours ago 
 | | | | | | * 64f5f74 4 days ago 
 | | | | | | * 9ecc79f 6 days ago 
 | | | | | | * 18e4752 6 days ago 
 | | | | | | * 56e7473 6 days ago 
 | | | | | | * 45cd0a0 6 days ago 
 | | | | | | * e630169 7 days ago 
 | | | | | | * fa3557b 7 days ago 
 | | | | | | * 213e039 7 days ago 
 | | | | | | * fafafbc 7 days ago 
 | | | | | | * 85e09f6 7 days ago 
 | | | | | | * 040c67b 7 days ago 
 | | | | | | * 888b852 7 days ago 
 | | | | | | * 52966f3 7 days ago 
 | | | | | | * c0f3e5d 7 days ago 
 | | | | | | * 2944a7e 7 days ago 
 | | | | | | * b32ad61 7 days ago 
 | | | | | | * 43b1fe7 7 days ago 
 | | | | | | * 5bc9de3 7 days ago 
 | | | | | | * 9e602a6 7 days ago 
 | | | | | | * a4f9107 7 days ago 
 | | | | | | * 6c63697 7 days ago 
 | | | | | | * d44935e 7 days ago 
 | | | | | | * 0cdc012 7 days ago 
 | | | | | | * a83829f 7 days ago 
 | | | | | | * bf223dc 7 days ago 
 | | | | | | * 21fedcc 7 days ago 
 | | | | | | * fbc2371 7 days ago 
 | | | | | | * 1ad66ab 7 days ago 
 | | | | | | * d0bf200 7 days ago 
 | | | | | | * f5c6b4d 7 days ago 
 | | | | | | * 36b7f37 7 days ago 
 | | | | | | * ae466b8 7 days ago 
 | | | | | | * b8712a5 7 days ago 
 | | | | | | * 99829f2 7 days ago 
 | | | | | | * 9ce974d 7 days ago 
 | | | | | | * 459dc9d 7 days ago 
 | | | | | | * 64432a9 7 days ago 
 | | | | | | * 69217d0 7 days ago 
 | | | | | | * 4565b0c 7 days ago 
 | | | | | | * 6e50b39 7 days ago 
 | | | | | | * 8bed58d 7 days ago 
 | | | | | | * ed66670 7 days ago 
 | | | | | | * 0b55f36 7 days ago 
 | | | | | | * dcd6058 7 days ago 
 | | | | | | * 2e103b2 7 days ago 
 | | | | | | * 3a3f1e5 7 days ago 
 | | | | | |/  
 | | | | | * 5e5a78a 8 days ago 
 | | | | |/| 
 | | | | | * 7562acc 8 days ago 
 | | | | |/  
 | | | | * eaaa003 5 weeks ago 
 | | | |/| 
 | | | | * e5905d7 5 weeks ago 
 | | | | * 398989d 5 weeks ago 
 | | | | * 0b11cf5 5 weeks ago 
 | | | |/  
 | | | *   a35a3ba 5 weeks ago 
 | | | |\  
 | | | | * 3239c58 7 weeks ago 
 | | | | * 5756a7b 7 weeks ago 
 | | | | * ca54dbf 7 weeks ago 
 | | | | * 4856af7 8 weeks ago 
 | | | * |   e5da9d4 7 weeks ago 
 | | | |\ \  
 | | | | |/  
 | | | |/|   
 | | | | * a78b48b 7 weeks ago 
 | | | | * 128e848 7 weeks ago 
 | | | | * 4e80920 7 weeks ago 
 | | | | * 9629d91 7 weeks ago 
 | | | |/  
 | | | | * cb205a8 7 weeks ago  (origin/feature/build-components, feature/build-components)
 | | | | * b008f21 8 weeks ago 
 | | | |/  
 | | | *   6f31bc2 8 weeks ago 
 | | | |\  
 | | | | * 78b7915 8 weeks ago 
 | | | | * a6f7ee8 8 weeks ago 
 | | | | * 846b0bf 8 weeks ago 
 | | | | * 807eb49 8 weeks ago 
 | | | | * a15e184 8 weeks ago 
 | | | |/  
 | | | * 5efb042 8 weeks ago 
 | | |/| 
 | | | * b4e086f 8 weeks ago 
 | | | * 13d46a9 8 weeks ago 
 | | |/  
 | | | * 1239f90 2 months ago  (origin/feature/prototype, feature/prototype)

NFO [08/16/22 13:46:58:22] Working directory: C:\build\_work\718\s
NFO [08/16/22 13:46:58:24] Branch from build environment: refs/heads/develop
NFO [08/16/22 13:46:58:24] Project root is: C:\build\_work\718\s\
NFO [08/16/22 13:46:58:24] DotGit directory is: C:\build\_work\718\s\.git
NFO [08/16/22 13:46:58:24] Begin: Normalizing git directory for branch 'refs/heads/develop'
 INFO [08/16/22 13:46:58:27] One remote found (origin -> 'https://tfs.ad.kontron-ais.com/tfs/AIS/TC-Store/_git/AIS.TC.Contracts').
 INFO [08/16/22 13:46:58:27] Skipping fetching, if GitVersion does not calculate your version as expected you might need to allow fetching or use dynamic repositories
 INFO [08/16/22 13:46:58:29] Updating local branch develop to point at dc5629f Merged PR 49: Update to TC 5.6.0
 INFO [08/16/22 13:46:58:33] Skipping update of 'refs/remotes/origin/dc5629f39c4724872d6fc3800d95019ee331051a' as it already matches the remote ref.
 INFO [08/16/22 13:46:58:33] Skipping update of 'refs/remotes/origin/feature/build-components' as it already matches the remote ref.
 INFO [08/16/22 13:46:58:33] Skipping update of 'refs/remotes/origin/feature/code_generation' as it already matches the remote ref.
 INFO [08/16/22 13:46:58:33] Skipping update of 'refs/remotes/origin/feature/prototype' as it already matches the remote ref.
 INFO [08/16/22 13:46:58:33] Skipping update of 'refs/remotes/origin/main' as it already matches the remote ref.
 INFO [08/16/22 13:46:58:33] Skipping update of 'refs/remotes/origin/release/1.0.0' as it already matches the remote ref.
 INFO [08/16/22 13:46:58:35] HEAD points at branch 'refs/heads/develop'.
 INFO [08/16/22 13:46:58:35] End: Normalizing git directory for branch 'refs/heads/develop' (Took: 106.16ms)
 INFO [08/16/22 13:46:58:37] Using latest commit on specified branch
 INFO [08/16/22 13:46:58:47] Running against branch: develop (dc5629f Merged PR 49: Update to TC 5.6.0)
 INFO [08/16/22 13:46:58:48] Begin: Calculating base versions
   INFO [08/16/22 13:46:58:49] NextVersion in GitVersion configuration file: 1.0.0 with commit count source External Source
   INFO [08/16/22 13:46:58:50] Fallback base version: 0.1.0 with commit count source 9a7bcc0ae2ae280d7c5062c6734f622b1c892935
   INFO [08/16/22 13:46:58:55] Git tag '1.0.0-beta5': 1.0.0-beta.5 with commit count source a127ddc9a9c2edd333c59bc314eb9e7314986e10
   INFO [08/16/22 13:46:58:55] Git tag '1.0.0-beta4': 1.0.0-beta.4 with commit count source e96adbb5baf993e8589075825908e5e9a101a483
   INFO [08/16/22 13:46:58:55] Git tag '1.0.0-beta3': 1.0.0-beta.3 with commit count source 0e2d4a0eb52fea9b0962b13276c7cb1451ba8195
   INFO [08/16/22 13:46:58:55] Git tag '1.0.0-beta1': 1.0.0-beta.1 with commit count source c42f7c37baa2a22f929bb59f668fa9fd4e731d0d
   INFO [08/16/22 13:46:58:56] Begin: Finding merge base between 'release/1.0.0' and 'develop'.
     INFO [08/16/22 13:46:58:57] Found merge base of dc5629f Merged PR 49: Update to TC 5.6.0
     INFO [08/16/22 13:46:58:57] Merge base of release/1.0.0' and 'develop is dc5629f Merged PR 49: Update to TC 5.6.0
   INFO [08/16/22 13:46:58:57] End: Finding merge base between 'release/1.0.0' and 'develop'. (Took: 8.50ms)
   INFO [08/16/22 13:46:58:61] Base version used: NextVersion in GitVersion configuration file: 1.0.0 with commit count source a127ddc9a9c2edd333c59bc314eb9e7314986e10
 INFO [08/16/22 13:46:58:61] End: Calculating base versions (Took: 134.72ms)
 INFO [08/16/22 13:46:58:61] 4 commits found between a127ddc Merged PR 42: Update CHANGELOG.md for 1.0.0-Beta0005 release and dc5629f Merged PR 49: Update to TC 5.6.0
 INFO [08/16/22 13:46:58:61] Skipping version increment
 INFO [08/16/22 13:46:58:61] 4 commits found between a127ddc Merged PR 42: Update CHANGELOG.md for 1.0.0-Beta0005 release and dc5629f Merged PR 49: Update to TC 5.6.0
 INFO [08/16/22 13:46:58:62] Begin: Getting version tags from branch 'refs/heads/develop'.
 INFO [08/16/22 13:46:58:63] End: Getting version tags from branch 'refs/heads/develop'. (Took: 13.53ms)
xecuting GenerateSetVersionMessage for 'AzurePipelines'.
xecuting GenerateBuildLogOutput for 'AzurePipelines'.

 "Major": 1,
 "Minor": 0,
 "Patch": 0,
 "PreReleaseTag": "alpha.4",
 "PreReleaseTagWithDash": "-alpha.4",
 "PreReleaseLabel": "alpha",
 "PreReleaseLabelWithDash": "-alpha",
 "PreReleaseNumber": 4,
 "WeightedPreReleaseNumber": 4,
 "BuildMetaData": null,
 "BuildMetaDataPadded": "",
 "FullBuildMetaData": "Branch.develop.Sha.dc5629f39c4724872d6fc3800d95019ee331051a",
 "MajorMinorPatch": "1.0.0",
 "SemVer": "1.0.0-alpha.4",
 "LegacySemVer": "1.0.0-alpha4",
 "LegacySemVerPadded": "1.0.0-alpha0004",
 "AssemblySemVer": "1.0.0.0",
 "AssemblySemFileVer": "1.0.0.0",
 "FullSemVer": "1.0.0-alpha.4",
 "InformationalVersion": "1.0.0-alpha.4+Branch.develop.Sha.dc5629f39c4724872d6fc3800d95019ee331051a",
 "BranchName": "develop",
 "EscapedBranchName": "develop",
 "Sha": "dc5629f39c4724872d6fc3800d95019ee331051a",
 "ShortSha": "dc5629f",
 "NuGetVersionV2": "1.0.0-alpha0004",
 "NuGetVersion": "1.0.0-alpha0004",
 "NuGetPreReleaseTagV2": "alpha0004",
 "NuGetPreReleaseTag": "alpha0004",
 "VersionSourceSha": "a127ddc9a9c2edd333c59bc314eb9e7314986e10",
 "CommitsSinceVersionSource": 4,
 "CommitsSinceVersionSourcePadded": "0004",
 "UncommittedChanges": 0,
 "CommitDate": "2022-08-16"

 INFO [08/16/22 13:46:58:67] Done writing 

[asbjornu]

Whenever someone is experiencing versioning issues, I always recommend removing next-version or even deleting GitVersion.yml entirely.

[bitbonk]

@asbjornu Even without a Gitversion.yml it chose 1.0.0-alpha.4. I think the reason is somehwere here:

INFO [08/16/22 13:46:58:61] 4 commits found between a127ddc Merged PR 42: Update CHANGELOG.md for 1.0.0-Beta0005 release and dc5629f Merged PR 49: Update to TC 5.6.0
INFO [08/16/22 13:46:58:61] Skipping version increment
INFO [08/16/22 13:46:58:61] 4 commits found between a127ddc Merged PR 42: Update CHANGELOG.md for 1.0.0-Beta0005 release and dc5629f Merged PR 49: Update to TC 5.6.0

So I have created several tagged preview releases on release/1.0.0 and because I wanted the changes made in for those prereleases back in develop I merged release/1.0.0 back into develop. And now develop is 4 commits ahead of the last tag (1.0.0-beta.5). Somewhat similar to this simplified graph:

%%{init: { 'logLevel': 'debug', 'theme': 'base', 'gitGraph': {'showCommitLabel':false}} }%%
    gitGraph
       commit
       branch develop
       commit
       commit
       branch release/1.0.0
       checkout  release/1.0.0
       commit tag: "1.0.0-beta.1"
       commit
       commit tag: "1.0.0-beta.2"
       commit
       commit tag: "1.0.0-beta.3"
       commit
       commit tag: "1.0.0-beta.4"
       commit
       commit tag: "1.0.0-beta.5"
       checkout develop
       merge  release/1.0.0
       commit
       commit
       commit
       checkout release/1.0.0
       commit

Loading

Could this be the reason why it chose 1.0.0-alpha.4? If so, it would mean that I should never ever merge release/* back to develop if release/* has got prerelease version tags. This begs the question how a good workflow in a GitVersion flow should look like for prereleases.

[bitbonk]

I think I have finally understood why this happens.
Whenever there are commits on develop that are not yet on release\1.0.0 , GitVersion chooses 1.1.0-aphaX as the version number
on develop.
But as soon as release/1.0.0 is merged into develop (or the other way around), it goes back to 1.0.0-aphaY on develop.
Even though I understand why GitVersion does this, it raises the question how the default workflow is ever going to work: #3177

[bitbonk]

So the idea here is, never update develop with any commits from release/* until when the final release actually happens and release is merged into main?

Is that fair to say?

[asbjornu]

I would say that represents a normal Git Flow, yes. At least, it's what GitVersion seems to expect. 🤷🏼

[bitbonk]

Thanks!
The problem now is, that it seems that merging stuff from develop into release/* is also not intended.

[asbjornu]

Merging from develop to release/* shouldn't be a problem. Can you please create a RepositoryFixture test with version assertions so I can better understand what you are trying and which version numbers you expect along the way?

[bitbonk]

@asbjornu I have created #3191 with a test that demonstrates the problem. The test does exactly what I described in the discussion #3177. Maybe continue further discussion of the problem there? Sorry for the creation of multiple questions, I didn't know better back then.