Enhance PR Review with Claude 3.5 Sonnet and Improved Commit Display

.github/workflows/presubmit-review.yml

@@ -1,4 +1,4 @@
-name: Presubmit.ai - Code Review
+name: Presubmit.ai
 
 permissions:
   contents: read
@@ -11,12 +11,13 @@ on:
     types: [created]
 
 jobs:
-  review:
+  Review:
     runs-on: ubuntu-latest
     steps:
       - uses: presubmit/ai-reviewer@latest
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          LLM_MODEL: "claude-3-5-sonnet-20241022"
           LLM_API_KEY: ${{ secrets.LLM_API_KEY }}
         with:
           llm_model: "claude-3-5-sonnet-20241022"

action.yml

@@ -2,7 +2,7 @@ name: "AI Code Reviewer for Pull Requests"
 description: "Review, summarize and auto-fix pull requests with AI"
 author: "Presubmit.ai"
 branding:
-  icon: "git-merge"
+  icon: "check-square"
   color: "black"
 
 inputs:

src/messages.ts

@@ -1,19 +1,41 @@
+import { context } from "@actions/github";
 import { FileDiff } from "./diff";
 import { PullRequestSummary } from "./prompts";
 
-export function buildInitialMessage(
-  baseCommit: string,
-  headCommit: string,
+export const OVERVIEW_MESSAGE_SIGNATURE =
+  "<!-- presubmit.ai: overview message -->";
+
+export function buildOverviewMessage(
+  commits: {
+    sha: string;
+    commit: {
+      message: string;
+    };
+  }[],
   fileDiffs: FileDiff[]
 ): string {
+  const { owner, repo } = context.repo;
+
   let message = `⏳ **Analyzing changes in this PR...** ⏳\n\n`;
   message += `_This might take a few minutes, please wait_\n\n`;
 
   // Group files by operation
-
   message += `<details>\n<summary>📥 Commits</summary>\n\n`;
-  message += `Analyzing changes from base commit (\`${baseCommit}\`) to head commit (\`${headCommit}\`)\n\n`;
-  message += "\n</details>\n\n";
+  message += `Analyzing changes from base commit (\`${commits[0].sha.slice(
+    0,
+    7
+  )}\`) to head commit (\`${commits[commits.length - 1].sha.slice(0, 7)}\`):\n`;
+
+  for (const commit of commits.reverse()) {
+    message += `- [${commit.sha.slice(
+      0,
+      7
+    )}](https://github.com/${owner}/${repo}/commit/${commit.sha}): ${
+      commit.commit.message
+    }\n`;
+  }
+
+  message += "\n\n</details>\n\n";
 
   message += `<details>\n<summary>📁 Files being considered (${fileDiffs.length})</summary>\n\n`;
   for (const diff of fileDiffs) {
@@ -26,13 +48,17 @@ export function buildInitialMessage(
     if (diff.status === "renamed") {
       fileText += ` (from ${diff.previous_filename})`;
     }
-    fileText += ` _(${diff.hunks.length} hunks)_`;
+    fileText += ` _(${diff.hunks.length} ${
+      diff.hunks.length === 1 ? "hunk" : "hunks"
+    })_`;
     message += `${fileText}\n`;
   }
   message += "\n</details>\n\n";
 
   message += "--- \n_autogenerated by presubmit.ai_";
 
+  message += "\n" + OVERVIEW_MESSAGE_SIGNATURE;
+
   return message;
 }
 
@@ -56,5 +82,7 @@ export function buildWalkthroughMessage(summary: PullRequestSummary): string {
     message += `| \`${escapedPath}\` | ${escapedSummary} |\n`;
   }
 
+  message += "\n" + OVERVIEW_MESSAGE_SIGNATURE;
+
   return message;
 }

src/pull_request.ts

@@ -3,7 +3,11 @@ import { Config } from "./config";
 import { initOctokit } from "./octokit";
 import { loadContext } from "./context";
 import runSummaryPrompt from "./prompts";
-import { buildInitialMessage, buildWalkthroughMessage } from "./messages";
+import {
+  buildLoadingMessage,
+  buildWalkthroughMessage,
+  OVERVIEW_MESSAGE_SIGNATURE,
+} from "./messages";
 import { parseFileDiff } from "./diff";
 
 export async function handlePullRequest(config: Config) {
@@ -32,24 +36,39 @@ export async function handlePullRequest(config: Config) {
   const fileDiffs = files.map(parseFileDiff);
   info(`successfully fetched file diffs`);
 
-  // Create initial comment with the summary
-  const initialComment = await octokit.rest.issues.createComment({
-    ...context.repo,
-    issue_number: pull_request.number,
-    body: buildInitialMessage(
-      pull_request.base.sha,
-      pull_request.head.sha,
-      fileDiffs
-    ),
-  });
-  info(`posted initial comment`);
   // Get commit messages
   const { data: commits } = await octokit.rest.pulls.listCommits({
     ...context.repo,
     pull_number: pull_request.number,
   });
   info(`successfully fetched commit messages`);
 
+  // Find or create overview comment with the summary
+  const { data: comments } = await octokit.rest.issues.listComments({
+    ...context.repo,
+    issue_number: pull_request.number,
+  });
+  let overviewComment = comments.find((comment) =>
+    comment.body?.includes(OVERVIEW_MESSAGE_SIGNATURE)
+  );
+  if (overviewComment) {
+    await octokit.rest.issues.updateComment({
+      ...context.repo,
+      comment_id: overviewComment.id,
+      body: buildLoadingMessage(commits, fileDiffs),
+    });
+    info(`updated existing overview comment`);
+  } else {
+    overviewComment = (
+      await octokit.rest.issues.createComment({
+        ...context.repo,
+        issue_number: pull_request.number,
+        body: buildLoadingMessage(commits, fileDiffs),
+      })
+    ).data;
+    info(`posted new overview loading comment`);
+  }
+
   // Generate PR summary
   const summary = await runSummaryPrompt({
     prTitle: pull_request.title,
@@ -68,11 +87,11 @@ export async function handlePullRequest(config: Config) {
   });
   info(`updated pull request title and description`);
 
-  // Update initial comment with the walkthrough
+  // Update overview comment with the walkthrough
   await octokit.rest.issues.updateComment({
     ...context.repo,
-    comment_id: initialComment.data.id,
+    comment_id: overviewComment.id,
     body: buildWalkthroughMessage(summary),
   });
-  info(`posted walkthrough`);
+  info(`updated overview comment with walkthrough`);
 }