fix: ensure symlinked git directories work#2394
Open
dballance wants to merge 2 commits intoactions:mainfrom
Open
fix: ensure symlinked git directories work#2394dballance wants to merge 2 commits intoactions:mainfrom
dballance wants to merge 2 commits intoactions:mainfrom
Conversation
Author
|
Tested this against my environment and it resolves the issue! |
Contributor
There was a problem hiding this comment.
Pull request overview
Fixes credential includeIf "gitdir:..." matching on self-hosted runners where the workspace path includes symlinks by resolving the host .git directory path before writing includeIf.gitdir:* entries.
Changes:
- Resolve symlinks for the host
.gitdirectory used inincludeIf.gitdir:keys (with a fallback when resolution fails). - Update the bundled
dist/index.jsto reflect the source change. - Add Jest coverage for symlink resolution and the fallback path behavior.
Reviewed changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| src/git-auth-helper.ts | Resolves the host .git path via realpath to make includeIf gitdir matching work with symlinked workspaces. |
| dist/index.js | Compiled/bundled output updated to include the new symlink-resolution logic. |
| test/git-auth-helper.test.ts | Adds tests verifying symlink resolution in includeIf keys and fallback behavior when resolution fails. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
jsoref
reviewed
Mar 31, 2026
| await fs.promises.symlink(workspace, symlinkPath) | ||
|
|
||
| // Make git appear to be operating from the symlink path | ||
| ;(git.getWorkingDirectory as jest.Mock).mockReturnValue(symlinkPath) |
Comment on lines
+276
to
+279
| const realGitDir = ( | ||
| await fs.promises.realpath(path.join(symlinkPath, '.git')) | ||
| ).replace(/\\/g, '/') | ||
| const symlinkGitDir = path.join(symlinkPath, '.git').replace(/\\/g, '/') |
Contributor
There was a problem hiding this comment.
Personally, I'd be inclined to have a function:
function convertBackslashes(file: string) {
return file.replace(/\\/g, '/')
}...
const realGitDir = convertBackslashes(
await fs.promises.realpath(path.join(symlinkPath, '.git'))
)
const symlinkGitDir = convertBackslashes(path.join(symlinkPath, '.git'))...
const fallbackGitDir = convertBackslashes(
path.join(nonexistentPath, '.git')
)I'm not entirely sure about house style, but I occasionally encourage DRY. It helps understand that strings of code are the same.
| // Arrange | ||
| await setup(configureAuth_fallsBackWhenRealpathSyncFails) | ||
|
|
||
| // Use a non-existent path so realpathSync throws ENOENT naturally, |
Contributor
There was a problem hiding this comment.
Suggested change
| // Use a non-existent path so realpathSync throws ENOENT naturally, | |
| // Use a nonexistent path so realpathSync throws ENOENT naturally, |
(This matches your variable in the const below and is a real word)
| // Use a non-existent path so realpathSync throws ENOENT naturally, | ||
| // exercising the catch fallback in configureToken() | ||
| const nonexistentPath = path.join(runnerTemp, 'does-not-exist') | ||
| ;(git.getWorkingDirectory as jest.Mock).mockReturnValue(nonexistentPath) |
Contributor
There was a problem hiding this comment.
Suggested change
| ;(git.getWorkingDirectory as jest.Mock).mockReturnValue(nonexistentPath) | |
| (git.getWorkingDirectory as jest.Mock).mockReturnValue(nonexistentPath) |
?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Resolves #2393