libgit2 / libgit2/libgit2sharp
gitdir
Nobody has claimed this yet.
- Dominant language
- C#
- Stars
- 3.5k
- Forks
- 925
- PR merge metrics
- No merged PRs in 30d
Description
Problem Description
The Worktree API in LibGit2Sharp does not expose any property to retrieve the actual working directory path associated with a worktree (i.e., the folder where the code is checked out).
Currently, the Worktree object only provides:
Name→ the name of the worktree (e.g., "core")GitDirectory→ the path.git/worktrees/<name>, which does not correspond to the working directory
Due to this limitation, consumers must manually:
- Read the content of
.git/worktrees/<name>/gitdir - Use
Directory.GetParent()to resolve the real worktree folder path
This approach is both fragile and undocumented.
Expected Behavior
Expose a property like Worktree.WorkingDirectory (similar to Repository.Info.WorkingDirectory) that returns the actual working directory path of the worktree (e.g., C:\repo-core).
Example Workaround
var worktreePaths = new List<string>();
var gitDir = Path.Combine(repoPath, ".git", "worktrees");
foreach (var folder in Directory.GetDirectories(gitDir))
{
var gitdirFile = Path.Combine(folder, "gitdir");
if (File.Exists(gitdirFile))
{
var gitdirPath = File.ReadAllText(gitdirFile).Trim();
var worktreePath = Directory.GetParent(gitdirPath)?.FullName;
if (!string.IsNullOrEmpty(worktreePath))
worktreePaths.Add(worktreePath);
}
}
This code reads the .git/worktrees/<name>/gitdir file and manually resolves the worktree’s root folder. A native API would make this more reliable and developer-friendly.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Worktree API and compare it with Repository.Info.WorkingDirectory. Trace how .git/worktrees//gitdir identifies the checkout path, then verify the new property returns the actual worktree directory such as C:\repo-core. Done means consumers no longer need to read and resolve the gitdir file themselves.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp, git
- Domain
- backend-api-design, devtools
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 42/100