Add auto-stash on PR checkout feature

- Add autoStashOnCheckout setting
- Implement auto-stash logic when checking out PR
- Pop stash when returning to default branch

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

Author: Copilot

package.json

@@ -462,6 +462,11 @@
 						"%githubPullRequests.postDone.checkoutDefaultBranchAndPull%"
 					]
 				},
+				"githubPullRequests.autoStashOnCheckout": {
+					"type": "boolean",
+					"description": "%githubPullRequests.autoStashOnCheckout.description%",
+					"default": false
+				},
 				"githubPullRequests.defaultCommentType": {
 					"type": "string",
 					"enum": [

package.nls.json

@@ -80,6 +80,7 @@
 	"githubPullRequests.postDone.description": "The action to take after using the 'checkout default branch' or 'delete branch' actions on a currently checked out pull request.",
 	"githubPullRequests.postDone.checkoutDefaultBranch": "Checkout the default branch of the repository",
 	"githubPullRequests.postDone.checkoutDefaultBranchAndPull": "Checkout the default branch of the repository and pull the latest changes",
+	"githubPullRequests.autoStashOnCheckout.description": "Automatically stash changes when checking out a pull request, and pop the stash when checking out the default branch.",
 	"githubPullRequests.defaultCommentType.description": "The default comment type to use when submitting a comment and there is no active review",
 	"githubPullRequests.defaultCommentType.single": "Submits the comment as a single comment that will be immediately visible to other users",
 	"githubPullRequests.defaultCommentType.review": "Submits the comment as a review comment that will be visible to other users once the review is submitted",

src/common/settingKeys.ts

@@ -37,6 +37,7 @@ export type PullPRBranchVariants = 'never' | 'pull' | 'pullAndMergeBase' | 'pull
 export const UPSTREAM_REMOTE = 'upstreamRemote';
 export const DEFAULT_CREATE_OPTION = 'defaultCreateOption';
 export const CREATE_BASE_BRANCH = 'createDefaultBaseBranch';
+export const AUTO_STASH_ON_CHECKOUT = 'autoStashOnCheckout';
 
 export const ISSUES_SETTINGS_NAMESPACE = 'githubIssues';
 export const ASSIGN_WHEN_WORKING = 'assignWhenWorking';

src/github/activityBarViewProvider.ts

@@ -8,6 +8,7 @@ import { openPullRequestOnGitHub } from '../commands';
 import { IComment } from '../common/comment';
 import { emojify, ensureEmojis } from '../common/emoji';
 import { disposeAll } from '../common/lifecycle';
+import Logger from '../common/logger';
 import { ReviewEvent } from '../common/timelineEvent';
 import { formatError } from '../common/utils';
 import { getNonce, IRequestMessage, WebviewViewBase } from '../common/webview';
@@ -130,7 +131,19 @@ export class PullRequestViewProvider extends WebviewViewBase implements vscode.W
 		try {
 			const defaultBranch = await this._folderRepositoryManager.getPullRequestRepositoryDefaultBranch(this._item);
 			const prBranch = this._folderRepositoryManager.repository.state.HEAD?.name;
+			const shouldPopStash = this._folderRepositoryManager.stashedOnCheckout;
 			await this._folderRepositoryManager.checkoutDefaultBranch(defaultBranch);
+			if (shouldPopStash) {
+				try {
+					Logger.appendLine('Popping stash after returning to default branch', 'ActivityBarViewProvider');
+					await vscode.commands.executeCommand('git.stashPop', this._folderRepositoryManager.repository);
+					this._folderRepositoryManager.stashedOnCheckout = false;
+					Logger.appendLine('Stash popped successfully', 'ActivityBarViewProvider');
+				} catch (popError) {
+					Logger.error(`Failed to pop stash: ${formatError(popError)}`, 'ActivityBarViewProvider');
+					vscode.window.showWarningMessage(vscode.l10n.t('Failed to restore stashed changes: {0}', formatError(popError)));
+				}
+			}
 			if (prBranch) {
 				await this._folderRepositoryManager.cleanupAfterPullRequest(prBranch, this._item);
 			}

src/github/folderRepositoryManager.ts

@@ -209,6 +209,12 @@ export class FolderRepositoryManager extends Disposable {
 	private _onDidChangeRepositories = this._register(new vscode.EventEmitter<{ added: boolean }>());
 	readonly onDidChangeRepositories: vscode.Event<{ added: boolean }> = this._onDidChangeRepositories.event;
 
+	/**
+	 * Tracks whether changes were stashed when checking out the current PR.
+	 * Used to determine if we should pop the stash when returning to the default branch.
+	 */
+	private _stashedOnCheckout: boolean = false;
+
 	private _onDidChangeAssignableUsers = this._register(new vscode.EventEmitter<IAccount[]>());
 	readonly onDidChangeAssignableUsers: vscode.Event<IAccount[]> = this._onDidChangeAssignableUsers.event;
 
@@ -378,6 +384,14 @@ export class FolderRepositoryManager extends Disposable {
 		this._onDidChangeActivePullRequest.fire({ old: oldPR, new: pullRequest });
 	}
 
+	get stashedOnCheckout(): boolean {
+		return this._stashedOnCheckout;
+	}
+
+	set stashedOnCheckout(value: boolean) {
+		this._stashedOnCheckout = value;
+	}
+
 	get repository(): Repository {
 		return this._repository;
 	}

src/github/pullRequestOverview.ts

@@ -652,7 +652,19 @@ export class PullRequestOverviewPanel extends IssueOverviewPanel<PullRequestMode
 	private async checkoutDefaultBranch(message: IRequestMessage<string>): Promise<void> {
 		try {
 			const prBranch = this._folderRepositoryManager.repository.state.HEAD?.name;
+			const shouldPopStash = this._folderRepositoryManager.stashedOnCheckout;
 			await this._folderRepositoryManager.checkoutDefaultBranch(message.args);
+			if (shouldPopStash) {
+				try {
+					Logger.appendLine('Popping stash after returning to default branch', PullRequestOverviewPanel.ID);
+					await vscode.commands.executeCommand('git.stashPop', this._folderRepositoryManager.repository);
+					this._folderRepositoryManager.stashedOnCheckout = false;
+					Logger.appendLine('Stash popped successfully', PullRequestOverviewPanel.ID);
+				} catch (popError) {
+					Logger.error(`Failed to pop stash: ${formatError(popError)}`, PullRequestOverviewPanel.ID);
+					vscode.window.showWarningMessage(vscode.l10n.t('Failed to restore stashed changes: {0}', formatError(popError)));
+				}
+			}
 			if (prBranch) {
 				await this._folderRepositoryManager.cleanupAfterPullRequest(prBranch, this._item);
 			}

src/view/reviewManager.ts

@@ -15,6 +15,7 @@ import { Disposable, disposeAll, toDisposable } from '../common/lifecycle';
 import Logger from '../common/logger';
 import { parseRepositoryRemotes, Remote } from '../common/remote';
 import {
+	AUTO_STASH_ON_CHECKOUT,
 	COMMENTS,
 	FOCUSED_MODE,
 	IGNORE_PR_BRANCHES,
@@ -1087,6 +1088,38 @@ export class ReviewManager extends Disposable {
 		this.statusBarItem.show();
 		this.switchingToReviewMode = true;
 
+		// Check if auto-stash is enabled and there are uncommitted changes
+		const autoStashEnabled = vscode.workspace.getConfiguration(PR_SETTINGS_NAMESPACE).get<boolean>(AUTO_STASH_ON_CHECKOUT, false);
+		this._folderRepoManager.stashedOnCheckout = false;
+
+		if (autoStashEnabled) {
+			const workingTreeChanges = this._repository.state.workingTreeChanges;
+			const indexChanges = this._repository.state.indexChanges;
+			const hasChanges = workingTreeChanges.length > 0 || indexChanges.length > 0;
+
+			if (hasChanges) {
+				try {
+					Logger.appendLine('Auto-stashing changes before PR checkout', this.id);
+					// Add all tracked changes to staging area
+					const allChangedFiles = [
+						...workingTreeChanges.map(change => change.uri.fsPath),
+						...indexChanges.map(change => change.uri.fsPath),
+					];
+					if (allChangedFiles.length > 0) {
+						await this._repository.add(allChangedFiles);
+					}
+					// Stash the changes
+					await vscode.commands.executeCommand('git.stash', this._repository);
+					this._folderRepoManager.stashedOnCheckout = true;
+					Logger.appendLine('Changes stashed successfully', this.id);
+				} catch (stashError) {
+					Logger.error(`Failed to auto-stash changes: ${formatError(stashError)}`, this.id);
+					// Don't block checkout if stashing fails, but warn the user
+					vscode.window.showWarningMessage(vscode.l10n.t('Failed to auto-stash changes: {0}', formatError(stashError)));
+				}
+			}
+		}
+
 		try {
 			await vscode.window.withProgress({ location: vscode.ProgressLocation.Notification }, async (progress) => {
 				const didLocalCheckout = await this._folderRepoManager.checkoutExistingPullRequestBranch(pr, progress);