Add checkout pull request in worktree option by Copilot · Pull Request #8513 · microsoft/vscode-pull-request-github

Copilot · 2026-02-13T09:31:22Z

This PR adds a new "Checkout Pull Request in Worktree" option that allows users to check out a PR branch in a git worktree instead of the main working directory. This enables reviewing colleagues' PRs without having to commit current work, stash changes, or deal with merge conflicts.

Summary

The worktree checkout option is available in two places:

Context menu: Right-click on a PR in the Pull Requests view
PR Description view: In the Checkout button dropdown alongside existing "Open Changes", "Checkout on vscode.dev", and "Checkout on Codespaces" options

Implementation Details

Uses the git extension's createWorktree API
Shows save dialog for worktree location selection first
Progress indicator covers both fetch and worktree creation operations
Shows modal dialog after worktree creation with "New Window" and "Current Window" options for opening the worktree
Command is only available in desktop VS Code (not in web environments) via !isWeb when clause
Uses telemetry to track feature usage
Handles errors gracefully and provides user-friendly error messages
Handles existing local branches: If the branch already exists locally (common when re-checking out a PR), the worktree uses the existing branch instead of trying to create a new one

Original prompt

This section details on the original issue you should resolve

<issue_title>New checkout pull request in worktree option for prs context menu</issue_title>
<issue_description>I'd like an option to checkout a pr in a worktree, as part of the pr view context menu. e.g.
Checkout Pull Request in worktree.

It would be a useful to for being able to review Colleagues prs without having to find a stopping point to commit my current code or having to deal with merge conflicts when unstashing code. Work trees seem like the perfect way to enable this flow, without headaches.

Thanks :)
</issue_description>

Comments on the Issue (you are @copilot in this section)

Fixes New checkout pull request in worktree option for prs context menu #8478

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Co-authored-by: alexr00 <[email protected]>

… naming Co-authored-by: alexr00 <[email protected]>

alexr00

@copilot, there's git extension API for worktrees. I've udpated git.d.ts so include that.

…l execution Co-authored-by: alexr00 <[email protected]>

Copilot · 2026-02-13T10:51:56Z

@copilot, there's git extension API for worktrees. I've udpated git.d.ts so include that.

Updated to use the git extension's createWorktree API in commit 04c416a. Also added the API to src/api/api.d.ts since the Repository interface there was missing it.

…after progress Co-authored-by: alexr00 <[email protected]>

… scope Co-authored-by: alexr00 <[email protected]>

IllusionMH · 2026-04-07T14:31:59Z

I know that initial request was about context menu, but shouldn't it be added to CheckoutButton in webviews/components/header.tsx at the same time to preserve parity in checkout process and make it more prominent for those who use PR Description view?

alexr00 · 2026-04-07T14:59:28Z

@IllusionMH that seems fair.

@copilot address this:

I know that initial request was about context menu, but shouldn't it be added to CheckoutButton in webviews/components/header.tsx at the same time to preserve parity in checkout process and make it more prominent for those who use PR Description view?

…tton Agent-Logs-Url: https://github.com/microsoft/vscode-pull-request-github/sessions/113a0bba-a0a7-47d9-baca-dd4dd5fda645

Copilot · 2026-04-07T15:05:07Z

@IllusionMH that seems fair.

@copilot address this:
...

Added the "Checkout in Worktree" option to the CheckoutButton dropdown in the PR Description view in commit fa08fb7. The option appears in the dropdown when the PR is not currently checked out, alongside the existing "Checkout" and "Open Changes" options.

alexr00

@copilot, creating the worktree fails:

2026-04-17 15:45:04.921 [info] Preparing worktree (new branch 'alexr00/testBackgroundD')
fatal: a branch named 'alexr00/testBackgroundD' already exists

The branch does indeed already exist, I've checked out this PR before.This is common and expected scenario.

Agent-Logs-Url: https://github.com/microsoft/vscode-pull-request-github/sessions/c7f23b9d-14de-42d2-960a-36aa53e2d704 Co-authored-by: alexr00 <[email protected]>

Copilot · 2026-04-17T13:51:11Z

@copilot, creating the worktree fails:

2026-04-17 15:45:04.921 [info] Preparing worktree (new branch 'alexr00/testBackgroundD')...

Fixed in commit db793c6. The code now checks if the branch already exists locally before calling createWorktree. If it exists, the worktree is created using the existing local branch instead of trying to create a new one (which was causing the "branch already exists" error).

alexr00

@copilot:

The action to checkout in a worktree doesn't show from the PR overview/description "checkout" button dropdown
The info notification that shows "open in new window" should be a modal, and it should offer "new window" and "current window"

… worktree Agent-Logs-Url: https://github.com/microsoft/vscode-pull-request-github/sessions/b2dbdafb-3aa3-4d09-8555-21772c09c7e9 Co-authored-by: alexr00 <[email protected]>

Copilot · 2026-04-17T15:25:18Z

@copilot:

The action to checkout in a worktree doesn't show from the PR overview/description "checkout" button dropdown

The info notification that shows "open in new window" should be a modal, and...

Addressed in commit 5f65fda:

The "Checkout in Worktree" option should already appear in the PR Description checkout button dropdown (it was added in commit fa08fb7). Please rebuild the extension to get the latest changes.
Changed the notification to a modal dialog that offers both "New Window" and "Current Window" options for opening the worktree.

alexr00

@copilot

The "Checkout in Worktree" option should already appear in the PR Description checkout button dropdown (it was added in commit fa08fb7). Please rebuild the extension to get the latest changes.

It definitely does not show. There is a bug.

alexr00 · 2026-04-17T15:44:36Z

 	}

+	private checkoutPullRequestInWorktree(message: IRequestMessage<any>): void {
+		vscode.commands.executeCommand('pr.pickInWorktree', this._item).then(


@copilot We should not be running execute command. Instead, put a function to checkout in a worktree somewhere that pull request overview can import it from.

Refactored in commit ed22158. Created a standalone checkoutPRInWorktree function in src/github/worktree.ts that can be imported directly by both commands.ts and pullRequestOverview.ts, eliminating the need for executeCommand.

…eckout menu Agent-Logs-Url: https://github.com/microsoft/vscode-pull-request-github/sessions/32630df4-6da8-4847-8013-e2fb1dabc1bb Co-authored-by: alexr00 <[email protected]>

Copilot · 2026-04-17T15:47:33Z

@copilot

The "Checkout in Worktree" option should already appear in the PR Description checkout button dropdown (it was added in commit fa08fb7). Please rebuild the extension to get the latest chan...

Fixed in commit af07a44. The issue was that the PR Description checkout dropdown uses VS Code's native context menu (via webview/context), not React actions. I added a new pr.pickInWorktreeFromDescription command that handles the BaseContext from the webview and registered it in the webview/context menu contributions in package.json.

…ction Agent-Logs-Url: https://github.com/microsoft/vscode-pull-request-github/sessions/ddf40003-0929-42c3-abfb-5abf98150f00 Co-authored-by: alexr00 <[email protected]>

Initial plan

b44c1ed

Copilot AI assigned Copilot and alexr00 Feb 13, 2026

Copilot started work on behalf of alexr00 February 13, 2026 09:31 View session

Copilot AI and others added 4 commits February 13, 2026 09:33

initial plan for checkout PR in worktree feature

cf08027

Co-authored-by: alexr00 <[email protected]>

feat: add checkout pull request in worktree option

40d6d90

Co-authored-by: alexr00 <[email protected]>

fix: use VS Code Tasks API for reliable cross-platform worktree creation

ecc650d

Co-authored-by: alexr00 <[email protected]>

fix: address code review feedback - improve error handling and branch…

fab1204

… naming Co-authored-by: alexr00 <[email protected]>

Copilot AI changed the title ~~[WIP] Add checkout pull request in worktree option for context menu~~ Add checkout pull request in worktree option Feb 13, 2026

Copilot AI requested a review from alexr00 February 13, 2026 09:48

Copilot finished work on behalf of alexr00 February 13, 2026 09:48

alexr00 added 2 commits February 13, 2026 11:40

argument clean up and keep branch name

80e46a2

Update git API

103da71

alexr00 requested changes Feb 13, 2026

View reviewed changes

Copilot started work on behalf of alexr00 February 13, 2026 10:47 View session

refactor: use git extension API for worktree creation instead of shel…

04c416a

…l execution Co-authored-by: alexr00 <[email protected]>

Copilot AI requested a review from alexr00 February 13, 2026 10:52

Copilot finished work on behalf of alexr00 February 13, 2026 10:52

alexr00 requested changes Feb 13, 2026

View reviewed changes

Comment thread src/commands.ts Outdated

Comment thread src/commands.ts Outdated

Copilot started work on behalf of alexr00 February 13, 2026 11:00 View session

fix: run fetch and worktree selection in parallel, move info message …

ad74445

…after progress Co-authored-by: alexr00 <[email protected]>

Copilot AI requested a review from alexr00 February 13, 2026 11:07

Copilot finished work on behalf of alexr00 February 13, 2026 11:07

Fix createWorktree call

3e1c44e

alexr00 reviewed Feb 13, 2026

View reviewed changes

Comment thread src/commands.ts Outdated

Copilot started work on behalf of alexr00 February 13, 2026 14:09 View session

fix: start progress before fetch operation, include fetch in progress…

766d8a0

… scope Co-authored-by: alexr00 <[email protected]>

Copilot AI requested a review from alexr00 February 13, 2026 14:13

Copilot finished work on behalf of alexr00 February 13, 2026 14:13

Copilot started work on behalf of alexr00 April 7, 2026 15:00 View session

feat: add 'Checkout in Worktree' option to PR Description checkout bu…

fa08fb7

…tton Agent-Logs-Url: https://github.com/microsoft/vscode-pull-request-github/sessions/113a0bba-a0a7-47d9-baca-dd4dd5fda645

Copilot finished work on behalf of alexr00 April 7, 2026 15:06

Merge branch 'main' into copilot/add-worktree-checkout-option

8ea92b4

alexr00 requested changes Apr 17, 2026

View reviewed changes

Copilot started work on behalf of alexr00 April 17, 2026 13:47 View session

fix: handle existing local branch when creating worktree

db793c6

Agent-Logs-Url: https://github.com/microsoft/vscode-pull-request-github/sessions/c7f23b9d-14de-42d2-960a-36aa53e2d704 Co-authored-by: alexr00 <[email protected]>

Copilot finished work on behalf of alexr00 April 17, 2026 13:52

Copilot AI requested a review from alexr00 April 17, 2026 13:52

alexr00 reviewed Apr 17, 2026

View reviewed changes

Copilot started work on behalf of alexr00 April 17, 2026 15:20 View session

feat: use modal dialog with new window and current window options for…

5f65fda

… worktree Agent-Logs-Url: https://github.com/microsoft/vscode-pull-request-github/sessions/b2dbdafb-3aa3-4d09-8555-21772c09c7e9 Co-authored-by: alexr00 <[email protected]>

Copilot finished work on behalf of alexr00 April 17, 2026 15:26

Copilot AI requested a review from alexr00 April 17, 2026 15:26

alexr00 requested changes Apr 17, 2026

View reviewed changes

Copilot started work on behalf of alexr00 April 17, 2026 15:41 View session

alexr00 requested changes Apr 17, 2026

View reviewed changes

feat: add pr.pickInWorktreeFromDescription command for PR overview ch…

af07a44

…eckout menu Agent-Logs-Url: https://github.com/microsoft/vscode-pull-request-github/sessions/32630df4-6da8-4847-8013-e2fb1dabc1bb Co-authored-by: alexr00 <[email protected]>

Copilot finished work on behalf of alexr00 April 17, 2026 15:48

Copilot AI requested a review from alexr00 April 17, 2026 15:48

Copilot started work on behalf of alexr00 April 17, 2026 15:48 View session

refactor: extract worktree checkout logic into standalone utility fun…

ed22158

…ction Agent-Logs-Url: https://github.com/microsoft/vscode-pull-request-github/sessions/ddf40003-0929-42c3-abfb-5abf98150f00 Co-authored-by: alexr00 <[email protected]>

Copilot finished work on behalf of alexr00 April 17, 2026 18:45

Conversation

Copilot AI commented Feb 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Implementation Details

Comments on the Issue (you are @copilot in this section)

Uh oh!

alexr00 left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI commented Feb 13, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

IllusionMH commented Apr 7, 2026

Uh oh!

alexr00 commented Apr 7, 2026

Uh oh!

Copilot AI commented Apr 7, 2026

Uh oh!

alexr00 left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI commented Apr 17, 2026

Uh oh!

alexr00 left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI commented Apr 17, 2026

Uh oh!

alexr00 left a comment

Choose a reason for hiding this comment

Uh oh!

alexr00 Apr 17, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 17, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI commented Apr 17, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Copilot AI commented Feb 13, 2026 •

edited

Loading