ci: enhance issue creation by grouping TODOs (#39290)

Author: ggazzo

scripts/todo-issue/src/github.ts

@@ -176,6 +176,25 @@ function buildIssueBody(todo: TodoItem, owner: string, repo: string, sha: string
 	return lines.join('\n');
 }
 
+function buildIssueBodyFromGroup(todos: TodoItem[], owner: string, repo: string, sha: string): string {
+	const bodies = [...new Set(todos.map((t) => t.body).filter(Boolean))] as string[];
+	const locationLines = todos.map((todo) => {
+		const blobUrl = `https://github.com/${owner}/${repo}/blob/${sha}/${encodeURI(todo.filename)}#L${todo.line}-L${todo.line + BLOB_LINES}`;
+		return `- [\`${todo.filename}#L${todo.line}\`](${blobUrl})`;
+	});
+	const lines = [
+		bodies.join('\n\n') || '',
+		'',
+		`<!-- todo-issue -->`,
+		`📝 Found in ${todos.length} location(s):`,
+		'',
+		...locationLines,
+		'',
+		`Commit: ${sha}`,
+	];
+	return lines.join('\n');
+}
+
 async function ensureLabelExists(owner: string, repo: string, label: string, token: string): Promise<void> {
 	try {
 		await githubRequest(`/repos/${owner}/${repo}/labels`, token, 'POST', {
@@ -187,14 +206,25 @@ async function ensureLabelExists(owner: string, repo: string, label: string, tok
 	}
 }
 
-export async function createIssue(todo: TodoItem, config: Config, sha: string): Promise<void> {
+function mergeTodoGroup(todos: TodoItem[]): TodoItem {
+	const first = todos[0];
+	const labels = [...new Set(todos.flatMap((t) => t.labels))];
+	const assignees = [...new Set(todos.flatMap((t) => t.assignees))];
+	return { ...first, labels, assignees };
+}
+
+export async function createIssue(todoOrGroup: TodoItem | TodoItem[], config: Config, sha: string): Promise<void> {
+	const group = Array.isArray(todoOrGroup) ? todoOrGroup : [todoOrGroup];
+	const todo = mergeTodoGroup(group);
+
 	for (const label of todo.labels) {
 		await ensureLabelExists(config.owner, config.repo, label, config.token);
 	}
 
-	const body = buildIssueBody(todo, config.owner, config.repo, sha);
+	const body = group.length > 1 ? buildIssueBodyFromGroup(group, config.owner, config.repo, sha) : buildIssueBody(todo, config.owner, config.repo, sha);
 
-	console.log(`[CREATE] "${todo.title}" (${todo.filename}#L${todo.line})`);
+	const locations = group.map((t) => `${t.filename}#L${t.line}`).join(', ');
+	console.log(`[CREATE] "${todo.title}" (${locations})`);
 
 	const payload: Record<string, unknown> = {
 		title: todo.title,

scripts/todo-issue/src/index.ts

@@ -1,6 +1,6 @@
 #!/usr/bin/env bun
 
-import type { Config } from './types';
+import type { Config, TodoItem } from './types';
 import { extractTodos } from './diff';
 import { matchTodos } from './matcher';
 import { isSimilar } from './similarity';
@@ -72,10 +72,7 @@ async function getDiff(config: Config): Promise<{ diffText: string; resolvedHead
 
 	console.log(`[INFO] Push mode: comparing ${config.baseSha.slice(0, 7)}...${config.headSha.slice(0, 7)}`);
 	return {
-		diffText: await getDiffFromApi(
-			`/repos/${config.owner}/${config.repo}/compare/${config.baseSha}...${config.headSha}`,
-			config.token,
-		),
+		diffText: await getDiffFromApi(`/repos/${config.owner}/${config.repo}/compare/${config.baseSha}...${config.headSha}`, config.token),
 		resolvedHeadSha: config.headSha,
 	};
 }
@@ -101,24 +98,40 @@ async function run(): Promise<void> {
 	const existingIssues = await fetchExistingIssues(config);
 
 	if (config.importAll || config.pathFilter) {
-		const toCreate = todos.filter((t) => t.type === 'add').filter((todo) => {
-			return !existingIssues.find((i) => i.title === todo.title || isSimilar(i.title, todo.title));
-		});
+		const added = todos
+			.filter((t) => t.type === 'add')
+			.filter((todo) => {
+				return !existingIssues.find((i) => i.title === todo.title || isSimilar(i.title, todo.title));
+			});
+
+		const byTitle = new Map<string, TodoItem[]>();
+		for (const todo of added) {
+			const list = byTitle.get(todo.title) ?? [];
+			list.push(todo);
+			byTitle.set(todo.title, list);
+		}
 
-		console.log(`[INFO] Import: ${toCreate.length} new issues to create`);
+		console.log(`[INFO] Import: ${byTitle.size} new issues to create (${added.length} TODOs grouped by title)`);
 
-		for (const todo of toCreate) {
-			await createIssue(todo, config, resolvedHeadSha);
+		for (const group of byTitle.values()) {
+			await createIssue(group, config, resolvedHeadSha);
 		}
 	} else {
 		const { toCreate, toClose, toUpdate, toReference } = matchTodos(todos, existingIssues);
 
+		const createByTitle = new Map<string, TodoItem[]>();
+		for (const todo of toCreate) {
+			const list = createByTitle.get(todo.title) ?? [];
+			list.push(todo);
+			createByTitle.set(todo.title, list);
+		}
+
 		console.log(
-			`[INFO] Actions: ${toCreate.length} create, ${toClose.length} close, ${toUpdate.length} update, ${toReference.length} reference`,
+			`[INFO] Actions: ${createByTitle.size} create, ${toClose.length} close, ${toUpdate.length} update, ${toReference.length} reference`,
 		);
 
-		for (const todo of toCreate) {
-			await createIssue(todo, config, resolvedHeadSha);
+		for (const group of createByTitle.values()) {
+			await createIssue(group, config, resolvedHeadSha);
 		}
 
 		for (const todo of toClose) {