System prompt generation & Github Workflow Step summary update

Author: Tulga Tsogtgerel

action.yml

@@ -32,7 +32,7 @@ inputs:
 outputs:
   success:
     description: 'Whether the reaction was successfully added'
-    value: ${{ steps.react.outputs.success }}
+    value: ${{ steps.auggie.outputs.success }}
 
 runs:
   using: 'composite'
@@ -51,8 +51,8 @@ runs:
       shell: bash
       working-directory: ${{ github.action_path }}
 
-    - name: React to comment
-      id: react
+    - name: Run Auggie
+      id: auggie
       run: bun run ${{ github.action_path }}/src/index.ts
       shell: bash
       env:
@@ -64,4 +64,5 @@ runs:
         INPUT_AUGMENT_API_URL: ${{ inputs.augment_api_url }}
         INPUT_WORKSPACE_ROOT: ${{ inputs.workspace_root }}
         GITHUB_REPOSITORY: ${{ github.repository }}
+        GITHUB_STEP_SUMMARY: ${{ env.GITHUB_STEP_SUMMARY }}
 

src/auggie.ts

@@ -1,22 +1,26 @@
 import * as core from "@actions/core";
 import { Auggie } from "@augmentcode/auggie-sdk";
+import type { GithubPullRequest } from "./types";
+import { AGENT_SYSTEM_PROMPT, generateContextPrompt } from "./utils/prompt";
 
 /**
  * Options for running Auggie agent
  */
 export type RunAuggieOptions = {
-  prompt: string;
+  userPrompt: string;
   apiKey?: string;
   apiUrl?: string;
   workspaceRoot?: string;
   githubToken?: string;
+  context?: GithubPullRequest;
 };
 
 /**
  * Run Auggie agent with the given prompt and return the response
  */
 export async function runAuggie(options: RunAuggieOptions): Promise<string> {
-  const { prompt, apiKey, apiUrl, workspaceRoot, githubToken } = options;
+  const { userPrompt, apiKey, apiUrl, workspaceRoot, githubToken, context } =
+    options;
 
   const workspace = workspaceRoot || process.cwd();
 
@@ -41,10 +45,21 @@ export async function runAuggie(options: RunAuggieOptions): Promise<string> {
       allowIndexing: true,
     });
 
-    core.info("📝 Sending prompt to Auggie...");
+    core.info("📝 Running Auggie agent ...");
 
-    // Send prompt and get response
-    const response = await client.prompt(prompt, { isAnswerOnly: true });
+    // Build the full prompt by combining system prompt, context, and user prompt
+    let fullPrompt = AGENT_SYSTEM_PROMPT;
+
+    // Add context information if provided
+    if (context) {
+      const contextPrompt = generateContextPrompt(context);
+      fullPrompt = `${fullPrompt}\n\n${contextPrompt}`;
+    }
+
+    // Add user prompt
+    fullPrompt = `${fullPrompt}\n\n${userPrompt}`;
+
+    const response = await client.prompt(fullPrompt, { isAnswerOnly: true });
 
     core.info("✅ Auggie agent completed successfully");
 

src/index.ts

@@ -2,77 +2,7 @@
 import * as core from "@actions/core";
 import { Octokit } from "@octokit/rest";
 import { runAuggie } from "./auggie";
-import {
-  getInput,
-  parseRepository,
-  postComment,
-  reactToComment,
-} from "./utils";
-
-// Regex patterns for extracting issue/PR numbers from URLs
-const ISSUE_URL_PATTERN = /\/issues\/(\d+)$/;
-const PR_URL_PATTERN = /\/pulls\/(\d+)$/;
-
-type GetIssueNumberParams = {
-  octokit: Octokit;
-  owner: string;
-  repo: string;
-  commentId: number;
-  eventName: string;
-};
-
-/**
- * Get issue/PR number from the comment
- * For issue_comment events, we need to fetch the comment to get the issue number
- * For pull_request_review_comment events, we need to fetch the comment to get the PR number
- */
-async function getIssueNumber({
-  octokit,
-  owner,
-  repo,
-  commentId,
-  eventName,
-}: GetIssueNumberParams): Promise<number> {
-  if (eventName === "issue_comment") {
-    // Fetch the comment to get the issue URL
-    const { data: comment } = await octokit.rest.issues.getComment({
-      owner,
-      repo,
-      comment_id: commentId,
-    });
-
-    // Extract issue number from the issue URL
-    const issueUrlMatch = comment.issue_url.match(ISSUE_URL_PATTERN);
-    if (!issueUrlMatch?.[1]) {
-      throw new Error(
-        `Could not extract issue number from URL: ${comment.issue_url}`
-      );
-    }
-
-    return Number.parseInt(issueUrlMatch[1], 10);
-  }
-
-  if (eventName === "pull_request_review_comment") {
-    // Fetch the review comment to get the PR URL
-    const { data: comment } = await octokit.rest.pulls.getReviewComment({
-      owner,
-      repo,
-      comment_id: commentId,
-    });
-
-    // Extract PR number from the pull request URL
-    const prUrlMatch = comment.pull_request_url.match(PR_URL_PATTERN);
-    if (!prUrlMatch?.[1]) {
-      throw new Error(
-        `Could not extract PR number from URL: ${comment.pull_request_url}`
-      );
-    }
-
-    return Number.parseInt(prUrlMatch[1], 10);
-  }
-
-  throw new Error(`Unsupported event type: ${eventName}`);
-}
+import { getInput, parseRepository, reactToComment } from "./utils";
 
 /**
  * Main function
@@ -101,35 +31,25 @@ async function main(): Promise<void> {
     // React to the comment to acknowledge receipt
     await reactToComment({ octokit, owner, repo, commentId, eventName });
 
+    // Log GITHUB_STEP_SUMMARY availability
+    const stepSummaryPath = process.env.GITHUB_STEP_SUMMARY;
+    if (stepSummaryPath) {
+      core.info(`📊 GITHUB_STEP_SUMMARY available at: ${stepSummaryPath}`);
+    } else {
+      core.warning("⚠️ GITHUB_STEP_SUMMARY not available");
+    }
+
     // Run Auggie agent with the prompt
     core.info("🚀 Running Auggie agent...");
-    const response = await runAuggie({
-      prompt,
+    await runAuggie({
+      userPrompt: prompt,
       apiKey: augmentApiKey,
       apiUrl: augmentApiUrl,
       workspaceRoot: workspaceRoot || undefined,
       githubToken,
     });
 
-    // Get issue number for posting the response
-    const issueNumber = await getIssueNumber({
-      octokit,
-      owner,
-      repo,
-      commentId,
-      eventName,
-    });
-
-    // Post the response as a comment
-    await postComment({
-      octokit,
-      owner,
-      repo,
-      issueNumber,
-      body: response,
-      eventName,
-    });
-
+    core.info("✅ Auggie agent completed successfully");
     core.setOutput("success", "true");
   } catch (error) {
     const errorMessage = error instanceof Error ? error.message : String(error);

src/types.ts

@@ -0,0 +1,11 @@
+export type GithubPullRequest = {
+  title: string;
+  body: string;
+  author: string;
+  baseRefName: string;
+  headRefName: string;
+  headRefOid: string;
+  additions: number;
+  deletions: number;
+  state: string;
+}

src/utils/prompt.ts

@@ -0,0 +1,39 @@
+import type { GithubPullRequest } from "../types";
+
+export const AGENT_SYSTEM_PROMPT = `You are an AI assistant designed to help with GitHub issues and pull requests.
+
+Your workflow:
+1. Add a comment to the PR letting the user know you're starting to work on it.
+2. Read the PR context and understand the request.
+3. Create a Todo List:
+   - Update the original comment on the PR with a todo list of what you're going to do. (Use the github-api tool to update the comment. Replace the initial message with the todo list.)
+   - Use your GitHub comment to maintain a detailed task list based on the request.
+   - Format todos as a checklist (- [ ] for incomplete, - [x] for complete).
+   - Update the comment with each task completion.
+4. Update the GitHub Workflow Summary:
+   - Write a detailed execution report to the file path specified in the GITHUB_STEP_SUMMARY environment variable.
+   - Use markdown formatting for the summary.
+   - Include: task overview, what was accomplished, files changed, links to relevant resources.
+   - Append to the file using >> or write using the bash tool.
+   - Example format:
+     ## Auggie Agent Report
+
+     ✅ Task completed successfully
+
+     ### Summary
+     - What was done
+     - Files modified
+     - Links to PRs/commits
+5. Update the original comment with a final summary (remove previous messages, keep only the final summary) that includes:
+   - What documentation was updated
+   - Link to the docs PR`;
+
+export const generateContextPrompt = (context: GithubPullRequest) => {
+  return `PR Title: ${context.title}
+PR Author: ${context.author}
+PR Branch: ${context.headRefName} -> ${context.baseRefName}
+PR State: ${context.state}
+PR Additions: ${context.additions}
+PR Deletions: ${context.deletions}
+PR Body: ${context.body}`;
+};