Saves a merge base branch defined by user

(#4224, #4258)

Author: sergeibbb

contributions.json

@@ -71,6 +71,10 @@
 			"enablement": "gitlens:enabled && resourceScheme =~ /^(gitlens|pr)$/",
 			"commandPalette": "!gitlens:hasVirtualFolders && gitlens:enabled && resourceScheme =~ /^(gitlens|git|pr)$/"
 		},
+		"gitlens.changeBranchMergeTarget": {
+			"label": "Change Branch Merge Target",
+			"commandPalette": "gitlens:enabled && !gitlens:readonly && !gitlens:untrusted && !gitlens:hasVirtualFolders"
+		},
 		"gitlens.clearFileAnnotations": {
 			"label": "Clear File Annotations",
 			"icon": "$(gitlens-gitlens-filled)",

docs/telemetry-events.md

@@ -1160,6 +1160,14 @@ or
 }
 ```
 
+### home/changeBranchMergeTarget
+
+> Sent when the user starts defining a user-specific merge target branch
+
+```typescript
+void
+```
+
 ### home/command
 
 > Sent when a Home command is executed

package.json

@@ -6098,6 +6098,11 @@
 				"icon": "$(folder-opened)",
 				"enablement": "gitlens:enabled && resourceScheme =~ /^(gitlens|pr)$/"
 			},
+			{
+				"command": "gitlens.changeBranchMergeTarget",
+				"title": "Change Branch Merge Target",
+				"category": "GitLens"
+			},
 			{
 				"command": "gitlens.clearFileAnnotations",
 				"title": "Clear File Annotations",
@@ -10383,6 +10388,10 @@
 					"command": "gitlens.browseRepoBeforeRevisionInNewWindow",
 					"when": "!gitlens:hasVirtualFolders && gitlens:enabled && resourceScheme =~ /^(gitlens|git|pr)$/"
 				},
+				{
+					"command": "gitlens.changeBranchMergeTarget",
+					"when": "gitlens:enabled && !gitlens:readonly && !gitlens:untrusted && !gitlens:hasVirtualFolders"
+				},
 				{
 					"command": "gitlens.clearFileAnnotations",
 					"when": "resource in gitlens:tabs:blameable && (gitlens:window:annotated || resource in gitlens:tabs:annotated)"

src/commands/changeBranchMergeTarget.ts

@@ -0,0 +1,64 @@
+import type { Container } from '../container';
+import type { GitBranch } from '../git/models/branch';
+import type { Repository } from '../git/models/repository';
+import type { PartialStepState, StepGenerator } from './quickCommand';
+import { QuickCommand, StepResultBreak } from './quickCommand';
+import { pickBranchOrTagStep } from './quickCommand.steps';
+
+interface Context {
+	repos: Repository[];
+	title: string;
+}
+
+type State = {
+	repo: string | Repository;
+	branch: string;
+	mergeBranch: string | undefined;
+};
+
+export interface ChangeBranchMergeTargetCommandArgs {
+	readonly command: 'changeBranchMergeTarget';
+	state?: Partial<State>;
+}
+
+export class ChangeBranchMergeTargetCommand extends QuickCommand {
+	constructor(container: Container, args?: ChangeBranchMergeTargetCommandArgs) {
+		super(container, 'changeBranchMergeTarget', 'changeBranchMergeTarget', 'Change Merge Target', {
+			description: 'Change Merge Target for a branch',
+		});
+		this.initialState = {
+			counter: 0,
+			...args?.state,
+		};
+	}
+
+	protected async *steps(state: PartialStepState<State>): StepGenerator {
+		const context: Context = {
+			repos: this.container.git.openRepositories,
+			title: this.title,
+		};
+		const repository = typeof state.repo === 'string' ? this.container.git.getRepository(state.repo) : state.repo;
+		if (repository) {
+			const result = yield* pickBranchOrTagStep({ counter: 0, repo: repository }, context, {
+				picked: state.mergeBranch,
+				placeholder: 'Pick a merge target branch',
+				value: undefined,
+				filter: {
+					branches: (branch: GitBranch) => branch.remote && branch.name !== state.branch,
+					tags: () => false,
+				},
+			});
+			if (result === StepResultBreak) {
+				return;
+			}
+			const ref = await this.container.git.branches(repository.path).getBranch(state.branch);
+			if (ref && result && state.branch) {
+				await this.container.git
+					.branches(repository.path)
+					.setUserMergeTargetBranchName?.(state.branch, result.name);
+			}
+		}
+
+		await Promise.resolve(true);
+	}
+}

src/commands/quickWizard.ts

@@ -2,16 +2,26 @@ import type { Container } from '../container';
 import type { LaunchpadCommandArgs } from '../plus/launchpad/launchpad';
 import type { AssociateIssueWithBranchCommandArgs, StartWorkCommandArgs } from '../plus/startWork/startWork';
 import { command } from '../system/-webview/command';
+import type { ChangeBranchMergeTargetCommandArgs } from './changeBranchMergeTarget';
 import type { CommandContext } from './commandContext';
 import type { QuickWizardCommandArgsWithCompletion } from './quickWizard.base';
 import { QuickWizardCommandBase } from './quickWizard.base';
 
-export type QuickWizardCommandArgs = LaunchpadCommandArgs | StartWorkCommandArgs | AssociateIssueWithBranchCommandArgs;
+export type QuickWizardCommandArgs =
+	| LaunchpadCommandArgs
+	| StartWorkCommandArgs
+	| AssociateIssueWithBranchCommandArgs
+	| ChangeBranchMergeTargetCommandArgs;
 
 @command()
 export class QuickWizardCommand extends QuickWizardCommandBase {
 	constructor(container: Container) {
-		super(container, ['gitlens.showLaunchpad', 'gitlens.startWork', 'gitlens.associateIssueWithBranch']);
+		super(container, [
+			'gitlens.showLaunchpad',
+			'gitlens.startWork',
+			'gitlens.associateIssueWithBranch',
+			'gitlens.changeBranchMergeTarget',
+		]);
 	}
 
 	protected override preExecute(context: CommandContext, args?: QuickWizardCommandArgsWithCompletion): Promise<void> {
@@ -25,6 +35,9 @@ export class QuickWizardCommand extends QuickWizardCommandBase {
 			case 'gitlens.associateIssueWithBranch':
 				return this.execute({ command: 'associateIssueWithBranch', ...args });
 
+			case 'gitlens.changeBranchMergeTarget':
+				return this.execute({ command: 'changeBranchMergeTarget', ...args });
+
 			default:
 				return this.execute(args);
 		}

src/commands/quickWizard.utils.ts

@@ -5,6 +5,7 @@ import { LaunchpadCommand } from '../plus/launchpad/launchpad';
 import { AssociateIssueWithBranchCommand, StartWorkCommand } from '../plus/startWork/startWork';
 import { configuration } from '../system/-webview/configuration';
 import { getContext } from '../system/-webview/context';
+import { ChangeBranchMergeTargetCommand } from './changeBranchMergeTarget';
 import { BranchGitCommand } from './git/branch';
 import { CherryPickGitCommand } from './git/cherry-pick';
 import { CoAuthorsGitCommand } from './git/coauthors';
@@ -122,6 +123,10 @@ export class QuickWizardRootStep implements QuickPickStep<QuickCommand> {
 		if (args?.command === 'associateIssueWithBranch') {
 			this.hiddenItems.push(new AssociateIssueWithBranchCommand(container, args));
 		}
+
+		if (args?.command === 'changeBranchMergeTarget') {
+			this.hiddenItems.push(new ChangeBranchMergeTargetCommand(container, args));
+		}
 	}
 
 	private _command: QuickCommand | undefined;

src/constants.commands.generated.ts

@@ -619,6 +619,7 @@ export type ContributedPaletteCommands =
 	| 'gitlens.browseRepoAtRevisionInNewWindow'
 	| 'gitlens.browseRepoBeforeRevision'
 	| 'gitlens.browseRepoBeforeRevisionInNewWindow'
+	| 'gitlens.changeBranchMergeTarget'
 	| 'gitlens.clearFileAnnotations'
 	| 'gitlens.closeUnchangedFiles'
 	| 'gitlens.compareHeadWith'

src/constants.commands.ts

@@ -33,6 +33,7 @@ type InternalGraphWebviewCommands =
 	| 'gitlens.graph.skipPausedOperation';
 
 type InternalHomeWebviewCommands =
+	| 'gitlens.home.changeBranchMergeTarget'
 	| 'gitlens.home.deleteBranchOrWorktree'
 	| 'gitlens.home.pushBranch'
 	| 'gitlens.home.openMergeTargetComparison'
@@ -103,6 +104,7 @@ type InternalWalkthroughCommands =
 
 type InternalGlCommands =
 	| `gitlens.action.${string}`
+	| 'gitlens.changeBranchMergeTarget'
 	| 'gitlens.diffWith'
 	| 'gitlens.openOnRemote'
 	| 'gitlens.openWalkthrough'

src/constants.telemetry.ts

@@ -157,6 +157,8 @@ export interface TelemetryEvents extends WebviewShowAbortedEvents, WebviewShownE
 	'home/createBranch': void;
 	/** Sent when the user chooses to start work on an issue from the home view */
 	'home/startWork': void;
+	/** Sent when the user starts defining a user-specific merge target branch */
+	'home/changeBranchMergeTarget': void;
 
 	/** Sent when the user takes an action on the Launchpad title bar */
 	'launchpad/title/action': LaunchpadTitleActionEvent;

src/constants.ts

@@ -49,6 +49,7 @@ export const enum CharCode {
 
 export type GitConfigKeys =
 	| `branch.${string}.${'gk' | 'vscode'}-merge-base`
+	| `branch.${string}.gk-user-merge-target`
 	| `branch.${string}.gk-target-base`
 	| `branch.${string}.gk-associated-issues`
 	| `branch.${string}.github-pr-owner-number`;

src/env/node/git/sub-providers/branches.ts

@@ -627,6 +627,19 @@ export class BranchesGitSubProvider implements GitBranchesSubProvider {
 		await this.provider.config.setConfig(repoPath, mergeBaseConfigKey, base);
 	}
 
+	@log()
+	async getUserMergeTargetBranchName(repoPath: string, ref: string): Promise<string | undefined> {
+		const mergeTargetConfigKey: GitConfigKeys = `branch.${ref}.gk-user-merge-target`;
+		const target = await this.provider.config.getConfig(repoPath, mergeTargetConfigKey);
+		return target?.trim() || undefined;
+	}
+
+	@log()
+	async setUserMergeTargetBranchName(repoPath: string, ref: string, target: string | undefined): Promise<void> {
+		const mergeTargetConfigKey: GitConfigKeys = `branch.${ref}.gk-user-merge-target`;
+		await this.provider.config.setConfig(repoPath, mergeTargetConfigKey, target);
+	}
+
 	private async getBaseBranchFromReflog(
 		repoPath: string,
 		ref: string,

src/git/gitProvider.ts

@@ -258,6 +258,8 @@ export interface GitBranchesSubProvider {
 	setBaseBranchName?(repoPath: string, ref: string, base: string): Promise<void>;
 	getTargetBranchName?(repoPath: string, ref: string): Promise<string | undefined>;
 	setTargetBranchName?(repoPath: string, ref: string, target: string): Promise<void>;
+	getUserMergeTargetBranchName?(repoPath: string, ref: string): Promise<string | undefined>;
+	setUserMergeTargetBranchName?(repoPath: string, ref: string, target: string): Promise<void>;
 	renameBranch?(repoPath: string, oldName: string, newName: string): Promise<void>;
 }
 

src/git/models/branch.ts

@@ -227,4 +227,5 @@ export interface BranchTargetInfo {
 	baseBranch: string | undefined;
 	defaultBranch: string | undefined;
 	targetBranch: MaybePausedResult<string | undefined>;
+	userTargetBranch: string | undefined;
 }

src/git/utils/-webview/branch.utils.ts

@@ -14,23 +14,26 @@ export async function getBranchTargetInfo(
 		timeout?: number;
 	},
 ): Promise<BranchTargetInfo> {
-	const [baseResult, defaultResult, targetResult] = await Promise.allSettled([
+	const [baseResult, defaultResult, targetResult, userTargetResult] = await Promise.allSettled([
 		container.git.branches(branch.repoPath).getBaseBranchName?.(branch.name),
 		getDefaultBranchName(container, branch.repoPath, branch.getRemoteName()),
 		getTargetBranchName(container, branch, {
 			cancellation: options?.cancellation,
 			timeout: options?.timeout,
 		}),
+		container.git.branches(branch.repoPath).getUserMergeTargetBranchName?.(branch.name),
 	]);
 
 	const baseBranchName = getSettledValue(baseResult);
 	const defaultBranchName = getSettledValue(defaultResult);
 	const targetMaybeResult = getSettledValue(targetResult);
+	const userTargetBranchName = getSettledValue(userTargetResult);
 
 	return {
 		baseBranch: baseBranchName,
 		defaultBranch: defaultBranchName,
 		targetBranch: targetMaybeResult ?? { value: undefined, paused: false },
+		userTargetBranch: userTargetBranchName,
 	};
 }
 

src/quickpicks/comparisonPicker.ts

@@ -81,9 +81,14 @@ export async function showComparisonPicker(
 				const branch = await repo?.git.branches().getBranch(head.name);
 				if (branch != null) {
 					const info = await getBranchTargetInfo(container, branch);
-					const target = info.targetBranch.paused
-						? info.baseBranch
-						: info.targetBranch.value ?? info.defaultBranch;
+					let target;
+					if (info.userTargetBranch) {
+						target = info.userTargetBranch;
+					} else if (!info.targetBranch.paused && info.targetBranch.value) {
+						target = info.targetBranch.value;
+					} else {
+						target = info.baseBranch ?? info.defaultBranch;
+					}
 					if (target != null) {
 						base = createReference(target, repoPath, { refType: 'revision' });
 					}

src/webviews/apps/plus/home/components/merge-target-status.ts

@@ -477,18 +477,30 @@ export class GlMergeTargetStatus extends LitElement {
 		return html`<span class="header__actions"
 			>${branchRef && targetRef
 				? html`<gl-button
-						href="${createCommandLink<BranchAndTargetRefs>('gitlens.home.openMergeTargetComparison', {
-							...branchRef,
-							mergeTargetId: targetRef.branchId,
-							mergeTargetName: targetRef.branchName,
-						})}"
-						appearance="toolbar"
-						><code-icon icon="git-compare"></code-icon>
-						<span slot="tooltip"
-							>Compare Branch with Merge Target<br />${renderBranchName(this.branch.name)}
-							&leftrightarrow; ${renderBranchName(this.target?.name)}</span
-						>
-				  </gl-button>`
+							href="${createCommandLink<BranchAndTargetRefs>('gitlens.home.changeBranchMergeTarget', {
+								...branchRef,
+								mergeTargetId: targetRef.branchId,
+								mergeTargetName: targetRef.branchName,
+							})}"
+							appearance="toolbar"
+							><code-icon icon="pencil"></code-icon
+							><span slot="tooltip"
+								>Edit Merge Target<br />${renderBranchName(this.branch.name)} &leftrightarrow;
+								${renderBranchName(this.target?.name)}</span
+							></gl-button
+						><gl-button
+							href="${createCommandLink<BranchAndTargetRefs>('gitlens.home.openMergeTargetComparison', {
+								...branchRef,
+								mergeTargetId: targetRef.branchId,
+								mergeTargetName: targetRef.branchName,
+							})}"
+							appearance="toolbar"
+							><code-icon icon="git-compare"></code-icon>
+							<span slot="tooltip"
+								>Compare Branch with Merge Target<br />${renderBranchName(this.branch.name)}
+								&leftrightarrow; ${renderBranchName(this.target?.name)}</span
+							>
+						</gl-button>`
 				: nothing}<gl-button
 				href="${createCommandLink('gitlens.home.fetch', this.targetBranchRef)}"
 				appearance="toolbar"

src/webviews/home/homeWebview.ts

@@ -4,6 +4,7 @@ import { ActionRunnerType } from '../../api/actionRunners';
 import type { CreatePullRequestActionContext } from '../../api/gitlens';
 import type { EnrichedAutolink } from '../../autolinks/models/autolinks';
 import { getAvatarUriFromGravatarEmail } from '../../avatars';
+import type { ChangeBranchMergeTargetCommandArgs } from '../../commands/changeBranchMergeTarget';
 import type { BranchGitCommandArgs } from '../../commands/git/branch';
 import type { OpenPullRequestOnRemoteCommandArgs } from '../../commands/openPullRequestOnRemote';
 import { GlyphChars, urls } from '../../constants';
@@ -333,6 +334,7 @@ export class HomeWebviewProvider implements WebviewProvider<State, State, HomeWe
 				(src?: Source) => this.container.subscription.validate({ force: true }, src),
 				this,
 			),
+			registerCommand('gitlens.home.changeBranchMergeTarget', this.changeBranchMergeTarget, this),
 			registerCommand('gitlens.home.deleteBranchOrWorktree', this.deleteBranchOrWorktree, this),
 			registerCommand('gitlens.home.pushBranch', this.pushBranch, this),
 			registerCommand('gitlens.home.openMergeTargetComparison', this.mergeTargetCompare, this),
@@ -490,6 +492,19 @@ export class HomeWebviewProvider implements WebviewProvider<State, State, HomeWe
 		});
 	}
 
+	@log<HomeWebviewProvider['changeBranchMergeTarget']>()
+	private changeBranchMergeTarget(ref: BranchAndTargetRefs) {
+		this.container.telemetry.sendEvent('home/changeBranchMergeTarget');
+		void executeCommand<ChangeBranchMergeTargetCommandArgs>('gitlens.changeBranchMergeTarget', {
+			command: 'changeBranchMergeTarget',
+			state: {
+				repo: ref.repoPath,
+				branch: ref.branchName,
+				mergeBranch: ref.mergeTargetName,
+			},
+		});
+	}
+
 	@log<HomeWebviewProvider['mergeIntoCurrent']>({ args: { 0: r => r.branchId } })
 	private async mergeIntoCurrent(ref: BranchRef) {
 		const { repo, branch } = await this.getRepoInfoFromRef(ref);
@@ -1682,7 +1697,9 @@ async function getBranchMergeTargetStatusInfo(
 	});
 
 	let targetResult;
-	if (!info.targetBranch.paused && info.targetBranch.value) {
+	if (info.userTargetBranch) {
+		targetResult = info.userTargetBranch;
+	} else if (!info.targetBranch.paused && info.targetBranch.value) {
 		targetResult = info.targetBranch.value;
 	}