Git - add repository/branch name to the commit message generation context (#1756)

Author: lszomoru

src/extension/prompt/node/gitCommitMessageGenerator.ts

@@ -4,6 +4,7 @@
  *--------------------------------------------------------------------------------------------*/
 
 import type { CancellationToken } from 'vscode';
+import { IAuthenticationService } from '../../../platform/authentication/common/authentication';
 import { ChatFetchResponseType, ChatLocation } from '../../../platform/chat/common/commonTypes';
 import { IConversationOptions } from '../../../platform/chat/common/conversationOptions';
 import { IInteractionService } from '../../../platform/chat/common/interactionService';
@@ -15,13 +16,11 @@ import { IInstantiationService } from '../../../util/vs/platform/instantiation/c
 import { PromptRenderer } from '../../prompts/node/base/promptRenderer';
 import { GitCommitMessagePrompt } from '../../prompts/node/git/gitCommitMessagePrompt';
 import { RecentCommitMessages } from '../common/repository';
-import { IAuthenticationService } from '../../../platform/authentication/common/authentication';
 
 type ResponseFormat = 'noTextCodeBlock' | 'oneTextCodeBlock' | 'multipleTextCodeBlocks';
 
 export class GitCommitMessageGenerator {
 	constructor(
-
 		@IConversationOptions private readonly conversationOptions: IConversationOptions,
 		@IEndpointProvider private readonly endpointProvider: IEndpointProvider,
 		@IInstantiationService private readonly instantiationService: IInstantiationService,
@@ -31,11 +30,11 @@ export class GitCommitMessageGenerator {
 		@IAuthenticationService private readonly authService: IAuthenticationService,
 	) { }
 
-	async generateGitCommitMessage(changes: Diff[], recentCommitMessages: RecentCommitMessages, attemptCount: number, token: CancellationToken): Promise<string | undefined> {
+	async generateGitCommitMessage(repositoryName: string, branchName: string, changes: Diff[], recentCommitMessages: RecentCommitMessages, attemptCount: number, token: CancellationToken): Promise<string | undefined> {
 		const startTime = Date.now();
 
 		const endpoint = await this.endpointProvider.getChatEndpoint('gpt-5-mini');
-		const promptRenderer = PromptRenderer.create(this.instantiationService, endpoint, GitCommitMessagePrompt, { changes, recentCommitMessages });
+		const promptRenderer = PromptRenderer.create(this.instantiationService, endpoint, GitCommitMessagePrompt, { repositoryName, branchName, changes, recentCommitMessages });
 		const prompt = await promptRenderer.render(undefined, undefined);
 
 		const temperature = Math.min(

src/extension/prompt/vscode-node/gitCommitMessageServiceImpl.ts

@@ -12,6 +12,7 @@ import { API, Repository } from '../../../platform/git/vscode/git';
 import { ITelemetryService } from '../../../platform/telemetry/common/telemetry';
 import { CancellationToken } from '../../../util/vs/base/common/cancellation';
 import { DisposableMap, DisposableStore } from '../../../util/vs/base/common/lifecycle';
+import { basename } from '../../../util/vs/base/common/resources';
 import { IInstantiationService } from '../../../util/vs/platform/instantiation/common/instantiation';
 import { RecentCommitMessages } from '../common/repository';
 import { GitCommitMessageGenerator } from '../node/gitCommitMessageGenerator';
@@ -96,8 +97,10 @@ export class GitCommitMessageServiceImpl implements IGitCommitMessageService {
 			const attemptCount = this._getAttemptCount(repository, diffs);
 			const recentCommitMessages = await this._getRecentCommitMessages(repository);
 
+			const repositoryName = basename(repository.rootUri);
+			const branchName = repository.state.HEAD?.name ?? '';
 			const gitCommitMessageGenerator = this._instantiationService.createInstance(GitCommitMessageGenerator);
-			const commitMessage = await gitCommitMessageGenerator.generateGitCommitMessage(changes, recentCommitMessages, attemptCount, cancellationToken);
+			const commitMessage = await gitCommitMessageGenerator.generateGitCommitMessage(repositoryName, branchName, changes, recentCommitMessages, attemptCount, cancellationToken);
 
 			// Save generated commit message
 			if (commitMessage && repository.state.HEAD && repository.state.HEAD.commit) {

src/extension/prompts/node/git/gitCommitMessagePrompt.tsx

@@ -14,6 +14,8 @@ import { FilePathMode, FileVariable } from '../panel/fileVariable';
 import { UnsafeCodeBlock } from '../panel/unsafeElements';
 
 export interface GitCommitMessagePromptProps extends BasePromptElementProps {
+	readonly repositoryName: string;
+	readonly branchName: string;
 	readonly changes: Diff[];
 	readonly recentCommitMessages: RecentCommitMessages;
 }
@@ -28,6 +30,11 @@ export class GitCommitMessagePrompt extends PromptElement<GitCommitMessagePrompt
 					<ResponseTranslationRules />
 				</SystemMessage>
 				<UserMessage>
+					<Tag priority={850} name='repository-context'>
+						# REPOSITORY DETAILS:<br />
+						Repository name: {this.props.repositoryName}<br />
+						Branch name: {this.props.branchName}<br />
+					</Tag>
 					{this.props.recentCommitMessages.user.length > 0 && (
 						<Tag priority={700} name='user-commits'>
 							# RECENT USER COMMITS (For reference only, do not copy!):<br />

test/outcome/git-commit-message-external.json

@@ -2,19 +2,19 @@
 	{
 		"name": "git commit message [external] [python] - Generated commit messages do not bias to conventional commit style",
 		"requests": [
-			"76e4cedef4871402e7a219abb86cf82d2f15e61066129b886247eec2624fa28f"
+			"af8c7badfdd9eca8438b8fbe9fbf772a78d7ee7cb981cc8308f8b87b4d4c343c"
 		]
 	},
 	{
 		"name": "git commit message [external] [python] - Generates a conventional commit message for a bug fix",
 		"requests": [
-			"6aaa56b823f7941301713472a5b64b6d4e2f5cb5b2b0109369f2af89fb41b46d"
+			"130e5b4e8c15c9596988984b617b15756328cd1979e20c23de37770aa5a7ba63"
 		]
 	},
 	{
 		"name": "git commit message [external] [python] - Generates a simple commit message",
 		"requests": [
-			"10feebb5b1a8683f302c4ff663bf32abd018c8bc449d544f5f65ad28b0410d65"
+			"c83ac5663b803b9afc81cb3969ca6946ca0b12da171971fa5426c0bcc18f30ab"
 		]
 	}
 ]

test/prompts/gitCommitMessageGenerator.stest.ts

@@ -46,7 +46,7 @@ index 0877b83..6260896 100644
 		];
 
 		const generator = instantiationService.createInstance(GitCommitMessageGenerator);
-		const message = await generator.generateGitCommitMessage(changes, { repository: [], user: [] }, 0, CancellationToken.None);
+		const message = await generator.generateGitCommitMessage('test-repo', 'main', changes, { repository: [], user: [] }, 0, CancellationToken.None);
 		assert.ok(message !== undefined, 'Failed to generate a commit message');
 	});
 
@@ -91,7 +91,7 @@ index 0877b83..6260896 100644
 		];
 
 		const generator = instantiationService.createInstance(GitCommitMessageGenerator);
-		const message = await generator.generateGitCommitMessage(changes, { repository: repoCommits, user: userCommits }, 0, CancellationToken.None);
+		const message = await generator.generateGitCommitMessage('test-repo', 'main', changes, { repository: repoCommits, user: userCommits }, 0, CancellationToken.None);
 
 		assert.ok(message !== undefined, 'Failed to generate a commit message');
 		assert.ok(!userCommits.some(commit => message.toLowerCase().includes(commit)), 'Commit message contains a user commit');
@@ -143,7 +143,7 @@ index 0877b83..6260896 100644
 		];
 
 		const generator = instantiationService.createInstance(GitCommitMessageGenerator);
-		const message = await generator.generateGitCommitMessage(changes, { repository: repoCommits, user: userCommits }, 0, CancellationToken.None);
+		const message = await generator.generateGitCommitMessage('test-repo', 'main', changes, { repository: repoCommits, user: userCommits }, 0, CancellationToken.None);
 
 		assert.ok(message !== undefined, 'Failed to generate a commit message');
 		assert.ok(!userCommits.some(commit => message.toLowerCase().includes(commit)), 'Commit message contains a user commit');

test/simulation/cache/layers/9414a004-0e90-4081-a38a-bdcb25e2297d.sqlite

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:1db51b8d46c0c1640b4beff7f55319f8db363b4206ecd7a48f16be5d17278311
+size 40960