[Windows][Appveyor] InvalidSpecificationException: the given reference name '[branch]' is not valid #2134

Activity

1. arturcic commented on Feb 25, 2020

   

   arturcic

   on Feb 25, 2020

   Member

   More actions

   I think the issue is that the branch contains refs in the name (all 3 attempts had that in the name)
2. shiftkey commented on Feb 25, 2020

   

   shiftkey

   on Feb 25, 2020

   Author

   More actions

   @arturcic ugh, you might be right. Any idea why libgit2sharp would complain about that?
3. arturcic commented on Feb 25, 2020

   

   arturcic

   on Feb 25, 2020

   Member

   More actions

   I think that's a question for Libgit2Sharp repo
4. shiftkey commented on Feb 25, 2020

   

   shiftkey

   on Feb 25, 2020

   Author

   More actions

   I think the issue is that the branch contains refs in the name (all 3 attempts had that in the name)

   Confirmed this is the issue (a new PR submitted without containing refs passes). Going to leave this open for a bit to remind myself to try and reproduce it in isolation and see if I can put something on the libgit2sharp tracker.

   👍React with 👍2Reacted by Artur and Asbjørn Ulsberg
5. asbjornu commented on Feb 25, 2020

   

   asbjornu

   on Feb 25, 2020

   Member

   More actions

   If changing the name of the branch helps, I'd say that's a bug in GitVersion. Best case, we should handle that gracefully, worst case we should yield an understandable error message indicating that the name of the branch could be the perpetrator.
6. shiftkey commented on Feb 25, 2020

   

   shiftkey

   on Feb 25, 2020

   Author

   More actions

   @asbjornu I'd like to figure out why it's only failing on Windows too (as someone who has contributed to libgit2sharp before, I'd like to know why this is failing because it seems a bit absurd).

   👍React with 👍1Reacted by Asbjørn Ulsberg
7. stale commented on May 25, 2020

   

   staleBot

   on May 25, 2020

   More actions

   This issue has been automatically marked as stale because it has not had recent activity. After 30 days from now, it will be closed if no further activity occurs. Thank you for your contributions.
8. stale

   added

   stale

   on May 25, 2020
9. asbjornu commented on May 25, 2020

   

   asbjornu

   on May 25, 2020

   Member

   More actions

   @shiftkey, have you had any time to look into this? No rush, just thought I'd ask now that @stalebot reminded me.
10. stale

    removed

    stale

    on May 25, 2020
11. shiftkey commented on May 25, 2020

    

    shiftkey

    on May 25, 2020

    Author

    More actions

    @asbjornu nah, haven't even opened Windows since then
12. rducom commented on Jun 1, 2020

    

    rducom

    on Jun 1, 2020

    More actions

    same behavior on Jenkins :

    * 64fa46db 3 weeks ago 
    
    INFO [06/01/20 15:42:24:11] Applicable build agent found: 'Jenkins'.INFO [06/01/20 15:42:24:12] Working directory: D:\workspace\NoTicket.FixF---19159f93INFO [06/01/20 15:42:24:12] IsDynamicGitRepository: FalseINFO [06/01/20 15:42:24:13] Returning Project Root from DotGitDirectory: D:\workspace\NoTicket.FixF---19159f93\.git\ - D:\workspace\NoTicket.FixF---19159f93\INFO [06/01/20 15:42:24:13] Running on Windows.INFO [06/01/20 15:42:24:13] Applicable build agent found: 'Jenkins'.INFO [06/01/20 15:42:24:13] Branch from build environment: NoTicket.FixFixUserPrefsForSiteMapINFO [06/01/20 15:42:24:14] Begin: Normalizing git directory for branch 'NoTicket.FixFixUserPrefsForSiteMap'  INFO [06/01/20 15:42:24:15] One remote found (origin -> 'git@github.com:LuccaSA/Cleemy.Expenses.git').  INFO [06/01/20 15:42:24:15] Skipping fetching, if GitVersion does not calculate your version as expected you might need to allow fetching or use dynamic repositories  INFO [06/01/20 15:42:24:15] Creating local branch NoTicket.FixFixUserPrefsForSiteMap pointing at a8beb1b0348320ed75e88d072aea87bec4bf7010  INFO [06/01/20 15:42:24:16] End: Normalizing git directory for branch 'NoTicket.FixFixUserPrefsForSiteMap' (Took: 20.92ms)  ERROR [06/01/20 15:42:24:17] An unexpected error occurred:
    LibGit2Sharp.InvalidSpecificationException: the given reference name 'NoTicket.FixFixUserPrefsForSiteMap' is not valid
       at LibGit2Sharp.Core.Ensure.HandleError(Int32 result)
       at LibGit2Sharp.Core.Ensure.ZeroResult(Int32 result)
       at LibGit2Sharp.Core.Proxy.git_reference_create(RepositoryHandle repo, String name, ObjectId targetId, Boolean allowOverwrite, String logMessage)
       at LibGit2Sharp.ReferenceCollection.Add(String name, ObjectId targetId, String logMessage, Boolean allowOverwrite)
       at LibGit2Sharp.ReferenceCollection.Add(String name, ObjectId targetId)
       at GitVersion.Helpers.GitRepositoryHelper.EnsureLocalBranchExistsForCurrentBranch(ILog log, Repository repo, Remote remote, String currentBranch) in D:\a\1\s\src\GitVersionCore\Helpers\GitRepositoryHelper.cs:line 171
       at GitVersion.Helpers.GitRepositoryHelper.NormalizeGitDirectory(ILog log, IEnvironment environment, String gitDirectory, AuthenticationInfo authentication, Boolean noFetch, String currentBranch, Boolean isDynamicRepository) in D:\a\1\s\src\GitVersionCore\Helpers\GitRepositoryHelper.cs:line 41
       at GitVersion.GitPreparer.NormalizeGitDirectory(AuthenticationInfo auth, String targetBranch, String gitDirectory, Boolean isDynamicRepository) in D:\a\1\s\src\GitVersionCore\GitPreparer.cs:line 190
       at GitVersion.GitPreparer.Prepare(Boolean normalizeGitDirectory, String currentBranch, Boolean shouldCleanUpRemotes) in D:\a\1\s\src\GitVersionCore\GitPreparer.cs:line 65
       at GitVersion.GitVersionCalculator.CalculateVersionVariables() in D:\a\1\s\src\GitVersionCore\GitVersionCalculator.cs:line 54
       at GitVersion.ExecCommand.Execute() in D:\a\1\s\src\GitVersionExe\ExecCommand.cs:line 40
       at GitVersion.GitVersionExecutor.VerifyArgumentsAndRun(Arguments arguments) in D:\a\1\s\src\GitVersionExe\GitVersionExecutor.cs:line 117  INFO [06/01/20 15:42:24:17]   INFO [06/01/20 15:42:24:17] Attempting to show the current git graph (please include in issue):   INFO [06/01/20 15:42:24:17] Showing max of 100 commits  INFO [06/01/20 15:42:24:21] * a8beb1b0 44 seconds ago  (HEAD -> NoTicket.FixFixUserPrefsForSiteMap, origin/NoTicket.FixFixUserPrefsForSiteMap)
    | * e01172b9 28 minutes ago  (origin/v2.5.28_FixUserPrefsForSiteMap)
    |/  
    * 246a8f59 2 hours ago  (tag: v2.5.28, origin/master)
    

    Changing branch name from NoTicket.FixFixUserPrefsForSiteMap to FixFixUserSettingsForSiteMap is a working waorkaround
13. asbjornu commented on Jun 2, 2020

    

    asbjornu

    on Jun 2, 2020

    Member

    More actions

    So the NoTicket. prefix is causing problems, @rducom? Perhaps the . in there? Bizarre, whategver it is. The best way to fix this would be to provide a failing test in the LibGit2Sharp repository, I think.
14. rducom commented on Jun 2, 2020

    

    rducom

    on Jun 2, 2020

    More actions

    No the "refs" sub string is causing problem
15. asbjornu commented on Jun 2, 2020

    

    asbjornu

    on Jun 2, 2020

    Member

    More actions

    Ok, then I misunderstood this:

    Changing branch name from NoTicket.FixFixUserPrefsForSiteMap to FixFixUserSettingsForSiteMap is a working waorkaround
16. 7 remaining items

    Load more

17. asbjornu commented on Jan 27, 2021

    

    asbjornu

    on Jan 27, 2021

    Member

    More actions

    Given the stack trace, I would say this is a bug in LibGit2Sharp or perhaps even in libgit2. I at least have no idea how we can fix this in GitVersion. Pull requests and ideas are of course welcome.
18. hotchkj commented on Jan 27, 2021

    

    hotchkj

    on Jan 27, 2021

    More actions

    @asbjornu Understood & I'd be quite comfortable with this blocked by a corresponding issue on LibGit2Sharp - I am just not sure if I have the background information necessary to raise it.
19. asbjornu commented on Jan 27, 2021

    

    asbjornu

    on Jan 27, 2021

    Member

    More actions

    I wish I could help, but I'm not experienced in the LibGit2Sharp or libgit2 source code myself.
20. hotchkj commented on Jan 27, 2021

    

    hotchkj

    on Jan 27, 2021

    Last edited by hotchkj

    More actions

    Looking at the spec for git_reference_create, the fundamental problem seems to be a parsing or data error somewhere prior. The name passed to git_reference_create isn't faulty because it contains refs. It's faulty period - it should be a canonical name in the form e.g. refs\heads\fully-qualified-refs-fix.

    This appears to be a bug at

    GitVersion/src/GitVersionCore/Core/GitPreparer.cs

    Line 323 in 72ee9ea

    var isRef = currentBranch.Contains("refs");

    but I am assuming the intent of prior code which I may not understand 😄

    Prior code & logging indicates that currentBranch passed to this function EnsureLocalBranchExistsForCurrentBranch is e.g. from logs earlier in GitPreparer

    Branch from build environment: fully-qualified-refs-fix

    which is not canonical.

    Running this code down to the ReferenceCollection.Add yields a call into LibGit2Sharp of

    repo.Refs.Add("fully-qualified-refs-fix", repoTipId.Sha);

    which will inevitably crash. Remove the refs part and it will instead call as

    repo.Refs.Add("refs/heads/fully-qualified-fix", repoTipId.Sha);

    Aside: This is likely why Add is being called, because as far as I can tell these branches do already exist, rather than should be created, but the comparison in if (repo.Branches.All(b => !b.Name.Equals(referenceName))) likely fails for the same reason.
21. asbjornu commented on Jan 28, 2021

    

    asbjornu

    on Jan 28, 2021

    Member

    More actions

    Thanks for the digging, @hotchkj! Perhaps more logging in that area of the GitVersion code may help figure out where the bug may be?
22. hotchkj commented on Jan 28, 2021

    

    hotchkj

    on Jan 28, 2021

    More actions

    Possibly more logs may help. I think the information this report is currently lacking is why this works in the general case but not on Windows. What I am curious about, and I suspect only the author of the relevant GitVersion code can answer, is what the following segment is expected to returned:

    GitVersion/src/GitVersionCore/Core/GitPreparer.cs

    Lines 79 to 93 in 72ee9ea

    	private string ResolveCurrentBranch()
    	{
    	var gitVersionOptions = options.Value;
    	var targetBranch = gitVersionOptions.RepositoryInfo.TargetBranch;
    	if (buildAgent == null)
    	{
    	return targetBranch;
    	}
    	var isDynamicRepository = !string.IsNullOrWhiteSpace(gitVersionOptions.RepositoryInfo.DynamicRepositoryClonePath);
    	var currentBranch = buildAgent.GetCurrentBranch(isDynamicRepository) ?? targetBranch;
    	log.Info("Branch from build environment: " + currentBranch);
    	return currentBranch;
    	}

    As far as I can tell from following the code through, the fault is either in the aforementioned GitVersionCore's EnsureLocalBranchExistsForCurrentBranch because it assumes the presence of the string refs is enough to validate the presence of a canonical name, or the fault lies above in whatever this code does, because it should have reported a canonical name and didn't (perhaps it assumes the build agent reports in a given fashion and that has changed?). There are no comments to determine intent from this outside observer though.

    All that said, it seems likely that the data is coming from a tool outside GitVersion's control, so it may just be better to harden the checking in EnsureLocalBranchExistsForCurrentBranch.
23. asbjornu commented on Jan 28, 2021

    

    asbjornu

    on Jan 28, 2021

    Last edited by asbjornu

    Member

    More actions

    As far as I can tell from following the code through, the fault is either in the aforementioned GitVersionCore's EnsureLocalBranchExistsForCurrentBranch because it assumes the presence of the string refs is enough to validate the presence of a canonical name

    That sounds like a very plausible cause, indeed!

    All that said, it seems likely that the data is coming from a tool outside GitVersion's control, so it may just be better to harden the checking in EnsureLocalBranchExistsForCurrentBranch.

    Agreed! The search for refs should at least include /, I'd say. Ideas for how this can be made even more robust and pull requests implementing them are welcome and appreciated. 🙏🏼
24. asbjornu commented on Nov 11, 2021

    

    asbjornu

    on Nov 11, 2021

    Member

    More actions

    If an upgrade of LibGit2Sharp helps with this problem, #2916 should prove useful.
25. HHobeck

    added this to the 6.x milestone on Apr 4, 2023
26. HHobeck commented on Apr 4, 2023

    

    HHobeck

    on Apr 4, 2023

    Contributor

    More actions

    This has been properly solved with #3103. If this error still persists in version 6.x please let me know and re-open this issue. Thank you very much.
27. HHobeck

    closed this as completedon Apr 4, 2023
28. arturcic

    modified the milestones: 6.x, 6.0.0-beta.2 on Apr 6, 2023
29. arturcic commented on Apr 6, 2023

    

    arturcic

    on Apr 6, 2023

    Member

    More actions

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

    • GitHub Release
    • Chocolatey Package
    • .Net Global Tool

    Your GitReleaseManager bot 📦🚀
30. hugofe commented on May 29, 2023

    

    hugofe

    on May 29, 2023

    More actions

    Hey Guys!
    I think the problem was not solved yet. I am testing the gitversion in our pipelines on Azure Devops and I am getting the following error. As you can see I am in the version 6.0.0-beta.2
    

    2023-05-29T10:25:13.0536713Z ERROR [05/29/23 10:25:12:96] An unexpected error occurred:
    2023-05-29T10:25:13.0536845Z * | | | | | | 9652a8a4 5 days ago
    2023-05-29T10:25:13.0537452Z LibGit2Sharp.InvalidSpecificationException: the given reference name 'refs/heads/origin/refs/heads/development ' is not valid
    2023-05-29T10:25:13.0537774Z at LibGit2Sharp.Core.Ensure.HandleError(Int32 result) in //LibGit2Sharp/Core/Ensure.cs:line 154
    2023-05-29T10:25:13.0538023Z at LibGit2Sharp.Core.Ensure.ZeroResult(Int32 result) in //LibGit2Sharp/Core/Ensure.cs:line 172
    2023-05-29T10:25:13.0538339Z at LibGit2Sharp.Core.Proxy.git_reference_lookup(RepositoryHandle repo, String name, Boolean shouldThrowIfNotFound) in //LibGit2Sharp/Core/Proxy.cs:line 1953
    2023-05-29T10:25:13.0538565Z
    2023-05-29T10:25:13.0538887Z INFO [05/29/23 10:25:12:83] Applicable build agent found: 'AzurePipelines'.
    2023-05-29T10:25:13.0539148Z INFO [05/29/23 10:25:12:89] Working directory: /home/vsts/work/r1/a/ETF
    2023-05-29T10:25:13.0539407Z INFO [05/29/23 10:25:12:90] Project root is: /home/vsts/work/r1/a/ETF/
    2023-05-29T10:25:13.0539655Z INFO [05/29/23 10:25:12:90] DotGit directory is: /home/vsts/work/r1/a/ETF/.git
    2023-05-29T10:25:13.0539983Z at LibGit2Sharp.ReferenceCollection.RetrieveReferencePtr(String referenceName, Boolean shouldThrowIfNotFound) in //LibGit2Sharp/ReferenceCollection.cs:line 676
    2023-05-29T10:25:13.0540247Z INFO [05/29/23 10:25:12:90] Branch from build environment: refs/heads/development
    2023-05-29T10:25:13.0540525Z at LibGit2Sharp.ReferenceCollection.Resolve[T](String name) in //LibGit2Sharp/ReferenceCollection.cs:line 441
    2023-05-29T10:25:13.0540947Z INFO [05/29/23 10:25:12:90] Begin: Normalizing git directory for branch 'refs/heads/development '
    2023-05-29T10:25:13.0541382Z INFO [05/29/23 10:25:12:93] One remote found (origin -> 'https://UNFCCC-ICT@dev.azure.com/UNFCCC-ICT/ETF/_git/ETF').
    2023-05-29T10:25:13.0543278Z INFO [05/29/23 10:25:12:93] Skipping fetching, if GitVersion does not calculate your version as expected you might need to allow fetching or use dynamic repositories
    2023-05-29T10:25:13.0543687Z INFO [05/29/23 10:25:12:94] End: Normalizing git directory for branch 'refs/heads/development ' (Took: 39.96ms)
    2023-05-29T10:25:13.0543878Z ERROR [05/29/23 10:25:12:96] An unexpected error occurred:
    2023-05-29T10:25:13.0544199Z LibGit2Sharp.InvalidSpecificationException: the given reference name 'refs/heads/origin/refs/heads/development ' is not valid
    2023-05-29T10:25:13.0544438Z at LibGit2Sharp.Core.Ensure.HandleError(Int32 result) in //LibGit2Sharp/Core/Ensure.cs:line 154
    2023-05-29T10:25:13.0544647Z at LibGit2Sharp.Core.Ensure.ZeroResult(Int32 result) in //LibGit2Sharp/Core/Ensure.cs:line 172
    2023-05-29T10:25:13.0544908Z at LibGit2Sharp.Core.Proxy.git_reference_lookup(RepositoryHandle repo, String name, Boolean shouldThrowIfNotFound) in //LibGit2Sharp/Core/Proxy.cs:line 1953
    2023-05-29T10:25:13.0545206Z at LibGit2Sharp.ReferenceCollection.RetrieveReferencePtr(String referenceName, Boolean shouldThrowIfNotFound) in //LibGit2Sharp/ReferenceCollection.cs:line 676
    2023-05-29T10:25:13.0545470Z at LibGit2Sharp.ReferenceCollection.Resolve[T](String name) in //LibGit2Sharp/ReferenceCollection.cs:line 441
    2023-05-29T10:25:13.0545729Z at LibGit2Sharp.BranchCollection.BuildFromReferenceName(String canonicalName) in //LibGit2Sharp/BranchCollection.cs:line 82
    2023-05-29T10:25:13.0546060Z at LibGit2Sharp.BranchCollection.get_Item(String name) in /_/LibGit2Sharp/BranchCollection.cs:line 49
    2023-05-29T10:25:13.0546335Z at GitVersion.BranchCollection.get_Item(String name) in D:\a\GitVersion\GitVersion\src\GitVersion.LibGit2Sharp\Git\BranchCollection.cs:line 23
    2023-05-29T10:25:13.0546657Z at GitVersion.GitPreparer.EnsureLocalBranchExistsForCurrentBranch(IRemote remote, String currentBranch) in D:\a\GitVersion\GitVersion\src\GitVersion.Core\Core\GitPreparer.cs:line 377
    2023-05-29T10:25:13.0547033Z at GitVersion.GitPreparer.NormalizeGitDirectory(Boolean noFetch, String currentBranchName, Boolean isDynamicRepository) in D:\a\GitVersion\GitVersion\src\GitVersion.Core\Core\GitPreparer.cs:line 163
    2023-05-29T10:25:13.0547385Z at GitVersion.GitPreparer.NormalizeGitDirectory(String targetBranch, Boolean isDynamicRepository) in D:\a\GitVersion\GitVersion\src\GitVersion.Core\Core\GitPreparer.cs:line 134
    2023-05-29T10:25:13.0547726Z at GitVersion.GitPreparer.PrepareInternal(GitVersionOptions gitVersionOptions) in D:\a\GitVersion\GitVersion\src\GitVersion.Core\Core\GitPreparer.cs:line 69
    2023-05-29T10:25:13.0548010Z at GitVersion.GitPreparer.Prepare() in D:\a\GitVersion\GitVersion\src\GitVersion.Core\Core\GitPreparer.cs:line 48
    2023-05-29T10:25:13.0548294Z at GitVersion.GitVersionCalculateTool.CalculateVersionVariables() in D:\a\GitVersion\GitVersion\src\GitVersion.Core\Core\GitVersionCalculateTool.cs:line 43
    2023-05-29T10:25:13.0548635Z at GitVersion.GitVersionExecutor.RunGitVersionTool(GitVersionOptions gitVersionOptions) in D:\a\GitVersion\GitVersion\src\GitVersion.App\GitVersionExecutor.cs:line 65
    2023-05-29T10:25:13.0548898Z INFO [05/29/23 10:25:12:96] Attempting to show the current git graph (please include in issue):
    2023-05-29T10:25:13.0549089Z INFO [05/29/23 10:25:12:96] Showing max of 100 commits
    2023-05-29T10:25:13.0549375Z INFO [05/29/23 10:25:13:03] * f7d65f31 6 minutes ago (origin/feature/ETF-3569-aci-with-tf)