[Bug]Failed to try and guess branch to use. Move one of the branches along a commit to remove warning

[hyabean]

Describe the bug
when build a tag commit on a jenkins agent, it failed and report
"[2021-11-29 16:47:39] WARN [11/29/21 16:47:39:51] An error occurred:
[2021-11-29 16:47:39] Failed to try and guess branch to use. Move one of the branches along a commit to remove warning"

Expected Behavior

build success

Actual Behavior

build failed

Possible Fix

if current commit tagged, not throw a excpetion.

GitVersion/src/GitVersion.Core/Core/GitPreparer.cs

Line 250 in b6d803b

throw new WarningException("Failed to try and guess branch to use. " + moveBranchMsg);

Steps to Reproduce

1. add a Environment Variable in Windows "JENKINS_URL" in Windows, act as a jenkins agent
2. open a powershell and execute:

mkdir gitversionErrorTest
cd gitversionErrorTest
git init
git.exe config remote.origin.url https://github.com/hyabean/GitVersionBuildFail.git # timeout=10
git.exe fetch --tags --force --progress -- https://github.com/hyabean/GitVersionBuildFail.git +refs/heads/*:refs/remotes/origin/* +refs/merge/*:refs/remotes/origin/merge/*
git.exe rev-parse "b309af2d6845182e643eb60ee06ebe9aecf8425e^{commit}" # timeout=10
git.exe config core.sparsecheckout # timeout=10
git.exe checkout -f b309af2d6845182e643eb60ee06ebe9aecf8425e
dotnet-gitversion ".\src\TcWinApp" -output file -outputfile src\TcWinApp\obj\gitversion.json

Context

CI failed after tag

Your Environment

• Version Used:
• GitVersion Version 5.7.0

[asbjornu]

GitVersion's requirements state:

The repository should be switched to a named, existing branch pointing to the commit being built (i.e. no detached HEAD).

[hyabean]

GitVersion's requirements state:

The repository should be switched to a named, existing branch pointing to the commit being built (i.e. no detached HEAD).

I know the requirements. But it isn't always fail when in detached HEAD. In some detached condition, GitVersion will help switch to the right branch. It switches to main branch (if the main branch's HEAD equals the commit) or proper branch (if found only one branch which name without separator).
The problem occurs when
when 1. Build on Jenkins agent
and 2. Detached HEAD
and 3. Have more than one branch with the HEAD equals the building commit
and 4. Have no branch without separator('/', '-')

If I don't build on a Jenkins agent, git version will run success. So I think It is an accidental bug. It often interrupts our CI workflow.

In my situation, The commit is tagged, I think the semanticVersion is definite.
Switching to any proper branch or staying detached HEAD is acceptable.

[asbjornu]

I don't use Jenkins myself and have no use for building detached HEADs, but if you figure out a way to solve this (with tests), I'd be happy to merge a PR.

[hyabean]

I don't use Jenkins myself and have no use for building detached HEADs, but if you figure out a way to solve this (with tests), I'd be happy to merge a PR.

@asbjornu Please review #2933.

[github-actions]

🎉 This issue has been resolved in version 5.8.2 🎉
The release is available on:

• GitHub Release
• Chocolatey Package
• .Net Global Tool

Your GitReleaseManager bot 📦🚀