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 "Checkout" and "Open Changes" 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 "Open in New Window" dialog after progress is finished (not blocking progress)
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

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 <38270282+alexr00@users.noreply.github.com>

… naming Co-authored-by: alexr00 <38270282+alexr00@users.noreply.github.com>

alexr00

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

…l execution Co-authored-by: alexr00 <38270282+alexr00@users.noreply.github.com>

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.

alexr00 · 2026-02-13T10:59:10Z

src/commands.ts

+						const openAction = vscode.l10n.t('Open in New Window');
+						const result = await vscode.window.showInformationMessage(
+							vscode.l10n.t('Worktree created for Pull Request #{0}', pullRequestModel.number),
+							openAction
+						);


@copilot This should happen after the progress is finished, otherwise the progress reports until this info is acked.

Moved the info message to after the progress completes in commit ad74445. The showInformationMessage call now happens after withProgress resolves.

alexr00 · 2026-02-13T10:59:57Z

src/commands.ts

+					try {
+						await repositoryToUse.fetch({ remote: remoteName, ref: branchName });
+					} catch (e) {
+						const errorMessage = e instanceof Error ? e.message : String(e);
+						Logger.appendLine(`Failed to fetch branch ${branchName}: ${errorMessage}`, logId);
+						// Continue even if fetch fails - the branch might already be available locally
+					}
+
+					// Ask user for worktree location
+					const repoRootPath = repositoryToUse.rootUri.fsPath;
+					const parentDir = pathLib.dirname(repoRootPath);
+					const defaultWorktreePath = pathLib.join(parentDir, `pr-${pullRequestModel.number}`);
+
+					const worktreeUri = await vscode.window.showSaveDialog({
+						defaultUri: vscode.Uri.file(defaultWorktreePath),
+						title: vscode.l10n.t('Select Worktree Location'),
+						saveLabel: vscode.l10n.t('Create Worktree'),
+					});


@copilot We should select the work tree location and fetch the branch in parallel.

Updated to run fetch and worktree location selection in parallel using Promise.all in commit ad74445.

…after progress Co-authored-by: alexr00 <38270282+alexr00@users.noreply.github.com>

alexr00 · 2026-02-13T14:08:40Z

src/commands.ts

+			const remoteName = pullRequestModel.remote.remoteName;
+
+			// Run fetch and worktree location selection in parallel
+			const [, worktreeUri] = await Promise.all([


@copilot the progress should start here.

Restructured the code in commit 766d8a0. The progress now starts before the fetch operation and covers both fetch and worktree creation. The dialog for selecting the worktree location is shown before the progress starts.

… scope Co-authored-by: alexr00 <38270282+alexr00@users.noreply.github.com>

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.

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 <38270282+alexr00@users.noreply.github.com>

feat: add checkout pull request in worktree option

40d6d90

Co-authored-by: alexr00 <38270282+alexr00@users.noreply.github.com>

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

ecc650d

Co-authored-by: alexr00 <38270282+alexr00@users.noreply.github.com>

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

fab1204

… naming Co-authored-by: alexr00 <38270282+alexr00@users.noreply.github.com>

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 <38270282+alexr00@users.noreply.github.com>

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

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 <38270282+alexr00@users.noreply.github.com>

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

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 <38270282+alexr00@users.noreply.github.com>

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add checkout pull request in worktree option#8513

Add checkout pull request in worktree option#8513
Copilot wants to merge 12 commits intomainfrom
copilot/add-worktree-checkout-option

Copilot AI commented Feb 13, 2026 •

edited

Loading

Uh oh!

alexr00 left a comment

Uh oh!

Copilot AI commented Feb 13, 2026

Uh oh!

alexr00 Feb 13, 2026

Uh oh!

Copilot AI Feb 13, 2026

Uh oh!

alexr00 Feb 13, 2026

Uh oh!

Copilot AI Feb 13, 2026

Uh oh!

alexr00 Feb 13, 2026

Uh oh!

Copilot AI Feb 13, 2026

Uh oh!

IllusionMH commented Apr 7, 2026

Uh oh!

alexr00 commented Apr 7, 2026

Uh oh!

Copilot AI commented Apr 7, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

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!

alexr00 Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

alexr00 Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

alexr00 Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

IllusionMH commented Apr 7, 2026

Uh oh!

alexr00 commented Apr 7, 2026

Uh oh!

Copilot AI commented Apr 7, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Copilot AI commented Feb 13, 2026 •

edited

Loading