generate comment to PR / issues

Author: monilpat

packages/plugin-github/src/plugins/addCommentToIssue.ts

@@ -14,10 +14,12 @@ import { GitHubService } from "../services/github";
 import {
     AddCommentToIssueContent,
     AddCommentToIssueSchema,
+    GenerateCommentForASpecificPRSchema,
     isAddCommentToIssueContent,
+    isGenerateCommentForASpecificPRSchema,
 } from "../types";
-import { addCommentToIssueTemplate } from "../templates";
-import { incorporateRepositoryState } from "../utils";
+import { addCommentToIssueTemplate, generateCommentForASpecificIssueTemplate } from "../templates";
+import { getIssueFromMemories, incorporateRepositoryState } from "../utils";
 
 export const addCommentToIssueAction: Action = {
     name: "ADD_COMMENT_TO_ISSUE",
@@ -46,6 +48,7 @@ export const addCommentToIssueAction: Action = {
             state = await runtime.updateRecentMessageState(state);
         }
         const updatedState = await incorporateRepositoryState(state, runtime, message, []);
+        updatedState.specificIssue = 1; // update to the specific issue number
         elizaLogger.info("State:", updatedState);
 
         const context = composeContext({
@@ -67,18 +70,41 @@ export const addCommentToIssueAction: Action = {
 
         const content = details.object as AddCommentToIssueContent;
 
-        elizaLogger.info("Adding comment to issue in the repository...");
-
         const githubService = new GitHubService({
             owner: content.owner,
             repo: content.repo,
             auth: runtime.getSetting("GITHUB_API_TOKEN"),
         });
+        const issue = await getIssueFromMemories(runtime, message, content.issue);
+        updatedState.specificIssue = JSON.stringify(issue.content);
+        const commentContext = composeContext({
+            state: updatedState,
+            template: generateCommentForASpecificIssueTemplate,
+        });
+
+        const commentDetails = await generateObject({
+            runtime,
+            context: commentContext,
+            modelClass: ModelClass.LARGE,
+            schema: GenerateCommentForASpecificPRSchema,
+        });
+
+        if (!isGenerateCommentForASpecificPRSchema(commentDetails.object)) {
+            elizaLogger.error("Invalid comment content:", commentDetails.object);
+            throw new Error("Invalid comment content");
+        }
+
+        const commentBody = commentDetails.object.comment;
+
+        elizaLogger.info("Adding comment to issue in the repository...", {
+            issue,
+            commentBody,
+        });
 
         try {
             const comment = await githubService.addIssueComment(
                 content.issue,
-                content.comment
+                commentBody
             );
 
             elizaLogger.info(

packages/plugin-github/src/plugins/addCommentToPR.ts

@@ -14,10 +14,12 @@ import { GitHubService } from "../services/github";
 import {
     AddCommentToPRContent,
     AddCommentToPRSchema,
+    GenerateCommentForASpecificPRSchema,
     isAddCommentToPRContent,
+    isGenerateCommentForASpecificPRSchema,
 } from "../types";
-import { addCommentToPRTemplate } from "../templates";
-import { incorporateRepositoryState } from "../utils";
+import { addCommentToPRTemplate, generateCommentForASpecificPRTemplate } from "../templates";
+import { getPullRequestFromMemories, incorporateRepositoryState } from "../utils";
 
 export const addCommentToPRAction: Action = {
     name: "ADD_COMMENT_TO_PR",
@@ -68,7 +70,31 @@ export const addCommentToPRAction: Action = {
         const content = details.object as AddCommentToPRContent;
 
         elizaLogger.info("Adding comment to pull request in the repository...");
+        const pullRequest = await getPullRequestFromMemories(runtime, message, content.pullRequest);
+        updatedState.specificPullRequest = JSON.stringify(pullRequest.content);
+        const commentContext = composeContext({
+            state: updatedState,
+            template: generateCommentForASpecificPRTemplate,
+        });
+
+        const commentDetails = await generateObject({
+            runtime,
+            context: commentContext,
+            modelClass: ModelClass.LARGE,
+            schema: GenerateCommentForASpecificPRSchema,
+        });
+
+        if (!isGenerateCommentForASpecificPRSchema(commentDetails.object)) {
+            elizaLogger.error("Invalid comment content:", commentDetails.object);
+            throw new Error("Invalid comment content");
+        }
 
+        const commentBody = commentDetails.object.comment;
+
+        elizaLogger.info("Adding comment to pull request in the repository...", {
+            pullRequest,
+            commentBody,
+        });
         const githubService = new GitHubService({
             owner: content.owner,
             repo: content.repo,
@@ -78,7 +104,7 @@ export const addCommentToPRAction: Action = {
         try {
             const comment = await githubService.addPRComment(
                 content.pullRequest,
-                content.comment
+                commentBody
             );
 
             elizaLogger.info(

packages/plugin-github/src/templates.ts

@@ -649,36 +649,55 @@ Here are the recent user messages for context:
 `;
 
 export const addCommentToIssueTemplate = `
-Extract the details for adding a comment to a GitHub issue and ensure the comment aligns with the character's goals and the user's request:
+Extract the details for adding a comment to a specific GitHub issue:
 - **owner** (string): The owner of the GitHub repository (e.g., "octocat")
 - **repo** (string): The name of the GitHub repository (e.g., "hello-world")
-- **issue_number** (number): The number of the issue (e.g., 1)
-- **comment** (string): The comment to add (e.g., "Add new documentation")
+- **issue_number** (number): The number of the issue to comment on (e.g., 1)
 
 ${contextTemplate}
 \`\`\`json
 {
     "owner": "<owner>",
     "repo": "<repo>",
-    "issue_number": "<issue_number>",
+    "issue_number": "<issue_number>"
+}
+\`\`\`
+`;
+
+export const generateCommentForASpecificIssueTemplate = `
+Generate a comment for a specific GitHub issue that aligns with the character's goals and the user's request:
+Here is the specific issue to comment on: {{specificIssue}}
+${contextTemplate}
+\`\`\`json
+{
     "comment": "<comment>"
 }
 \`\`\`
-e
 `;
+
 export const addCommentToPRTemplate = `
-Extract the details for adding a comment to a GitHub pull request and ensure the comment aligns with the character's goals and the user's request:
+Extract the details for a specific GitHub pull request:
 - **owner** (string): The owner of the GitHub repository (e.g., "octocat")
 - **repo** (string): The name of the GitHub repository (e.g., "hello-world")
 - **pullRequest** (number): The number of the pull request (e.g., 1)
-- **comment** (string): The comment to add (e.g., "Add new documentation")
 
+Here is the specific pull request: {{specificPullRequest}}
 ${contextTemplate}
 \`\`\`json
 {
     "owner": "<owner>",
     "repo": "<repo>",
-    "pullRequest": "<pullRequest>",
+    "pullRequest": "<pullRequest>"
+}
+\`\`\`
+`;
+
+export const generateCommentForASpecificPRTemplate = `
+Generate a comment for a specific GitHub pull request that aligns with the character's goals and the user's request:
+Here is the specific pull request to comment on: {{specificPullRequest}}
+${contextTemplate}
+\`\`\`json
+{
     "comment": "<comment>"
 }
 \`\`\`

packages/plugin-github/src/types.ts

@@ -183,14 +183,12 @@ export const AddCommentToIssueSchema = z.object({
     owner: z.string().min(1, "GitHub owner is required"),
     repo: z.string().min(1, "GitHub repo is required"),
     issue: z.number().min(1, "Issue number is required"),
-    comment: z.string().min(1, "Comment is required"),
 });
 
 export interface AddCommentToIssueContent {
     owner: string;
     repo: string;
     issue: number;
-    comment: string;
 }
 
 export const isAddCommentToIssueContent = (
@@ -219,14 +217,12 @@ export const AddCommentToPRSchema = z.object({
     owner: z.string().min(1, "GitHub owner is required"),
     repo: z.string().min(1, "GitHub repo is required"),
     pullRequest: z.number().min(1, "Pull request number is required"),
-    comment: z.string().min(1, "Comment is required"),
 });
 
 export interface AddCommentToPRContent {
     owner: string;
     repo: string;
     pullRequest: number;
-    comment: string;
 }
 
 export const isAddCommentToPRContent = (
@@ -238,3 +234,15 @@ export const isAddCommentToPRContent = (
     elizaLogger.error("Invalid content: ", object);
     return false;
 };
+
+export const GenerateCommentForASpecificPRSchema = z.object({
+    comment: z.string().min(1, "Comment is required"),
+});
+
+export interface GenerateCommentForASpecificPRSchema {
+    comment: string;
+}
+
+export const isGenerateCommentForASpecificPRSchema = (object: any): object is GenerateCommentForASpecificPRSchema => {
+    return GenerateCommentForASpecificPRSchema.safeParse(object).success;
+};

packages/plugin-github/src/utils.ts

@@ -265,6 +265,24 @@ export async function getIssuesFromMemories(runtime: IAgentRuntime, owner: strin
     return issueMemories;
 }
 
+export const getIssueFromMemories = async (runtime: IAgentRuntime, message: Memory, issueNumber: number): Promise<Memory> => {
+    const roomId = message.roomId;
+    const memories = await runtime.messageManager.getMemories({
+        roomId,
+    });
+    const issueId = stringToUuid(`${roomId}-${runtime.agentId}-issue-${issueNumber}`);
+    return memories.find(memory => memory.id === issueId);
+}
+
+export const getPullRequestFromMemories = async (runtime: IAgentRuntime, message: Memory, pullRequestNumber: number): Promise<Memory> => {
+    const roomId = message.roomId;
+    const memories = await runtime.messageManager.getMemories({
+        roomId,
+    });
+    const prId = stringToUuid(`${roomId}-${runtime.agentId}-pr-${pullRequestNumber}`);
+    return memories.find(memory => memory.id === prId);
+}
+
 export async function incorporateRepositoryState(state: State, runtime: IAgentRuntime, message: Memory, relevantMemories: Memory[]) {
     const files = await getFilesFromMemories(runtime, message);
     // add additional keys to state