Generates changelog from comparison

Author: eamodio

contributions.json

@@ -6881,6 +6881,24 @@
 				]
 			}
 		},
+		"gitlens.views.generateChangelog": {
+			"label": "Generate Changelog",
+			"icon": "$(sparkle)",
+			"menus": {
+				"view/item/context": [
+					{
+						"when": "viewItem =~ /gitlens:compare:results:commits\\b/",
+						"group": "inline",
+						"order": 98
+					},
+					{
+						"when": "viewItem =~ /gitlens:compare:results:commits\\b/ && !listMultiSelection",
+						"group": "4_gitlens_actions",
+						"order": 2
+					}
+				]
+			}
+		},
 		"gitlens.views.graph.openInTab": {
 			"label": "Open in Editor",
 			"icon": "$(link-external)",

docs/telemetry-events.md

@@ -179,6 +179,23 @@ or
 }
 ```
 
+or
+
+```typescript
+{
+  'duration': number,
+  'failed.error': string,
+  'failed.reason': 'user-declined' | 'user-cancelled' | 'error',
+  'input.length': number,
+  'model.id': string,
+  'model.provider.id': 'anthropic' | 'deepseek' | 'gemini' | 'github' | 'huggingface' | 'openai' | 'vscode' | 'xai',
+  'model.provider.name': string,
+  'output.length': number,
+  'retry.count': number,
+  'type': 'changelog'
+}
+```
+
 ### associateIssueWithBranch/action
 
 > Sent when the user chooses to manage integrations

package.json

@@ -3919,6 +3919,16 @@
 							"preview"
 						]
 					},
+					"gitlens.ai.generateChangelog.customInstructions": {
+						"type": "string",
+						"default": null,
+						"markdownDescription": "Specifies custom instructions to provide to the AI provider when generating a changelog from a set of changes",
+						"scope": "window",
+						"order": 110,
+						"tags": [
+							"preview"
+						]
+					},
 					"gitlens.ai.generateCommitMessage.customInstructions": {
 						"type": "string",
 						"default": null,
@@ -8169,6 +8179,11 @@
 				"command": "gitlens.views.fileHistory.setShowMergeCommitsOn",
 				"title": "Show Merge Commits"
 			},
+			{
+				"command": "gitlens.views.generateChangelog",
+				"title": "Generate Changelog",
+				"icon": "$(sparkle)"
+			},
 			{
 				"command": "gitlens.views.graph.openInTab",
 				"title": "Open in Editor",
@@ -11791,6 +11806,10 @@
 					"command": "gitlens.views.fileHistory.setShowMergeCommitsOn",
 					"when": "false"
 				},
+				{
+					"command": "gitlens.views.generateChangelog",
+					"when": "false"
+				},
 				{
 					"command": "gitlens.views.graph.openInTab",
 					"when": "false"
@@ -15921,6 +15940,11 @@
 					"when": "viewItem =~ /gitlens:compare:results(?!:)\\b/ && !listMultiSelection",
 					"group": "2_gitlens_quickopen@2"
 				},
+				{
+					"command": "gitlens.views.generateChangelog",
+					"when": "viewItem =~ /gitlens:compare:results:commits\\b/",
+					"group": "inline@98"
+				},
 				{
 					"command": "gitlens.openComparisonOnRemote",
 					"when": "viewItem =~ /gitlens:compare:results:commits\\b/ && gitlens:repos:withRemotes",
@@ -15932,6 +15956,11 @@
 					"when": "viewItem =~ /gitlens:compare:results:commits\\b/ && !listMultiSelection && gitlens:repos:withRemotes",
 					"group": "3_gitlens_explore@0"
 				},
+				{
+					"command": "gitlens.views.generateChangelog",
+					"when": "viewItem =~ /gitlens:compare:results:commits\\b/ && !listMultiSelection",
+					"group": "4_gitlens_actions@2"
+				},
 				{
 					"command": "gitlens.inviteToLiveShare",
 					"when": "viewItem =~ /gitlens:contributor\\b(?!.*?\\b\\+current\\b)/ && gitlens:vsls && gitlens:vsls != guest",

src/ai/aiProviderService.ts

@@ -15,6 +15,7 @@ import { configuration } from '../system/-webview/configuration';
 import type { Storage } from '../system/-webview/storage';
 import { supportedInVSCodeVersion } from '../system/-webview/vscode';
 import { formatNumeric } from '../system/date';
+import type { Lazy } from '../system/lazy';
 import type { Deferred } from '../system/promise';
 import { getSettledValue } from '../system/promise';
 import { getPossessiveForm } from '../system/string';
@@ -33,6 +34,11 @@ export interface AIResult {
 	body: string;
 }
 
+export interface AIGenerateChangelogChange {
+	message: string;
+	issues: { id: string; url: string; title: string | undefined }[];
+}
+
 export interface AIModel<Provider extends AIProviders = AIProviders, Model extends string = string> {
 	readonly id: Model;
 	readonly name: string;
@@ -95,6 +101,12 @@ export interface AIProvider<Provider extends AIProviders = AIProviders> extends
 		reporting: TelemetryEvents['ai/generate'],
 		options?: { cancellation?: CancellationToken; context?: string; codeSuggestion?: boolean },
 	): Promise<string | undefined>;
+	generateChangelog(
+		model: AIModel<Provider>,
+		changes: AIGenerateChangelogChange[],
+		reporting: TelemetryEvents['ai/generate'],
+		options?: { cancellation?: CancellationToken },
+	): Promise<string | undefined>;
 }
 
 export class AIProviderService implements Disposable {
@@ -231,7 +243,7 @@ export class AIProviderService implements Disposable {
 		const changes: string | undefined = await this.getChanges(changesOrRepo);
 		if (changes == null) return undefined;
 
-		const { confirmed, model } = await getModelAndConfirmAIProviderToS(this, this.container.storage);
+		const { confirmed, model } = await getModelAndConfirmAIProviderToS('diff', this, this.container.storage);
 		if (model == null) {
 			options?.generating?.cancel();
 			return undefined;
@@ -315,7 +327,7 @@ export class AIProviderService implements Disposable {
 		const changes: string | undefined = await this.getChanges(changesOrRepo);
 		if (changes == null) return undefined;
 
-		const { confirmed, model } = await getModelAndConfirmAIProviderToS(this, this.container.storage);
+		const { confirmed, model } = await getModelAndConfirmAIProviderToS('diff', this, this.container.storage);
 		if (model == null) {
 			options?.generating?.cancel();
 			return undefined;
@@ -400,7 +412,7 @@ export class AIProviderService implements Disposable {
 			return undefined;
 		}
 
-		const { confirmed, model } = await getModelAndConfirmAIProviderToS(this, this.container.storage);
+		const { confirmed, model } = await getModelAndConfirmAIProviderToS('diff', this, this.container.storage);
 		if (model == null) {
 			options?.generating?.cancel();
 			return undefined;
@@ -470,6 +482,73 @@ export class AIProviderService implements Disposable {
 		}
 	}
 
+	async generateChangelog(
+		changes: Lazy<Promise<AIGenerateChangelogChange[]>>,
+		sourceContext: { source: Sources },
+		options?: { cancellation?: CancellationToken; progress?: ProgressOptions },
+	): Promise<string | undefined> {
+		const { confirmed, model } = await getModelAndConfirmAIProviderToS('data', this, this.container.storage);
+		if (model == null) return undefined;
+
+		const payload: TelemetryEvents['ai/generate'] = {
+			type: 'changelog',
+			'model.id': model.id,
+			'model.provider.id': model.provider.id,
+			'model.provider.name': model.provider.name,
+			'retry.count': 0,
+		};
+		const source: Parameters<TelemetryService['sendEvent']>[2] = { source: sourceContext.source };
+
+		if (!confirmed) {
+			this.container.telemetry.sendEvent('ai/generate', { ...payload, 'failed.reason': 'user-declined' }, source);
+			return undefined;
+		}
+
+		if (options?.cancellation?.isCancellationRequested) {
+			this.container.telemetry.sendEvent(
+				'ai/generate',
+				{ ...payload, 'failed.reason': 'user-cancelled' },
+				source,
+			);
+			return undefined;
+		}
+
+		const promise = changes.value.then(changes =>
+			this._provider!.generateChangelog(model, changes, payload, {
+				cancellation: options?.cancellation,
+			}),
+		);
+
+		const start = Date.now();
+		try {
+			const result = await (options?.progress != null
+				? window.withProgress(
+						{ ...options.progress, title: `Generating changelog with ${model.name}...` },
+						() => promise,
+				  )
+				: promise);
+
+			payload['output.length'] = result?.length;
+			this.container.telemetry.sendEvent('ai/generate', { ...payload, duration: Date.now() - start }, source);
+
+			return result;
+		} catch (ex) {
+			this.container.telemetry.sendEvent(
+				'ai/generate',
+				{
+					...payload,
+					duration: Date.now() - start,
+					...(ex instanceof CancellationError
+						? { 'failed.reason': 'user-cancelled' }
+						: { 'failed.reason': 'error', 'failed.error': String(ex) }),
+				},
+				source,
+			);
+
+			throw ex;
+		}
+	}
+
 	private async getChanges(
 		changesOrRepo: string | string[] | Repository,
 		options?: { cancellation?: CancellationToken; context?: string; progress?: ProgressOptions },
@@ -501,7 +580,7 @@ export class AIProviderService implements Disposable {
 		const diff = await this.container.git.getDiff(commitOrRevision.repoPath, commitOrRevision.ref);
 		if (!diff?.contents) throw new Error('No changes found to explain.');
 
-		const { confirmed, model } = await getModelAndConfirmAIProviderToS(this, this.container.storage);
+		const { confirmed, model } = await getModelAndConfirmAIProviderToS('diff', this, this.container.storage);
 		if (model == null) return undefined;
 
 		const payload: TelemetryEvents['ai/explain'] = {
@@ -632,6 +711,7 @@ export class AIProviderService implements Disposable {
 }
 
 async function getModelAndConfirmAIProviderToS(
+	confirmationType: 'data' | 'diff',
 	service: AIProviderService,
 	storage: Storage,
 ): Promise<{ confirmed: boolean; model: AIModel | undefined }> {
@@ -651,7 +731,11 @@ async function getModelAndConfirmAIProviderToS(
 		const decline: MessageItem = { title: 'Cancel', isCloseAffordance: true };
 
 		const result = await window.showInformationMessage(
-			`GitLens AI features require sending a diff of the code changes to ${model.provider.name} for analysis. This may contain sensitive information.\n\nDo you want to continue?`,
+			`GitLens AI features require sending ${
+				confirmationType === 'data' ? 'data' : 'a diff of the code changes'
+			} to ${
+				model.provider.name
+			} for analysis. This may contain sensitive information.\n\nDo you want to continue?`,
 			{ modal: true },
 			accept,
 			switchModel,
@@ -796,6 +880,14 @@ export function showDiffTruncationWarning(maxCodeCharacters: number, model: AIMo
 	);
 }
 
+export function showPromptTruncationWarning(maxCodeCharacters: number, model: AIModel): void {
+	void window.showWarningMessage(
+		`The prompt had to be truncated to ${formatNumeric(
+			maxCodeCharacters,
+		)} characters to fit within the ${getPossessiveForm(model.provider.name)} limits.`,
+	);
+}
+
 export function getValidatedTemperature(modelTemperature?: number | null): number | undefined {
 	if (modelTemperature === null) return undefined;
 	if (modelTemperature != null) return modelTemperature;

src/ai/openAICompatibleProvider.ts

@@ -8,15 +8,17 @@ import { CancellationError } from '../errors';
 import { configuration } from '../system/-webview/configuration';
 import { sum } from '../system/iterable';
 import { interpolate } from '../system/string';
-import type { AIModel, AIProvider } from './aiProviderService';
+import type { AIGenerateChangelogChange, AIModel, AIProvider } from './aiProviderService';
 import {
 	getMaxCharacters,
 	getOrPromptApiKey,
 	getValidatedTemperature,
 	showDiffTruncationWarning,
+	showPromptTruncationWarning,
 } from './aiProviderService';
 import {
 	explainChangesUserPrompt,
+	generateChangelogUserPrompt,
 	generateCloudPatchMessageUserPrompt,
 	generateCodeSuggestMessageUserPrompt,
 	generateCommitMessageUserPrompt,
@@ -181,6 +183,51 @@ export abstract class OpenAICompatibleProvider<T extends AIProviders> implements
 		);
 	}
 
+	async generateChangelog(
+		model: AIModel<T>,
+		changes: AIGenerateChangelogChange[],
+		reporting: TelemetryEvents['ai/generate'],
+		options?: { cancellation?: CancellationToken },
+	): Promise<string | undefined> {
+		const apiKey = await this.getApiKey();
+		if (apiKey == null) return undefined;
+
+		try {
+			const data = JSON.stringify(changes);
+
+			const [result, maxCodeCharacters] = await this.fetch(
+				model,
+				apiKey,
+				(max, retries): ChatMessage[] => {
+					const messages: ChatMessage[] = [
+						{
+							role: 'user',
+							content: interpolate(generateChangelogUserPrompt, {
+								data: data.substring(0, max),
+								instructions: configuration.get('ai.generateChangelog.customInstructions') ?? '',
+							}),
+						},
+					];
+
+					reporting['retry.count'] = retries;
+					reporting['input.length'] = (reporting['input.length'] ?? 0) + sum(messages, m => m.content.length);
+
+					return messages;
+				},
+				4096,
+				options?.cancellation,
+			);
+
+			if (data.length > maxCodeCharacters) {
+				showPromptTruncationWarning(maxCodeCharacters, model);
+			}
+
+			return result;
+		} catch (ex) {
+			throw new Error(`Unable to generate changelog: ${ex.message}`);
+		}
+	}
+
 	async explainChanges(
 		model: AIModel<T>,
 		message: string,