Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mkoertgen/gitversion-test
https://github.com/mkoertgen/gitversion-test
Last synced: 28 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/mkoertgen/gitversion-test
- Owner: mkoertgen
- Created: 2023-09-13T15:38:56.000Z (over 1 year ago)
- Default Branch: develop
- Last Pushed: 2023-09-13T17:13:04.000Z (over 1 year ago)
- Last Synced: 2024-10-14T23:43:48.441Z (2 months ago)
- Size: 8.79 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# gitversion-test
This repository is used to test a special edge case in GitVersion where the calculated version on a tag is not correct.
Checking out a tag results in a detached HEAD. In that case GitVersion tries to get the branches containing the commit, cf.
- [GitVersionContextFactory.cs#L30](https://github.com/GitTools/GitVersion/blob/5014a94b9159f64899254da10979c1b2cd651cdf/src/GitVersion.Core/Core/GitVersionContextFactory.cs#L30)
It then finds the `develop`-branch containing the merged commit. Because the develop branch is tracked as a merge target by default the version is calculated based on the branch instead of the tag, cf.
```yaml
# $ gitversion /showconfig
# GitVersion.yml
...
branches:
develop:
track-merge-target: true # <---- this is the default causing the issue
release:
release:
track-merge-target: false
...
```
## Solution
The solution is to merge the hotfix commit back also to the release branches.
This way the `develop` branch is not the only branch containing the commit and the version is calculated correctly.
## History
- 0.1.0: Initial commit
- 0.2.0: Tag
- release/0.3.0: Stabilization Branch
- develop: Development Branch (from release/0.3.0)
- 0.2.1: Hotfix on main
- develop: Merged main/hotfix
- develop: Documentation
## Reproduce
```shell
# Checkout the tag
$ git checkout 0.2.1
Note: switching to '0.2.1'.
You are in 'detached HEAD' state. You can look around, make experimental
...
HEAD is now at 371f96c docs: hotfix on main
# Verify that version is calculated incorrectly on tag
$ gitversion
{
"Major": 0,
"Minor": 3,
"Patch": 0,
...
"SemVer": "0.3.0--no-branch-.1", // <---- this is wrong!
...
"FullSemVer": "0.3.0--no-branch-.1+1",
"InformationalVersion": "0.3.0--no-branch-.1+1.Branch.-no-branch-.Sha.371f96c24405d9ace9917d70ea68a1341033aca9",
...
}
$ gitversion /diag > gitversion.log
# Checkout the main branch again
$ git switch main
# Verify that main == 0.2.1
$ git log
commit 371f96c24405d9ace9917d70ea68a1341033aca9 (HEAD -> main, tag: 0.2.1, origin/main)
Author: Marcel Körtgen
Date: Wed Sep 13 17:55:59 2023 +0200
docs: hotfix on main
# Verify that version is calculated correctly on main/master branch
$ gitversion
{
"Major": 0,
"Minor": 2,
"Patch": 1,
"FullBuildMetaData": "Branch.main.Sha.371f96c24405d9ace9917d70ea68a1341033aca9",
"SemVer": "0.2.1", // <---- this is correct!
```
## Related Issues
- [[Bug] 5.12 bumps major based on the previous merges instead of the last tag and branch convention #3644](https://github.com/GitTools/GitVersion/issues/3644)
- [[Bug] 5.12.0 does not respect tag in Continuous Deployment mode #3614](https://github.com/GitTools/GitVersion/issues/3614)
- [[Bug] Build number in Azure DevOps wrong #3351](https://github.com/GitTools/GitVersion/issues/3351) (Closed)
- [[Bug] GitVersion mainline always returns latest version based on master branch history, even if building for an older commit #3206](https://github.com/GitTools/GitVersion/issues/3206)
- [[Bug] GitVersion increments version on tagged detached HEAD when coming from release branch #2478](https://github.com/GitTools/GitVersion/issues/2478) (Closed)