Merge pull request #11370 from gitbutlerapp/copilot/add-custom-pr-message-prompt

Add custom PR message prompt support

Author: Byron

apps/desktop/src/components/AIPromptEdit.svelte

@@ -7,7 +7,7 @@
 	import type { Prompts, UserPrompt } from '$lib/ai/types';
 
 	interface Props {
-		promptUse: 'commits' | 'branches';
+		promptUse: 'commits' | 'branches' | 'pullRequests';
 	}
 
 	const { promptUse }: Props = $props();
@@ -18,8 +18,10 @@
 
 	if (promptUse === 'commits') {
 		prompts = promptService.commitPrompts;
-	} else {
+	} else if (promptUse === 'branches') {
 		prompts = promptService.branchPrompts;
+	} else {
+		prompts = promptService.prPrompts;
 	}
 
 	const userPrompts = $derived(prompts.userPrompts);
@@ -42,7 +44,11 @@
 {#if prompts && $userPrompts}
 	<div class="prompt-item__title">
 		<h3 class="text-15 text-bold">
-			{promptUse === 'commits' ? 'Commit message' : 'Branch name'}
+			{promptUse === 'commits'
+				? 'Commit message'
+				: promptUse === 'branches'
+					? 'Branch name'
+					: 'PR message'}
 		</h3>
 		<Button kind="outline" icon="plus-small" onclick={createNewPrompt}>New prompt</Button>
 	</div>

apps/desktop/src/components/AIPromptSelect.svelte

@@ -8,7 +8,7 @@
 
 	type Props = {
 		projectId: string;
-		promptUse: 'commits' | 'branches';
+		promptUse: 'commits' | 'branches' | 'pullRequests';
 	};
 
 	const { projectId, promptUse }: Props = $props();
@@ -21,9 +21,12 @@
 	if (promptUse === 'commits') {
 		prompts = promptService.commitPrompts;
 		selectedPromptId = promptService.selectedCommitPromptId(projectId);
-	} else {
+	} else if (promptUse === 'branches') {
 		prompts = promptService.branchPrompts;
 		selectedPromptId = promptService.selectedBranchPromptId(projectId);
+	} else {
+		prompts = promptService.prPrompts;
+		selectedPromptId = promptService.selectedPrPromptId(projectId);
 	}
 
 	let userPrompts = prompts.userPrompts;
@@ -52,7 +55,11 @@
 <Select
 	value={$selectedPromptId}
 	options={allPrompts.map((p) => ({ label: p.name, value: p.id }))}
-	label={promptUse === 'commits' ? 'Commit message' : 'Branch name'}
+	label={promptUse === 'commits'
+		? 'Commit message'
+		: promptUse === 'branches'
+			? 'Branch name'
+			: 'PR message'}
 	wide={true}
 	searchable
 	disabled={allPrompts.length === 1}

apps/desktop/src/components/CloudForm.svelte

@@ -81,6 +81,7 @@
 
 		<AiPromptSelect {projectId} promptUse="commits" />
 		<AiPromptSelect {projectId} promptUse="branches" />
+		<AiPromptSelect {projectId} promptUse="pullRequests" />
 
 		<Spacer margin={8} />
 

apps/desktop/src/components/ReviewCreation.svelte

@@ -13,6 +13,7 @@
 	import PrTemplateSection from '$components/PrTemplateSection.svelte';
 	import MessageEditor from '$components/editor/MessageEditor.svelte';
 	import MessageEditorInput from '$components/editor/MessageEditorInput.svelte';
+	import { PROMPT_SERVICE } from '$lib/ai/promptService';
 	import { AI_SERVICE } from '$lib/ai/service';
 	import { BASE_BRANCH_SERVICE } from '$lib/baseBranch/baseBranchService.svelte';
 	import { type Commit } from '$lib/branches/v3';
@@ -59,6 +60,7 @@
 	const prService = $derived(forge.current.prService);
 	const stackService = inject(STACK_SERVICE);
 	const aiService = inject(AI_SERVICE);
+	const promptService = inject(PROMPT_SERVICE);
 	const remotesService = inject(REMOTES_SERVICE);
 	const uiState = inject(UI_STATE);
 	const settingsService = inject(SETTINGS_SERVICE);
@@ -352,11 +354,13 @@
 		let firstToken = true;
 
 		try {
+			const prTemplate = promptService.selectedPrPrompt(projectId);
 			const description = await aiService?.describePR({
 				title: $prTitle,
 				body: $prBody,
 				commitMessages: commits.map((c) => c.message),
 				prBodyTemplate: prBody.default,
+				prTemplate,
 				onToken: (token) => {
 					if (firstToken) {
 						prBody.reset();

apps/desktop/src/components/profileSettings/AiSettings.svelte

@@ -463,14 +463,16 @@
 		Custom AI prompts
 	{/snippet}
 	{#snippet description()}
-		GitButler's AI assistant generates commit messages and branch names. Use default prompts or
-		create your own. Assign prompts in the project settings.
+		GitButler's AI assistant generates commit messages, branch names, and PR messages. Use default
+		prompts or create your own. Assign prompts in the project settings.
 	{/snippet}
 
 	<div class="prompt-groups">
 		<AIPromptEdit promptUse="commits" />
 		<Spacer margin={12} />
 		<AIPromptEdit promptUse="branches" />
+		<Spacer margin={12} />
+		<AIPromptEdit promptUse="pullRequests" />
 	</div>
 </Section>
 

apps/desktop/src/lib/ai/promptService.ts

@@ -2,7 +2,8 @@ import {
 	LONG_DEFAULT_BRANCH_TEMPLATE,
 	SHORT_DEFAULT_BRANCH_TEMPLATE,
 	LONG_DEFAULT_COMMIT_TEMPLATE,
-	SHORT_DEFAULT_COMMIT_TEMPLATE
+	SHORT_DEFAULT_COMMIT_TEMPLATE,
+	SHORT_DEFAULT_PR_TEMPLATE
 } from '$lib/ai/prompts';
 import { InjectionToken } from '@gitbutler/core/context';
 import { persisted, type Persisted } from '@gitbutler/shared/persisted';
@@ -11,7 +12,8 @@ import type { Prompt, Prompts, UserPrompt } from '$lib/ai/types';
 
 enum PromptPersistedKey {
 	Branch = 'aiBranchPrompts',
-	Commit = 'aiCommitPrompts'
+	Commit = 'aiCommitPrompts',
+	PullRequest = 'aiPullRequestPrompts'
 }
 
 export const PROMPT_SERVICE = new InjectionToken<PromptService>('PromptService');
@@ -31,6 +33,13 @@ export class PromptService {
 		};
 	}
 
+	get prPrompts(): Prompts {
+		return {
+			defaultPrompt: SHORT_DEFAULT_PR_TEMPLATE,
+			userPrompts: persisted<UserPrompt[]>([], PromptPersistedKey.PullRequest)
+		};
+	}
+
 	selectedBranchPromptId(projectId: string): Persisted<string | undefined> {
 		return persisted<string | undefined>(undefined, `${PromptPersistedKey.Branch}-${projectId}`);
 	}
@@ -55,6 +64,21 @@ export class PromptService {
 		return this.findPrompt(get(this.commitPrompts.userPrompts), id);
 	}
 
+	selectedPrPromptId(projectId: string): Persisted<string | undefined> {
+		return persisted<string | undefined>(
+			undefined,
+			`${PromptPersistedKey.PullRequest}-${projectId}`
+		);
+	}
+
+	selectedPrPrompt(projectId: string): Prompt | undefined {
+		const id = get(this.selectedPrPromptId(projectId));
+
+		if (!id) return;
+
+		return this.findPrompt(get(this.prPrompts.userPrompts), id);
+	}
+
 	findPrompt(prompts: UserPrompt[], promptId: string) {
 		const prompt = prompts.find((userPrompt) => userPrompt.id === promptId)?.prompt;
 
@@ -89,11 +113,16 @@ export class PromptService {
 		return false;
 	}
 
-	createDefaultUserPrompt(type: 'commits' | 'branches'): UserPrompt {
+	createDefaultUserPrompt(type: 'commits' | 'branches' | 'pullRequests'): UserPrompt {
 		return {
 			id: crypto.randomUUID(),
 			name: 'My prompt',
-			prompt: type === 'branches' ? SHORT_DEFAULT_BRANCH_TEMPLATE : SHORT_DEFAULT_COMMIT_TEMPLATE
+			prompt:
+				type === 'branches'
+					? SHORT_DEFAULT_BRANCH_TEMPLATE
+					: type === 'commits'
+						? SHORT_DEFAULT_COMMIT_TEMPLATE
+						: SHORT_DEFAULT_PR_TEMPLATE
 		};
 	}
 }