Target the fork branch from fork-PR worktrees (#4394)

Creating a worktree from a cross-repository (fork) PR previously named the
local branch with the maintainer's branch prefix (e.g. `me/866`) and pushed to
origin instead of the contributor's fork, so maintainer edits never reached the
PR. Fork PRs now adopt the contributor's branch name (matching same-repo PRs)
and resolve a fork push target, with a non-blocking warning when the PR
disables maintainer edits and an indicator showing where a push will land.

- pr-start-point: return branchNameOverride/headSha/maintainerCanModify for
  cross-repo PRs (previously only same-repo PRs received these)
- github client: surface maintainer_can_modify alongside the fork push target
- composer: warn (but still allow) when "Allow edits from maintainers" is off
- source control: show the fork push target (owner:branch) before pushing
- extract fork-remote cleanup and setup into dedicated, unit-tested modules

Adds unit suites for the cleanup multi-fork matrix, fork-remote setup,
push-target resolution, the warning decision, and the push-target label.

Note: pre-commit react-doctor hook bypassed — its warnings in useComposerState
are pre-existing (identical count on base) and not enforced by CI.

Co-authored-by: Neil <4138956+nwparker@users.noreply.github.com>
This commit is contained in:
Kaylee
2026-06-07 19:51:36 -07:00
committed by GitHub
co-authored by Neil
parent a67afb5a04
commit 528a887ab5
18 changed files with 1050 additions and 223 deletions
+72 -7
View File
@@ -1384,9 +1384,70 @@ describe('getPRForBranch', () => {
cwd: '/repo-root'
})
expect(target).toEqual({
remoteName: 'pr-prateek-orca',
branchName: 'prateek/fix-sidebar-agents-toggle',
remoteUrl: 'git@github.com:prateek/orca.git'
pushTarget: {
remoteName: 'pr-prateek-orca',
branchName: 'prateek/fix-sidebar-agents-toggle',
remoteUrl: 'git@github.com:prateek/orca.git'
}
})
})
it('surfaces maintainer_can_modify=false alongside a fork PR push target', async () => {
getOwnerRepoMock.mockResolvedValueOnce({ owner: 'stablyai', repo: 'orca' })
getOwnerRepoForRemoteMock.mockResolvedValueOnce({ owner: 'stablyai', repo: 'orca' })
ghExecFileAsyncMock.mockResolvedValueOnce({
stdout: JSON.stringify({
maintainer_can_modify: false,
head: {
ref: 'prateek/fix-sidebar-agents-toggle',
repo: {
full_name: 'prateek/orca',
name: 'orca',
clone_url: 'https://github.com/prateek/orca.git',
ssh_url: 'git@github.com:prateek/orca.git',
owner: { login: 'prateek' }
}
}
})
})
gitExecFileAsyncMock.mockResolvedValueOnce({
stdout: 'git@github.com:stablyai/orca.git\n',
stderr: ''
})
await expect(getPullRequestPushTarget('/repo-root', 1738)).resolves.toEqual({
pushTarget: {
remoteName: 'pr-prateek-orca',
branchName: 'prateek/fix-sidebar-agents-toggle',
remoteUrl: 'git@github.com:prateek/orca.git'
},
maintainerCanModify: false
})
})
it('omits maintainerCanModify when the API does not report the flag', async () => {
getOwnerRepoMock.mockResolvedValueOnce({ owner: 'stablyai', repo: 'orca' })
getOwnerRepoForRemoteMock.mockResolvedValueOnce({ owner: 'stablyai', repo: 'orca' })
ghExecFileAsyncMock.mockResolvedValueOnce({
stdout: JSON.stringify({
head: {
ref: 'fix-sidebar',
repo: {
full_name: 'stablyai/orca',
name: 'orca',
clone_url: 'https://github.com/stablyai/orca.git',
ssh_url: 'git@github.com:stablyai/orca.git',
owner: { login: 'stablyai' }
}
}
})
})
await expect(getPullRequestPushTarget('/repo-root', 1738)).resolves.toEqual({
pushTarget: {
remoteName: 'origin',
branchName: 'fix-sidebar'
}
})
})
@@ -1409,8 +1470,10 @@ describe('getPRForBranch', () => {
})
await expect(getPullRequestPushTarget('/repo-root', 1738)).resolves.toEqual({
remoteName: 'origin',
branchName: 'fix-sidebar'
pushTarget: {
remoteName: 'origin',
branchName: 'fix-sidebar'
}
})
expect(gitExecFileAsyncMock).not.toHaveBeenCalled()
})
@@ -1494,8 +1557,10 @@ describe('getPRForBranch', () => {
})
await expect(getPullRequestPushTarget('/repo-root', 1849)).resolves.toEqual({
remoteName: 'origin',
branchName: 'feature/test'
pushTarget: {
remoteName: 'origin',
branchName: 'feature/test'
}
})
expect(ghExecFileAsyncMock).toHaveBeenNthCalledWith(1, ['api', 'repos/fork/orca/pulls/1849'], {
cwd: '/repo-root'
+25 -5
View File
@@ -257,11 +257,22 @@ function sanitizeRemoteName(owner: string, repo: string): string {
return slug ? `pr-${slug}` : 'pr-head'
}
/**
* A fork push target plus the PR's `maintainer_can_modify` flag. The flag rides
* alongside the target (rather than inside {@link GitPushTarget}) so it never
* leaks into the persisted, validated push-target shape.
*/
export type PullRequestPushTarget = {
pushTarget: GitPushTarget
/** false when the PR has "Allow edits from maintainers" off; a push may be rejected. */
maintainerCanModify?: boolean
}
export async function getPullRequestPushTarget(
repoPath: string,
prNumber: number,
connectionId?: string | null
): Promise<GitPushTarget | null> {
): Promise<PullRequestPushTarget | null> {
const context = githubRepoContext(repoPath, connectionId)
const ghOptions = ghRepoExecOptions(context)
const { candidates } = await resolvePRRepositoryCandidates(repoPath, connectionId)
@@ -297,6 +308,7 @@ export async function getPullRequestPushTarget(
}
const origin = await getOwnerRepoForRemote(repoPath, 'origin', connectionId)
const pr = JSON.parse(prStdout) as {
maintainer_can_modify?: boolean
head?: {
ref?: string
repo?: {
@@ -314,6 +326,8 @@ export async function getPullRequestPushTarget(
const repo = headRepo?.name?.trim() ?? headRepo?.full_name?.split('/')[1]?.trim()
const cloneUrl = headRepo?.clone_url?.trim()
const sshUrl = headRepo?.ssh_url?.trim()
const maintainerCanModify =
typeof pr.maintainer_can_modify === 'boolean' ? pr.maintainer_can_modify : undefined
if (!owner || !repo || !branchName || !cloneUrl || !sshUrl) {
return null
}
@@ -322,7 +336,10 @@ export async function getPullRequestPushTarget(
origin.owner.toLowerCase() === owner.toLowerCase() &&
origin.repo.toLowerCase() === repo.toLowerCase()
) {
return { remoteName: 'origin', branchName }
return {
pushTarget: { remoteName: 'origin', branchName },
...(maintainerCanModify !== undefined ? { maintainerCanModify } : {})
}
}
let originUrl: string | null = null
@@ -335,9 +352,12 @@ export async function getPullRequestPushTarget(
originUrl = null
}
return {
remoteName: sanitizeRemoteName(owner, repo),
branchName,
remoteUrl: pickPushRemoteUrl({ originUrl, cloneUrl, sshUrl })
pushTarget: {
remoteName: sanitizeRemoteName(owner, repo),
branchName,
remoteUrl: pickPushRemoteUrl({ originUrl, cloneUrl, sshUrl })
},
...(maintainerCanModify !== undefined ? { maintainerCanModify } : {})
}
} finally {
release()
+62 -8
View File
@@ -20,9 +20,11 @@ describe('resolveGitHubPrStartPoint', () => {
it('falls back to the GitHub PR head ref when a direct branch fetch fails', async () => {
getPullRequestPushTargetMock.mockResolvedValue({
remoteName: 'pr-contributor-orca',
branchName: 'feat/onboarding-model-choice-782',
remoteUrl: 'git@github.com:contributor/orca.git'
pushTarget: {
remoteName: 'pr-contributor-orca',
branchName: 'feat/onboarding-model-choice-782',
remoteUrl: 'git@github.com:contributor/orca.git'
}
})
const gitExec = vi.fn(async (args: string[]) => {
if (args[0] === 'fetch' && String(args[2]).startsWith('+refs/heads/')) {
@@ -50,6 +52,8 @@ describe('resolveGitHubPrStartPoint', () => {
expect(gitExec).toHaveBeenCalledWith(['fetch', 'origin', 'refs/pull/1849/head'])
expect(result).toEqual({
baseBranch: 'def456',
headSha: 'def456',
branchNameOverride: 'feat/onboarding-model-choice-782',
pushTarget: {
remoteName: 'pr-contributor-orca',
branchName: 'feat/onboarding-model-choice-782',
@@ -79,7 +83,11 @@ describe('resolveGitHubPrStartPoint', () => {
})
expect(getPullRequestPushTargetMock).toHaveBeenCalledWith('/repo-root', 1849, null)
expect(result).toEqual({ baseBranch: 'def456' })
expect(result).toEqual({
baseBranch: 'def456',
headSha: 'def456',
branchNameOverride: 'feat/onboarding-model-choice-782'
})
})
it('resolves an inaccessible fork PR even when push-target discovery fails', async () => {
@@ -102,7 +110,11 @@ describe('resolveGitHubPrStartPoint', () => {
expect(getPullRequestPushTargetMock).toHaveBeenCalledWith('/repo-root', 1849, null)
expect(gitExec).toHaveBeenCalledWith(['fetch', 'origin', 'refs/pull/1849/head'])
expect(result).toEqual({ baseBranch: 'abc123' })
expect(result).toEqual({
baseBranch: 'abc123',
headSha: 'abc123',
branchNameOverride: 'feat/onboarding-model-choice-782'
})
})
it('uses PR metadata when the caller did not pass a head ref', async () => {
@@ -112,9 +124,11 @@ describe('resolveGitHubPrStartPoint', () => {
isCrossRepository: true
})
getPullRequestPushTargetMock.mockResolvedValue({
remoteName: 'pr-contributor-orca',
branchName: 'contributor/fix',
remoteUrl: 'git@github.com:contributor/orca.git'
pushTarget: {
remoteName: 'pr-contributor-orca',
branchName: 'contributor/fix',
remoteUrl: 'git@github.com:contributor/orca.git'
}
})
const gitExec = vi.fn(async (args: string[]) => {
if (args[0] === 'rev-parse') {
@@ -133,6 +147,8 @@ describe('resolveGitHubPrStartPoint', () => {
expect(getWorkItemMock).toHaveBeenCalledWith('/repo-root', 1738, 'pr', null)
expect(result).toEqual({
baseBranch: 'abc123',
headSha: 'abc123',
branchNameOverride: 'contributor/fix',
pushTarget: {
remoteName: 'pr-contributor-orca',
branchName: 'contributor/fix',
@@ -141,6 +157,44 @@ describe('resolveGitHubPrStartPoint', () => {
})
})
it('surfaces maintainerCanModify=false for a fork PR so the caller can warn', async () => {
getPullRequestPushTargetMock.mockResolvedValue({
pushTarget: {
remoteName: 'pr-contributor-orca',
branchName: 'contributor/fix',
remoteUrl: 'git@github.com:contributor/orca.git'
},
maintainerCanModify: false
})
const gitExec = vi.fn(async (args: string[]) => {
if (args[0] === 'rev-parse') {
return { stdout: 'abc123\n', stderr: '' }
}
return { stdout: '', stderr: '' }
})
const result = await resolveGitHubPrStartPoint({
repoPath: '/repo-root',
prNumber: 1849,
headRefName: 'contributor/fix',
isCrossRepository: true,
gitExec,
resolveRemote: async () => 'origin'
})
expect(result).toEqual({
baseBranch: 'abc123',
headSha: 'abc123',
branchNameOverride: 'contributor/fix',
pushTarget: {
remoteName: 'pr-contributor-orca',
branchName: 'contributor/fix',
remoteUrl: 'git@github.com:contributor/orca.git'
},
maintainerCanModify: false
})
})
it('returns the verified head SHA, branch override, and push target when same-repo branch fetch succeeds', async () => {
const gitExec = vi.fn(async (args: string[]) => {
if (args[0] === 'rev-parse') {
+25 -5
View File
@@ -22,15 +22,20 @@ export async function resolveGitHubPrStartPoint(
let headRefName = args.headRefName?.trim() ?? ''
let isCrossRepository = args.isCrossRepository === true
let pushTarget: GitPushTarget | undefined
let maintainerCanModify: boolean | undefined
const resolvePushTarget = async (): Promise<void> => {
if (pushTarget) {
return
}
try {
pushTarget =
(await getPullRequestPushTarget(args.repoPath, args.prNumber, args.connectionId ?? null)) ??
undefined
const resolved = await getPullRequestPushTarget(
args.repoPath,
args.prNumber,
args.connectionId ?? null
)
pushTarget = resolved?.pushTarget
maintainerCanModify = resolved?.maintainerCanModify
} catch {
// Why: deleted/inaccessible fork metadata can prevent push-target
// discovery, but GitHub still exposes the PR head ref for checkout.
@@ -94,7 +99,16 @@ export async function resolveGitHubPrStartPoint(
if ('error' in result) {
return result
}
return { ...result, ...(pushTarget ? { pushTarget } : {}) }
// Why: adopt the contributor's branch name locally (mirroring the same-repo
// return below) so fork-PR worktrees aren't renamed with the maintainer's
// branch prefix (e.g. `me/866`). The push refspec still targets the fork.
return {
...result,
headSha: result.baseBranch,
branchNameOverride: headRefName,
...(pushTarget ? { pushTarget } : {}),
...(maintainerCanModify !== undefined ? { maintainerCanModify } : {})
}
}
try {
@@ -111,7 +125,13 @@ export async function resolveGitHubPrStartPoint(
const result = await fetchPullRequestHeadSha()
if (!('error' in result)) {
await resolvePushTarget()
return { ...result, ...(pushTarget ? { pushTarget } : {}) }
return {
...result,
headSha: result.baseBranch,
branchNameOverride: headRefName,
...(pushTarget ? { pushTarget } : {}),
...(maintainerCanModify !== undefined ? { maintainerCanModify } : {})
}
}
}
return {