Saves a merge base branch defined by user

(#4224)

Author: dv

contributions.json

@@ -71,6 +71,10 @@
 			"enablement": "gitlens:enabled && resourceScheme =~ /^(gitlens|pr)$/",
 			"commandPalette": "!gitlens:hasVirtualFolders && gitlens:enabled && resourceScheme =~ /^(gitlens|git|pr)$/"
 		},
+		"gitlens.changeUserDefinedMergeBase": {
+			"label": "Change Merge Target of a branch",
+			"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/changeUserDefinedMergeBase
+
+> 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

@@ -6085,6 +6085,11 @@
 				"icon": "$(folder-opened)",
 				"enablement": "gitlens:enabled && resourceScheme =~ /^(gitlens|pr)$/"
 			},
+			{
+				"command": "gitlens.changeUserDefinedMergeBase",
+				"title": "Change Merge Target of a branch",
+				"category": "GitLens"
+			},
 			{
 				"command": "gitlens.clearFileAnnotations",
 				"title": "Clear File Annotations",
@@ -10370,6 +10375,10 @@
 					"command": "gitlens.browseRepoBeforeRevisionInNewWindow",
 					"when": "!gitlens:hasVirtualFolders && gitlens:enabled && resourceScheme =~ /^(gitlens|git|pr)$/"
 				},
+				{
+					"command": "gitlens.changeUserDefinedMergeBase",
+					"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/changeUserDefinedMergeBase.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 ChangeUserDefinedMergeBaseCommandArgs {
+	readonly command: 'changeUserDefinedMergeBase';
+	state?: Partial<State>;
+}
+
+export class ChangeUserDefinedMergeBaseCommand extends QuickCommand {
+	constructor(container: Container, args?: ChangeUserDefinedMergeBaseCommandArgs) {
+		super(container, 'changeUserDefinedMergeBase', 'changeUserDefinedMergeBase', '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)
+					.setUserDefinedBaseBranchName?.(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 { ChangeUserDefinedMergeBaseCommandArgs } from './changeUserDefinedMergeBase';
 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
+	| ChangeUserDefinedMergeBaseCommandArgs;
 
 @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.changeUserDefinedMergeBase',
+		]);
 	}
 
 	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.changeUserDefinedMergeBase':
+				return this.execute({ command: 'changeUserDefinedMergeBase', ...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 { ChangeUserDefinedMergeBaseCommand } from './changeUserDefinedMergeBase';
 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 === 'changeUserDefinedMergeBase') {
+			this.hiddenItems.push(new ChangeUserDefinedMergeBaseCommand(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.changeUserDefinedMergeBase'
 	| 'gitlens.clearFileAnnotations'
 	| 'gitlens.closeUnchangedFiles'
 	| 'gitlens.compareHeadWith'

src/constants.commands.ts

@@ -33,6 +33,7 @@ type InternalGraphWebviewCommands =
 	| 'gitlens.graph.skipPausedOperation';
 
 type InternalHomeWebviewCommands =
+	| 'gitlens.home.changeUserDefinedMergeBase'
 	| 'gitlens.home.deleteBranchOrWorktree'
 	| 'gitlens.home.pushBranch'
 	| 'gitlens.home.openMergeTargetComparison'
@@ -103,6 +104,7 @@ type InternalWalkthroughCommands =
 
 type InternalGlCommands =
 	| `gitlens.action.${string}`
+	| 'gitlens.changeUserDefinedMergeBase'
 	| '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/changeUserDefinedMergeBase': void;
 
 	/** Sent when the user takes an action on the Launchpad title bar */
 	'launchpad/title/action': LaunchpadTitleActionEvent;

src/constants.ts

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