Get-GitStatus ignores -GitDir argument for critical data

[AArnott]

System Details

• posh-git version/path: 1.0.0 ~\OneDrive\Documents\PowerShell\Modules\posh-git\1.0.0
• PowerShell version: 7.2.0
• git version 2.34.1.windows.1
• OS: Microsoft Windows NT 10.0.22000.0

Issue Description

The Get-GitStatus function ignores the -GitDir parameter for crucial parts of its work. Specifically it invokes git without setting the current working directory for that process to the path specified.

Note how in the below terminal log, Get-GitStatus claims to return data for ..\Lib.Template but still claims that the branch is master. But after actually switching to that directory, the result changes to the (correct) main branch name.

C:\git\Validation.my [master]> git b
* master
C:\git\Validation.my [master]> get-gitstatus -GitDir ..\Lib.Template\

RepoName     : git
BehindBy     : 0
StashCount   : 0
HasWorking   : False
GitDir       : ..\Lib.Template\
Working      : {}
Branch       : master
Index        : {}
HasUntracked : False
Upstream     :
UpstreamGone : False
AheadBy      : 0
HasIndex     : False

C:\git\Validation.my [master]> pushd ..\Lib.Template\
C:\git\Lib.Template [main]> Get-GitStatus

RepoName     : Lib.Template
BehindBy     : 0
StashCount   : 0
HasWorking   : False
GitDir       : C:\git\Lib.Template\.git
Working      : {}
Branch       : main
Index        : {}
HasUntracked : False
Upstream     :
UpstreamGone : False
AheadBy      : 0
HasIndex     : False

[dahlbyk]

Belated thanks for the bug report. You're absolutely right.

We mostly use -GitDir as an "are we in a git dir?" check and don't pass it to any of the git invocations. Most of our invocations would just need --git-dir, but git status will also require --work-tree.

Tentative plan would be something like:

• Default to -WorkTree . -GitDir $null
• If -GitDir is $null, resolve -GitDir from -WorkTree
  • This will require teaching Get-GitDirectory a -Location parameter
• Given both, use both