Compare commits

...

5 Commits

Author SHA1 Message Date
Colin McDonnell b038fc574f Get reviews with comments 2025-12-15 21:37:46 -08:00
Colin McDonnell 316b6cb83c 0.0.138 2025-12-15 21:21:57 -08:00
Colin McDonnell a19ae49224 Determinstically set up PR branch 2025-12-15 21:12:55 -08:00
Colin McDonnell 1d69f0f3e4 0.0.137 2025-12-15 20:22:12 -08:00
Colin McDonnell 2f16d2ef0e Improve repo setup with gh cli 2025-12-15 20:21:56 -08:00
11 changed files with 552 additions and 445 deletions
+72 -72
View File
@@ -8,84 +8,84 @@ import { getModes } from "../modes.ts";
* Removes verbose GitHub API metadata (user objects, repository metadata, etc.)
* and keeps only the fields agents actually need.
*/
function extractEssentialEventData(event: Payload["event"]): Record<string, unknown> {
const trigger = event.trigger;
const essential: Record<string, unknown> = { trigger };
// function extractEssentialEventData(event: Payload["event"]): Record<string, unknown> {
// const trigger = event.trigger;
// const essential: Record<string, unknown> = { trigger };
// common fields
if ("issue_number" in event) {
essential.issue_number = event.issue_number;
}
if ("branch" in event && event.branch) {
essential.branch = event.branch;
}
// // common fields
// if ("issue_number" in event) {
// essential.issue_number = event.issue_number;
// }
// if ("branch" in event && event.branch) {
// essential.branch = event.branch;
// }
// trigger-specific fields
switch (trigger) {
case "issue_comment_created":
if ("comment_id" in event) essential.comment_id = event.comment_id;
if ("comment_body" in event) essential.comment_body = event.comment_body;
// include issue title/body if available in context (but not the entire context object)
if ("context" in event && event.context && typeof event.context === "object") {
const ctx = event.context as Record<string, unknown>;
if (ctx.issue && typeof ctx.issue === "object") {
const issue = ctx.issue as Record<string, unknown>;
if (issue.title) essential.issue_title = issue.title;
if (issue.body) essential.issue_body = issue.body;
}
}
break;
// // trigger-specific fields
// switch (trigger) {
// case "issue_comment_created":
// if ("comment_id" in event) essential.comment_id = event.comment_id;
// if ("comment_body" in event) essential.comment_body = event.comment_body;
// // include issue title/body if available in context (but not the entire context object)
// if ("context" in event && event.context && typeof event.context === "object") {
// const ctx = event.context as Record<string, unknown>;
// if (ctx.issue && typeof ctx.issue === "object") {
// const issue = ctx.issue as Record<string, unknown>;
// if (issue.title) essential.issue_title = issue.title;
// if (issue.body) essential.issue_body = issue.body;
// }
// }
// break;
case "issues_opened":
case "issues_assigned":
case "issues_labeled":
if ("issue_title" in event) essential.issue_title = event.issue_title;
if ("issue_body" in event) essential.issue_body = event.issue_body;
break;
// case "issues_opened":
// case "issues_assigned":
// case "issues_labeled":
// if ("issue_title" in event) essential.issue_title = event.issue_title;
// if ("issue_body" in event) essential.issue_body = event.issue_body;
// break;
case "pull_request_opened":
case "pull_request_review_requested":
if ("pr_title" in event) essential.pr_title = event.pr_title;
if ("pr_body" in event) essential.pr_body = event.pr_body;
if ("branch" in event) essential.branch = event.branch;
break;
// case "pull_request_opened":
// case "pull_request_review_requested":
// if ("pr_title" in event) essential.pr_title = event.pr_title;
// if ("pr_body" in event) essential.pr_body = event.pr_body;
// if ("branch" in event) essential.branch = event.branch;
// break;
case "pull_request_review_submitted":
if ("review_id" in event) essential.review_id = event.review_id;
if ("review_body" in event) essential.review_body = event.review_body;
if ("review_state" in event) essential.review_state = event.review_state;
if ("branch" in event) essential.branch = event.branch;
break;
// case "pull_request_review_submitted":
// if ("review_id" in event) essential.review_id = event.review_id;
// if ("review_body" in event) essential.review_body = event.review_body;
// if ("review_state" in event) essential.review_state = event.review_state;
// if ("branch" in event) essential.branch = event.branch;
// break;
case "pull_request_review_comment_created":
if ("comment_id" in event) essential.comment_id = event.comment_id;
if ("comment_body" in event) essential.comment_body = event.comment_body;
if ("pr_title" in event) essential.pr_title = event.pr_title;
if ("branch" in event) essential.branch = event.branch;
break;
// case "pull_request_review_comment_created":
// if ("comment_id" in event) essential.comment_id = event.comment_id;
// if ("comment_body" in event) essential.comment_body = event.comment_body;
// if ("pr_title" in event) essential.pr_title = event.pr_title;
// if ("branch" in event) essential.branch = event.branch;
// break;
case "check_suite_completed":
if ("pr_title" in event) essential.pr_title = event.pr_title;
if ("pr_body" in event) essential.pr_body = event.pr_body;
if ("branch" in event) essential.branch = event.branch;
if ("check_suite" in event) {
essential.check_suite = {
id: event.check_suite.id,
head_sha: event.check_suite.head_sha,
head_branch: event.check_suite.head_branch,
status: event.check_suite.status,
conclusion: event.check_suite.conclusion,
};
}
break;
// case "check_suite_completed":
// if ("pr_title" in event) essential.pr_title = event.pr_title;
// if ("pr_body" in event) essential.pr_body = event.pr_body;
// if ("branch" in event) essential.branch = event.branch;
// if ("check_suite" in event) {
// essential.check_suite = {
// id: event.check_suite.id,
// head_sha: event.check_suite.head_sha,
// head_branch: event.check_suite.head_branch,
// status: event.check_suite.status,
// conclusion: event.check_suite.conclusion,
// };
// }
// break;
case "workflow_dispatch":
if ("inputs" in event) essential.inputs = event.inputs;
break;
}
// case "workflow_dispatch":
// if ("inputs" in event) essential.inputs = event.inputs;
// break;
// }
return essential;
}
// return essential;
// }
export const addInstructions = (payload: Payload) => {
let encodedEvent = "";
@@ -95,8 +95,8 @@ export const addInstructions = (payload: Payload) => {
// no meaningful event data to encode
} else {
// extract only essential fields to reduce token usage
const essentialEvent = extractEssentialEventData(payload.event);
encodedEvent = toonEncode(essentialEvent);
// const essentialEvent = payload.event;
encodedEvent = toonEncode(payload.event);
}
return `
@@ -168,7 +168,7 @@ MCP servers provide tools you can call. Inspect your available MCP servers at st
Tool names may be formatted as \`(server name)/(tool name)\`, for example: \`${ghPullfrogMcpName}/create_issue_comment\`
**GitHub CLI prohibition**: Do not use the \`gh\` CLI under any circumstances. Use the corresponding tool from ${ghPullfrogMcpName} instead.
**GitHub CLI**: Prefer using MCP tools from ${ghPullfrogMcpName} for GitHub operations. The \`gh\` CLI is available as a fallback if needed, but MCP tools handle authentication and provide better integration.
**Git operations**: All git operations must use ${ghPullfrogMcpName} MCP tools to ensure proper authentication and commit attribution. Do NOT use git commands directly (e.g., \`git commit\`, \`git push\`, \`git checkout\`, \`git branch\`) - these will use incorrect credentials and attribute commits to the wrong author.
+118 -153
View File
@@ -39511,7 +39511,7 @@ async function reportProgress({ body }) {
}
const issueNumber = ctx.payload.event.issue_number;
if (issueNumber === void 0) {
throw new Error("cannot create progress comment: no issue_number found in the payload event");
return void 0;
}
const result = await ctx.octokit.rest.issues.createComment({
owner: ctx.owner,
@@ -39679,6 +39679,12 @@ var init_comment = __esm({
parameters: ReportProgress,
execute: contextualize(async ({ body }) => {
const result = await reportProgress({ body });
if (!result) {
return {
success: false,
message: "cannot create progress comment: no issue_number found in the payload event. this may occur for workflow_dispatch events or when there is no associated issue/PR. if you need to comment on a specific issue or PR, use create_issue_comment with an explicit issueNumber."
};
}
return {
success: true,
...result
@@ -97443,7 +97449,7 @@ function query({
// package.json
var package_default = {
name: "@pullfrog/action",
version: "0.0.136",
version: "0.0.139",
type: "module",
files: [
"index.js",
@@ -97972,7 +97978,7 @@ ${disableProgressComment ? "" : `
prompt: `Follow these steps:
1. Get PR info with ${ghPullfrogMcpName}/get_pull_request (this automatically prepares the repository by fetching and checking out the PR branch)
2. View diff: \`git diff origin/<base>...origin/<head>\` (replace <base> and <head> with 'base' and 'head' from PR info)
2. **IMPORTANT**: After calling ${ghPullfrogMcpName}/get_pull_request, the PR branch is already checked out locally. View diff using: \`git diff origin/<base>...HEAD\` (replace <base> with 'base' from PR info). Do NOT use \`origin/<head>\` - the branch is checked out locally, not as a remote tracking branch.
3. Read files from the checked-out PR branch to understand the implementation. Always use **relative paths** from repo root (e.g., \`src/index.ts\`), never absolute paths.
@@ -98034,79 +98040,12 @@ ${disableProgressComment ? "" : `
var modes = getModes({ disableProgressComment: void 0 });
// agents/instructions.ts
function extractEssentialEventData(event) {
const trigger = event.trigger;
const essential = { trigger };
if ("issue_number" in event) {
essential.issue_number = event.issue_number;
}
if ("branch" in event && event.branch) {
essential.branch = event.branch;
}
switch (trigger) {
case "issue_comment_created":
if ("comment_id" in event) essential.comment_id = event.comment_id;
if ("comment_body" in event) essential.comment_body = event.comment_body;
if ("context" in event && event.context && typeof event.context === "object") {
const ctx = event.context;
if (ctx.issue && typeof ctx.issue === "object") {
const issue2 = ctx.issue;
if (issue2.title) essential.issue_title = issue2.title;
if (issue2.body) essential.issue_body = issue2.body;
}
}
break;
case "issues_opened":
case "issues_assigned":
case "issues_labeled":
if ("issue_title" in event) essential.issue_title = event.issue_title;
if ("issue_body" in event) essential.issue_body = event.issue_body;
break;
case "pull_request_opened":
case "pull_request_review_requested":
if ("pr_title" in event) essential.pr_title = event.pr_title;
if ("pr_body" in event) essential.pr_body = event.pr_body;
if ("branch" in event) essential.branch = event.branch;
break;
case "pull_request_review_submitted":
if ("review_id" in event) essential.review_id = event.review_id;
if ("review_body" in event) essential.review_body = event.review_body;
if ("review_state" in event) essential.review_state = event.review_state;
if ("branch" in event) essential.branch = event.branch;
break;
case "pull_request_review_comment_created":
if ("comment_id" in event) essential.comment_id = event.comment_id;
if ("comment_body" in event) essential.comment_body = event.comment_body;
if ("pr_title" in event) essential.pr_title = event.pr_title;
if ("branch" in event) essential.branch = event.branch;
break;
case "check_suite_completed":
if ("pr_title" in event) essential.pr_title = event.pr_title;
if ("pr_body" in event) essential.pr_body = event.pr_body;
if ("branch" in event) essential.branch = event.branch;
if ("check_suite" in event) {
essential.check_suite = {
id: event.check_suite.id,
head_sha: event.check_suite.head_sha,
head_branch: event.check_suite.head_branch,
status: event.check_suite.status,
conclusion: event.check_suite.conclusion
};
}
break;
case "workflow_dispatch":
if ("inputs" in event) essential.inputs = event.inputs;
break;
}
return essential;
}
var addInstructions = (payload) => {
let encodedEvent = "";
const eventKeys = Object.keys(payload.event);
if (eventKeys.length === 1 && eventKeys[0] === "trigger") {
} else {
const essentialEvent = extractEssentialEventData(payload.event);
encodedEvent = encode(essentialEvent);
encodedEvent = encode(payload.event);
}
return `
***********************************************
@@ -98177,7 +98116,7 @@ MCP servers provide tools you can call. Inspect your available MCP servers at st
Tool names may be formatted as \`(server name)/(tool name)\`, for example: \`${ghPullfrogMcpName}/create_issue_comment\`
**GitHub CLI prohibition**: Do not use the \`gh\` CLI under any circumstances. Use the corresponding tool from ${ghPullfrogMcpName} instead.
**GitHub CLI**: Prefer using MCP tools from ${ghPullfrogMcpName} for GitHub operations. The \`gh\` CLI is available as a fallback if needed, but MCP tools handle authentication and provide better integration.
**Git operations**: All git operations must use ${ghPullfrogMcpName} MCP tools to ensure proper authentication and commit attribution. Do NOT use git commands directly (e.g., \`git commit\`, \`git push\`, \`git checkout\`, \`git branch\`) - these will use incorrect credentials and attribute commits to the wrong author.
@@ -124300,7 +124239,8 @@ function $(cmd, args3, options) {
const result = spawnSync4(cmd, args3, {
stdio: ["ignore", "pipe", "pipe"],
encoding,
cwd: options?.cwd
cwd: options?.cwd,
env: options?.env ? { ...process.env, ...options.env } : void 0
});
const stdout = result.stdout ?? "";
const stderr = result.stderr ?? "";
@@ -124785,14 +124725,13 @@ var PullRequestTool = tool({
// mcp/prInfo.ts
init_out4();
init_cli();
init_shared3();
var PullRequestInfo = type({
pull_number: type.number.describe("The pull request number to fetch")
});
var PullRequestInfoTool = tool({
name: "get_pull_request",
description: "Retrieve PR information and automatically prepare the repository for review by fetching and checking out the PR branch.",
description: "Retrieve PR information (metadata only). PR branch is already checked out during setup.",
parameters: PullRequestInfo,
execute: contextualize(async ({ pull_number }, ctx) => {
const pr = await ctx.octokit.rest.pulls.get({
@@ -124801,17 +124740,7 @@ var PullRequestInfoTool = tool({
pull_number
});
const data = pr.data;
const baseBranch = data.base.ref;
const headBranch = data.head.ref;
if (!baseBranch) {
throw new Error(`Base branch not found for PR #${pull_number}`);
}
log.info(`Fetching base branch: origin/${baseBranch}`);
$("git", ["fetch", "origin", baseBranch, "--depth=20"]);
log.info(`Fetching PR #${pull_number} using refs/pull/${pull_number}/head`);
$("git", ["fetch", "origin", `refs/pull/${pull_number}/head`]);
log.info(`Checking out PR branch: ${headBranch}`);
$("git", ["checkout", "-B", headBranch, "FETCH_HEAD"]);
const isFork = data.head.repo.full_name !== data.base.repo.full_name;
return {
number: data.number,
url: data.html_url,
@@ -124819,8 +124748,9 @@ var PullRequestInfoTool = tool({
state: data.state,
draft: data.draft,
merged: data.merged,
base: baseBranch,
head: headBranch
base: data.base.ref,
head: data.head.ref,
isFork
};
})
});
@@ -124918,41 +124848,108 @@ var ReviewTool = tool({
// mcp/reviewComments.ts
init_out4();
init_shared3();
var REVIEW_THREADS_QUERY = `
query ($owner: String!, $repo: String!, $pullNumber: Int!) {
repository(owner: $owner, name: $repo) {
pullRequest(number: $pullNumber) {
reviewThreads(first: 100) {
nodes {
comments(first: 100) {
nodes {
id
databaseId
body
path
line
startLine
diffSide
startSide
url
author {
login
}
createdAt
updatedAt
pullRequestReview {
databaseId
}
replyTo {
databaseId
}
}
}
}
}
}
}
}
`;
var GetReviewComments = type({
pull_number: type.number.describe("The pull request number"),
review_id: type.number.describe("The review ID to get comments for")
});
var GetReviewCommentsTool = tool({
name: "get_review_comments",
description: "Get all review comments for a specific pull request review. Returns line-by-line comments that were left on specific code locations.",
description: "Get all review comments and their replies for a specific pull request review. Returns line-by-line comments that were left on specific code locations, including any threaded replies.",
parameters: GetReviewComments,
execute: contextualize(async ({ pull_number, review_id }, ctx) => {
const comments = await ctx.octokit.paginate(ctx.octokit.rest.pulls.listCommentsForReview, {
const response = await ctx.octokit.graphql(REVIEW_THREADS_QUERY, {
owner: ctx.owner,
repo: ctx.name,
pull_number,
review_id
pullNumber: pull_number
});
const pullRequest = response.repository?.pullRequest;
if (!pullRequest) {
return {
review_id,
pull_number,
comments: [],
count: 0
};
}
const threadNodes = pullRequest.reviewThreads?.nodes;
if (!threadNodes) {
return {
review_id,
pull_number,
comments: [],
count: 0
};
}
const allComments = [];
for (const thread of threadNodes) {
if (!thread?.comments?.nodes) continue;
const threadComments = thread.comments.nodes.filter(
(c) => c !== null
);
if (threadComments.length === 0) continue;
const rootComment = threadComments.find((c) => c.replyTo === null);
if (!rootComment) continue;
const threadBelongsToReview = rootComment.pullRequestReview?.databaseId === review_id;
if (!threadBelongsToReview) continue;
for (const comment of threadComments) {
allComments.push({
id: comment.databaseId,
body: comment.body,
path: comment.path,
line: comment.line,
start_line: comment.startLine,
side: comment.diffSide,
start_side: comment.startSide,
user: comment.author?.login ?? null,
created_at: comment.createdAt,
updated_at: comment.updatedAt,
html_url: comment.url,
in_reply_to_id: comment.replyTo?.databaseId ?? null,
pull_request_review_id: comment.pullRequestReview?.databaseId ?? null
});
}
}
return {
review_id,
pull_number,
comments: comments.map((comment) => ({
id: comment.id,
body: comment.body,
path: comment.path,
line: comment.line,
side: comment.side,
start_line: comment.start_line,
start_side: comment.start_side,
user: typeof comment.user === "string" ? comment.user : comment.user?.login,
created_at: comment.created_at,
updated_at: comment.updated_at,
html_url: comment.html_url,
in_reply_to_id: comment.in_reply_to_id,
diff_hunk: comment.diff_hunk,
reactions: comment.reactions
})),
count: comments.length
comments: allComments,
count: allComments.length
};
})
});
@@ -125159,6 +125156,7 @@ init_github();
// utils/setup.ts
import { execSync } from "node:child_process";
init_cli();
init_github();
function setupGitConfig() {
const repoDir = process.cwd();
log.info("\u{1F527} Setting up git configuration...");
@@ -125195,52 +125193,19 @@ function setupGitAuth(ctx) {
log.info("\u2713 Updated remote URL with authentication token (scoped to repo)");
}
function setupGitBranch(payload) {
const branch = payload.event.branch;
const repoDir = process.cwd();
if (!branch) {
log.debug("No branch specified in payload, using default branch");
if (payload.event.is_pr !== true || !payload.event.issue_number) {
log.debug("Not a PR event, staying on default branch");
return;
}
log.info(`\u{1F33F} Setting up git branch: ${branch}`);
const issueNumber = "issue_number" in payload.event ? payload.event.issue_number : void 0;
const isLikelyPR = issueNumber !== void 0 && branch !== void 0;
if (isLikelyPR) {
try {
log.debug(`Fetching PR #${issueNumber} using refs/pull/${issueNumber}/head`);
execSync(`git fetch origin refs/pull/${issueNumber}/head`, {
cwd: repoDir,
stdio: "pipe"
});
log.debug(`Checking out branch: ${branch}`);
execSync(`git checkout -B ${branch} FETCH_HEAD`, {
cwd: repoDir,
stdio: "pipe"
});
log.info(`\u2713 Successfully checked out PR branch: ${branch}`);
return;
} catch (error41) {
log.debug(
`PR ref fetch failed, falling back to branch name fetch: ${error41 instanceof Error ? error41.message : String(error41)}`
);
}
}
try {
log.debug(`Fetching branch from origin: ${branch}`);
execSync(`git fetch origin ${branch}`, {
cwd: repoDir,
stdio: "pipe"
});
log.debug(`Checking out branch: ${branch}`);
execSync(`git checkout -B ${branch} origin/${branch}`, {
cwd: repoDir,
stdio: "pipe"
});
log.info(`\u2713 Successfully checked out branch: ${branch}`);
} catch (error41) {
log.warning(
`Failed to checkout branch ${branch}: ${error41 instanceof Error ? error41.message : String(error41)}`
);
}
const prNumber = payload.event.issue_number;
const repoDir = process.cwd();
log.info(`\u{1F33F} Checking out PR #${prNumber}...`);
const token = getGitHubInstallationToken();
$("gh", ["pr", "checkout", prNumber.toString()], {
cwd: repoDir,
env: { GH_TOKEN: token }
});
log.info(`\u2713 Successfully checked out PR #${prNumber}`);
}
// utils/timer.ts
+161 -108
View File
@@ -51,117 +51,170 @@ export const AgentName = type.enumerated(...Object.keys(agentsManifest));
export type AgentApiKeyName = (typeof agentsManifest)[AgentName]["apiKeyNames"][number];
// base interface for common payload event fields
interface BasePayloadEvent {
issue_number?: number;
is_pr?: boolean;
branch?: string;
pr_title?: string;
pr_body?: string | null;
issue_title?: string;
issue_body?: string | null;
comment_id?: number;
comment_body?: string;
review_id?: number;
review_body?: string | null;
review_state?: string;
review_comments?: any[];
context?: any;
thread?: any;
pull_request?: any;
check_suite?: {
id: number;
head_sha: string;
head_branch: string | null;
status: string | null;
conclusion: string | null;
url: string;
};
comment_ids?: number[] | "all";
[key: string]: any;
}
interface PullRequestOpenedEvent extends BasePayloadEvent {
trigger: "pull_request_opened";
issue_number: number;
is_pr: true;
pr_title: string;
pr_body: string | null;
branch: string;
}
interface PullRequestReadyForReviewEvent extends BasePayloadEvent {
trigger: "pull_request_ready_for_review";
issue_number: number;
is_pr: true;
pr_title: string;
pr_body: string | null;
branch: string;
}
interface PullRequestReviewRequestedEvent extends BasePayloadEvent {
trigger: "pull_request_review_requested";
issue_number: number;
is_pr: true;
pr_title: string;
pr_body: string | null;
branch: string;
}
interface PullRequestReviewSubmittedEvent extends BasePayloadEvent {
trigger: "pull_request_review_submitted";
issue_number: number;
is_pr: true;
review_id: number;
review_body: string | null;
review_state: string;
review_comments: any[];
context: any;
branch: string;
}
interface PullRequestReviewCommentCreatedEvent extends BasePayloadEvent {
trigger: "pull_request_review_comment_created";
issue_number: number;
is_pr: true;
pr_title: string;
comment_id: number;
comment_body: string;
thread?: any;
branch: string;
}
interface IssuesOpenedEvent extends BasePayloadEvent {
trigger: "issues_opened";
issue_number: number;
issue_title: string;
issue_body: string | null;
}
interface IssuesAssignedEvent extends BasePayloadEvent {
trigger: "issues_assigned";
issue_number: number;
issue_title: string;
issue_body: string | null;
}
interface IssuesLabeledEvent extends BasePayloadEvent {
trigger: "issues_labeled";
issue_number: number;
issue_title: string;
issue_body: string | null;
}
interface IssueCommentCreatedEvent extends BasePayloadEvent {
trigger: "issue_comment_created";
comment_id: number;
comment_body: string;
issue_number: number;
// PR-specific fields (only present when is_pr is true)
is_pr?: true;
branch?: string;
pr_title?: string;
pr_body?: string | null;
}
interface CheckSuiteCompletedEvent extends BasePayloadEvent {
trigger: "check_suite_completed";
issue_number: number;
is_pr: true;
pr_title: string;
pr_body: string | null;
pull_request: any;
branch: string;
check_suite: {
id: number;
head_sha: string;
head_branch: string | null;
status: string | null;
conclusion: string | null;
url: string;
};
}
interface WorkflowDispatchEvent extends BasePayloadEvent {
trigger: "workflow_dispatch";
}
interface FixReviewEvent extends BasePayloadEvent {
trigger: "fix_review";
issue_number: number;
is_pr: true;
review_id: number;
/** "all" to fix all comments, or specific comment IDs to fix */
comment_ids: number[] | "all";
}
interface UnknownEvent extends BasePayloadEvent {
trigger: "unknown";
}
// discriminated union for payload event based on trigger
// note: all events use issue_number for consistency (PRs are issues in GitHub's API)
export type PayloadEvent =
| {
trigger: "pull_request_opened";
issue_number: number;
pr_title: string;
pr_body: string | null;
branch: string;
[key: string]: any;
}
| {
trigger: "pull_request_ready_for_review";
issue_number: number;
pr_title: string;
pr_body: string | null;
branch: string;
[key: string]: any;
}
| {
trigger: "pull_request_review_requested";
issue_number: number;
pr_title: string;
pr_body: string | null;
branch: string;
[key: string]: any;
}
| {
trigger: "pull_request_review_submitted";
issue_number: number;
review_id: number;
review_body: string | null;
review_state: string;
review_comments: any[];
context: any;
branch: string;
[key: string]: any;
}
| {
trigger: "pull_request_review_comment_created";
issue_number: number;
pr_title: string;
comment_id: number;
comment_body: string;
thread?: any;
branch: string;
[key: string]: any;
}
| {
trigger: "issues_opened";
issue_number: number;
issue_title: string;
issue_body: string | null;
[key: string]: any;
}
| {
trigger: "issues_assigned";
issue_number: number;
issue_title: string;
issue_body: string | null;
[key: string]: any;
}
| {
trigger: "issues_labeled";
issue_number: number;
issue_title: string;
issue_body: string | null;
[key: string]: any;
}
| {
trigger: "issue_comment_created";
comment_id: number;
comment_body: string;
issue_number: number;
branch?: string;
[key: string]: any;
}
| {
trigger: "check_suite_completed";
issue_number: number;
pr_title: string;
pr_body: string | null;
pull_request: any;
branch: string;
check_suite: {
id: number;
head_sha: string;
head_branch: string | null;
status: string | null;
conclusion: string | null;
url: string;
};
[key: string]: any;
}
| {
trigger: "workflow_dispatch";
[key: string]: any;
}
| {
trigger: "fix_review";
issue_number: number;
review_id: number;
/** "all" to fix all comments, or specific comment IDs to fix */
comment_ids: number[] | "all";
branch: string;
[key: string]: any;
}
| {
trigger: "unknown";
[key: string]: any;
};
| PullRequestOpenedEvent
| PullRequestReadyForReviewEvent
| PullRequestReviewRequestedEvent
| PullRequestReviewSubmittedEvent
| PullRequestReviewCommentCreatedEvent
| IssuesOpenedEvent
| IssuesAssignedEvent
| IssuesLabeledEvent
| IssueCommentCreatedEvent
| CheckSuiteCompletedEvent
| WorkflowDispatchEvent
| FixReviewEvent
| UnknownEvent;
export interface DispatchOptions {
/**
+4 -4
View File
@@ -30,7 +30,7 @@ await mcp.call("gh_pullfrog/get_check_suite_logs", {
### review tools
#### `get_review_comments`
get all line-by-line comments for a specific pull request review.
get all line-by-line comments and their replies for a specific pull request review.
**parameters:**
- `pull_number` (number): the pull request number
@@ -39,11 +39,11 @@ get all line-by-line comments for a specific pull request review.
**replaces:** `gh api repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments`
**returns:**
array of review comments including:
array of review comments including threaded replies:
- file path, line number, comment body
- side (LEFT/RIGHT) and position in diff
- user, timestamps, html_url
- in_reply_to_id for threaded comments
- in_reply_to_id for threaded comments (replies have this set to the parent comment id)
**example:**
```typescript
@@ -111,7 +111,7 @@ see individual files for documentation on other tools:
## usage in agents
agents should never use the `gh` cli. instead, they should use the mcp tools provided by this server.
agents should prefer using the mcp tools provided by this server. the `gh` cli is available as a fallback if needed, but mcp tools handle authentication and provide better integration.
the agent instructions automatically include guidance on using these tools.
+12 -1
View File
@@ -177,7 +177,8 @@ export async function reportProgress({ body }: { body: string }): Promise<
// no existing comment - create one
const issueNumber = ctx.payload.event.issue_number;
if (issueNumber === undefined) {
throw new Error("cannot create progress comment: no issue_number found in the payload event");
// cannot create comment without issue_number (e.g., workflow_dispatch events)
return undefined;
}
const result = await ctx.octokit.rest.issues.createComment({
@@ -207,6 +208,16 @@ export const ReportProgressTool = tool({
execute: contextualize(async ({ body }) => {
const result = await reportProgress({ body });
if (!result) {
// gracefully handle case where no comment can be created
// this happens for workflow_dispatch events or when there's no associated issue/PR
return {
success: false,
message:
"cannot create progress comment: no issue_number found in the payload event. this may occur for workflow_dispatch events or when there is no associated issue/PR. if you need to comment on a specific issue or PR, use create_issue_comment with an explicit issueNumber.",
};
}
return {
success: true,
...result,
+6 -24
View File
@@ -1,6 +1,4 @@
import { type } from "arktype";
import { log } from "../utils/cli.ts";
import { $ } from "../utils/shell.ts";
import { contextualize, tool } from "./shared.ts";
export const PullRequestInfo = type({
@@ -10,7 +8,7 @@ export const PullRequestInfo = type({
export const PullRequestInfoTool = tool({
name: "get_pull_request",
description:
"Retrieve PR information and automatically prepare the repository for review by fetching and checking out the PR branch.",
"Retrieve PR information (metadata only). PR branch is already checked out during setup.",
parameters: PullRequestInfo,
execute: contextualize(async ({ pull_number }, ctx) => {
const pr = await ctx.octokit.rest.pulls.get({
@@ -21,25 +19,8 @@ export const PullRequestInfoTool = tool({
const data = pr.data;
const baseBranch = data.base.ref;
const headBranch = data.head.ref;
if (!baseBranch) {
throw new Error(`Base branch not found for PR #${pull_number}`);
}
// Automatically fetch and checkout branches for review
log.info(`Fetching base branch: origin/${baseBranch}`);
$("git", ["fetch", "origin", baseBranch, "--depth=20"]);
// use GitHub's PR ref which works for both fork and non-fork PRs
// refs/pull/{number}/head always points to the PR head commit
log.info(`Fetching PR #${pull_number} using refs/pull/${pull_number}/head`);
$("git", ["fetch", "origin", `refs/pull/${pull_number}/head`]);
log.info(`Checking out PR branch: ${headBranch}`);
// check out a local branch from FETCH_HEAD (the PR ref we just fetched)
$("git", ["checkout", "-B", headBranch, "FETCH_HEAD"]);
// detect fork PRs - head repo differs from base repo
const isFork = data.head.repo.full_name !== data.base.repo.full_name;
return {
number: data.number,
@@ -48,8 +29,9 @@ export const PullRequestInfoTool = tool({
state: data.state,
draft: data.draft,
merged: data.merged,
base: baseBranch,
head: headBranch,
base: data.base.ref,
head: data.head.ref,
isFork,
};
}),
});
+158 -21
View File
@@ -1,6 +1,84 @@
import { type } from "arktype";
import { contextualize, tool } from "./shared.ts";
// graphql query to fetch all review threads with comments and replies
const REVIEW_THREADS_QUERY = `
query ($owner: String!, $repo: String!, $pullNumber: Int!) {
repository(owner: $owner, name: $repo) {
pullRequest(number: $pullNumber) {
reviewThreads(first: 100) {
nodes {
comments(first: 100) {
nodes {
id
databaseId
body
path
line
startLine
diffSide
startSide
url
author {
login
}
createdAt
updatedAt
pullRequestReview {
databaseId
}
replyTo {
databaseId
}
}
}
}
}
}
}
}
`;
// graphql response types (nodes arrays can contain nulls per GitHub GraphQL spec)
type GraphQLReviewComment = {
id: string;
databaseId: number;
body: string;
path: string;
line: number | null;
startLine: number | null;
diffSide: "LEFT" | "RIGHT";
startSide: "LEFT" | "RIGHT" | null;
url: string;
author: {
login: string;
} | null;
createdAt: string;
updatedAt: string;
pullRequestReview: {
databaseId: number;
} | null;
replyTo: {
databaseId: number;
} | null;
};
type GraphQLReviewThread = {
comments: {
nodes: (GraphQLReviewComment | null)[] | null;
} | null;
};
type GraphQLResponse = {
repository: {
pullRequest: {
reviewThreads: {
nodes: (GraphQLReviewThread | null)[] | null;
} | null;
} | null;
} | null;
};
export const GetReviewComments = type({
pull_number: type.number.describe("The pull request number"),
review_id: type.number.describe("The review ID to get comments for"),
@@ -9,36 +87,95 @@ export const GetReviewComments = type({
export const GetReviewCommentsTool = tool({
name: "get_review_comments",
description:
"Get all review comments for a specific pull request review. Returns line-by-line comments that were left on specific code locations.",
"Get all review comments and their replies for a specific pull request review. Returns line-by-line comments that were left on specific code locations, including any threaded replies.",
parameters: GetReviewComments,
execute: contextualize(async ({ pull_number, review_id }, ctx) => {
const comments = await ctx.octokit.paginate(ctx.octokit.rest.pulls.listCommentsForReview, {
// fetch all review threads using graphql
const response = await ctx.octokit.graphql<GraphQLResponse>(REVIEW_THREADS_QUERY, {
owner: ctx.owner,
repo: ctx.name,
pull_number,
review_id,
pullNumber: pull_number,
});
const pullRequest = response.repository?.pullRequest;
if (!pullRequest) {
return {
review_id,
pull_number,
comments: [],
count: 0,
};
}
const threadNodes = pullRequest.reviewThreads?.nodes;
if (!threadNodes) {
return {
review_id,
pull_number,
comments: [],
count: 0,
};
}
const allComments: {
id: number;
body: string;
path: string;
line: number | null;
side: "LEFT" | "RIGHT";
start_line: number | null;
start_side: "LEFT" | "RIGHT" | null;
user: string | null;
created_at: string;
updated_at: string;
html_url: string;
in_reply_to_id: number | null;
pull_request_review_id: number | null;
}[] = [];
// iterate through all threads (filter out nulls)
for (const thread of threadNodes) {
if (!thread?.comments?.nodes) continue;
// filter out null comments
const threadComments = thread.comments.nodes.filter(
(c): c is GraphQLReviewComment => c !== null
);
if (threadComments.length === 0) continue;
// find the root comment (the one with replyTo == null) to determine thread ownership
const rootComment = threadComments.find((c) => c.replyTo === null);
if (!rootComment) continue;
// check if this thread belongs to the target review using the root comment
const threadBelongsToReview = rootComment.pullRequestReview?.databaseId === review_id;
if (!threadBelongsToReview) continue;
// include all comments from this thread (original + replies)
for (const comment of threadComments) {
allComments.push({
id: comment.databaseId,
body: comment.body,
path: comment.path,
line: comment.line,
start_line: comment.startLine,
side: comment.diffSide,
start_side: comment.startSide,
user: comment.author?.login ?? null,
created_at: comment.createdAt,
updated_at: comment.updatedAt,
html_url: comment.url,
in_reply_to_id: comment.replyTo?.databaseId ?? null,
pull_request_review_id: comment.pullRequestReview?.databaseId ?? null,
});
}
}
return {
review_id,
pull_number,
comments: comments.map((comment) => ({
id: comment.id,
body: comment.body,
path: comment.path,
line: comment.line,
side: comment.side,
start_line: comment.start_line,
start_side: comment.start_side,
user: typeof comment.user === "string" ? comment.user : comment.user?.login,
created_at: comment.created_at,
updated_at: comment.updated_at,
html_url: comment.html_url,
in_reply_to_id: comment.in_reply_to_id,
diff_hunk: comment.diff_hunk,
reactions: comment.reactions,
})),
count: comments.length,
comments: allComments,
count: allComments.length,
};
}),
});
+1 -1
View File
@@ -85,7 +85,7 @@ ${
prompt: `Follow these steps:
1. Get PR info with ${ghPullfrogMcpName}/get_pull_request (this automatically prepares the repository by fetching and checking out the PR branch)
2. View diff: \`git diff origin/<base>...origin/<head>\` (replace <base> and <head> with 'base' and 'head' from PR info)
2. **IMPORTANT**: After calling ${ghPullfrogMcpName}/get_pull_request, the PR branch is already checked out locally. View diff using: \`git diff origin/<base>...HEAD\` (replace <base> with 'base' from PR info). Do NOT use \`origin/<head>\` - the branch is checked out locally, not as a remote tracking branch.
3. Read files from the checked-out PR branch to understand the implementation. Always use **relative paths** from repo root (e.g., \`src/index.ts\`), never absolute paths.
+1 -1
View File
@@ -1,6 +1,6 @@
{
"name": "@pullfrog/action",
"version": "0.0.136",
"version": "0.0.139",
"type": "module",
"files": [
"index.js",
+17 -60
View File
@@ -2,7 +2,7 @@ import { execSync } from "node:child_process";
import { existsSync, rmSync } from "node:fs";
import type { Payload } from "../external.ts";
import { log } from "./cli.ts";
import type { RepoContext } from "./github.ts";
import { getGitHubInstallationToken, type RepoContext } from "./github.ts";
import { $ } from "./shell.ts";
export interface SetupOptions {
@@ -95,71 +95,28 @@ export function setupGitAuth(ctx: {
}
/**
* Setup git branch based on payload event context
* Automatically checks out the appropriate branch before agent execution
* Setup git branch based on payload event context.
* For PR events, uses `gh pr checkout` which handles fork PRs automatically.
* For non-PR events, stays on the default branch.
*/
export function setupGitBranch(payload: Payload): void {
const branch = payload.event.branch;
const repoDir = process.cwd();
if (!branch) {
log.debug("No branch specified in payload, using default branch");
// only checkout for PR events - use issue_number directly (no dependency on branch field)
if (payload.event.is_pr !== true || !payload.event.issue_number) {
log.debug("Not a PR event, staying on default branch");
return;
}
log.info(`🌿 Setting up git branch: ${branch}`);
const prNumber = payload.event.issue_number;
const repoDir = process.cwd();
// if event has issue_number and branch, it's likely a PR - try PR ref first (works for forks)
const issueNumber = "issue_number" in payload.event ? payload.event.issue_number : undefined;
const isLikelyPR = issueNumber !== undefined && branch !== undefined;
log.info(`🌿 Checking out PR #${prNumber}...`);
if (isLikelyPR) {
try {
// use GitHub's PR ref which works for both fork and non-fork PRs
log.debug(`Fetching PR #${issueNumber} using refs/pull/${issueNumber}/head`);
execSync(`git fetch origin refs/pull/${issueNumber}/head`, {
cwd: repoDir,
stdio: "pipe",
});
// gh pr checkout handles fork PRs by setting up remotes automatically
const token = getGitHubInstallationToken();
$("gh", ["pr", "checkout", prNumber.toString()], {
cwd: repoDir,
env: { GH_TOKEN: token },
});
// checkout from FETCH_HEAD (the PR ref we just fetched)
log.debug(`Checking out branch: ${branch}`);
execSync(`git checkout -B ${branch} FETCH_HEAD`, {
cwd: repoDir,
stdio: "pipe",
});
log.info(`✓ Successfully checked out PR branch: ${branch}`);
return;
} catch (error) {
// if PR ref fetch fails, fall back to branch name fetch
log.debug(
`PR ref fetch failed, falling back to branch name fetch: ${error instanceof Error ? error.message : String(error)}`
);
}
}
// fallback: fetch by branch name (for non-PR contexts or if PR ref fetch failed)
try {
log.debug(`Fetching branch from origin: ${branch}`);
execSync(`git fetch origin ${branch}`, {
cwd: repoDir,
stdio: "pipe",
});
// checkout the branch, creating local tracking branch
log.debug(`Checking out branch: ${branch}`);
execSync(`git checkout -B ${branch} origin/${branch}`, {
cwd: repoDir,
stdio: "pipe",
});
log.info(`✓ Successfully checked out branch: ${branch}`);
} catch (error) {
// if git operations fail, log warning but don't fail the action
// the agent might still be able to work with the default branch
log.warning(
`Failed to checkout branch ${branch}: ${error instanceof Error ? error.message : String(error)}`
);
}
log.info(`✓ Successfully checked out PR #${prNumber}`);
}
+2
View File
@@ -14,6 +14,7 @@ interface ShellOptions {
| "ucs2"
| "utf16le";
log?: boolean;
env?: Record<string, string>;
onError?: (result: { status: number; stdout: string; stderr: string }) => void;
}
@@ -36,6 +37,7 @@ export function $(cmd: string, args: string[], options?: ShellOptions): string {
stdio: ["ignore", "pipe", "pipe"],
encoding,
cwd: options?.cwd,
env: options?.env ? { ...process.env, ...options.env } : undefined,
});
const stdout = result.stdout ?? "";