anthropics/claude-code-action
1
0
Fork 0
mirror of https://github.com/anthropics/claude-code-action.git synced 2026-01-23 06:54:13 +08:00
Code Issues Packages Projects Releases Wiki Activity

refactor: move BASE_BRANCH env reading into parseGitHubContext

Browse Source 
- Move BASE_BRANCH environment variable reading into parseGitHubContext for consistency
- Update setupBranch to use context.inputs.baseBranch instead of process.env
- Fix test descriptions to correctly reference BASE_BRANCH instead of DEFAULT_BRANCH
- Update test environment setup to use BASE_BRANCH

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
Ashwin Bhat
2025-05-28 21:37:58 -07:00
parent aa82b5b5ac
commit 5c04112174
7 changed files with 57 additions and 77 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
src/create-prompt/index.ts
View File

@@ -69,7 +69,7 @@ export function buildDisallowedToolsString(
export function prepareContext(
context: ParsedGitHubContext,
claudeCommentId: string,
defaultBranch?: string,
baseBranch?: string,
claudeBranch?: string,
): PreparedContext {
const repository = context.repository.full_name;
@@ -147,7 +147,7 @@ export function prepareContext(
...(commentId && { commentId }),
commentBody,
...(claudeBranch && { claudeBranch }),
...(defaultBranch && { defaultBranch }),
...(baseBranch && { baseBranch }),
};
break;
@@ -169,7 +169,7 @@ export function prepareContext(
prNumber,
commentBody,
...(claudeBranch && { claudeBranch }),
...(defaultBranch && { defaultBranch }),
...(baseBranch && { baseBranch }),
};
break;
@@ -194,13 +194,13 @@ export function prepareContext(
prNumber,
commentBody,
...(claudeBranch && { claudeBranch }),
...(defaultBranch && { defaultBranch }),
...(baseBranch && { baseBranch }),
};
break;
} else if (!claudeBranch) {
throw new Error("CLAUDE_BRANCH is required for issue_comment event");
} else if (!defaultBranch) {
throw new Error("DEFAULT_BRANCH is required for issue_comment event");
} else if (!baseBranch) {
throw new Error("BASE_BRANCH is required for issue_comment event");
} else if (!issueNumber) {
throw new Error(
"ISSUE_NUMBER is required for issue_comment event for issues",
@@ -212,7 +212,7 @@ export function prepareContext(
commentId,
isPR: false,
claudeBranch: claudeBranch,
defaultBranch,
baseBranch,
issueNumber,
commentBody,
};
@@ -228,8 +228,8 @@ export function prepareContext(
if (isPR) {
throw new Error("IS_PR must be false for issues event");
}
if (!defaultBranch) {
throw new Error("DEFAULT_BRANCH is required for issues event");
if (!baseBranch) {
throw new Error("BASE_BRANCH is required for issues event");
}
if (!claudeBranch) {
throw new Error("CLAUDE_BRANCH is required for issues event");
@@ -246,7 +246,7 @@ export function prepareContext(
eventAction: "assigned",
isPR: false,
issueNumber,
defaultBranch,
baseBranch,
claudeBranch,
assigneeTrigger,
};
@@ -256,7 +256,7 @@ export function prepareContext(
eventAction: "opened",
isPR: false,
issueNumber,
defaultBranch,
baseBranch,
claudeBranch,
};
} else {
@@ -277,7 +277,7 @@ export function prepareContext(
isPR: true,
prNumber,
...(claudeBranch && { claudeBranch }),
...(defaultBranch && { defaultBranch }),
...(baseBranch && { baseBranch }),
};
break;
@@ -524,13 +524,13 @@ ${context.directPrompt ? ` - DIRECT INSTRUCTION: A direct instruction was prov
${
eventData.claudeBranch
? `- Provide a URL to create a PR manually in this format:
[Create a PR](${GITHUB_SERVER_URL}/${context.repository}/compare/${eventData.defaultBranch}...<branch-name>?quick_pull=1&title=<url-encoded-title>&body=<url-encoded-body>)
[Create a PR](${GITHUB_SERVER_URL}/${context.repository}/compare/${eventData.baseBranch}...<branch-name>?quick_pull=1&title=<url-encoded-title>&body=<url-encoded-body>)
- IMPORTANT: Use THREE dots (...) between branch names, not two (..)
Example: ${GITHUB_SERVER_URL}/${context.repository}/compare/main...feature-branch (correct)
NOT: ${GITHUB_SERVER_URL}/${context.repository}/compare/main..feature-branch (incorrect)
- IMPORTANT: Ensure all URL parameters are properly encoded - spaces should be encoded as %20, not left as spaces
Example: Instead of "fix: update welcome message", use "fix%3A%20update%20welcome%20message"
- The target-branch should be '${eventData.defaultBranch}'.
- The target-branch should be '${eventData.baseBranch}'.
- The branch-name is the current branch: ${eventData.claudeBranch}
- The body should include:
- A clear description of the changes
@@ -615,7 +615,7 @@ f. If you are unable to complete certain steps, such as running a linter or test
export async function createPrompt(
claudeCommentId: number,
defaultBranch: string | undefined,
baseBranch: string | undefined,
claudeBranch: string | undefined,
githubData: FetchDataResult,
context: ParsedGitHubContext,
@@ -624,7 +624,7 @@ export async function createPrompt(
const preparedContext = prepareContext(
context,
claudeCommentId.toString(),
defaultBranch,
baseBranch,
claudeBranch,
);

14
src/create-prompt/types.ts
View File

@@ -16,7 +16,7 @@ type PullRequestReviewCommentEvent = {
commentId?: string; // May be present for review comments
commentBody: string;
claudeBranch?: string;
defaultBranch?: string;
baseBranch?: string;
};
type PullRequestReviewEvent = {
@@ -25,7 +25,7 @@ type PullRequestReviewEvent = {
prNumber: string;
commentBody: string;
claudeBranch?: string;
defaultBranch?: string;
baseBranch?: string;
};
type IssueCommentEvent = {
@@ -33,7 +33,7 @@ type IssueCommentEvent = {
commentId: string;
issueNumber: string;
isPR: false;
defaultBranch: string;
baseBranch: string;
claudeBranch: string;
commentBody: string;
};
@@ -46,7 +46,7 @@ type PullRequestCommentEvent = {
isPR: true;
commentBody: string;
claudeBranch?: string;
defaultBranch?: string;
baseBranch?: string;
};
type IssueOpenedEvent = {
@@ -54,7 +54,7 @@ type IssueOpenedEvent = {
eventAction: "opened";
isPR: false;
issueNumber: string;
defaultBranch: string;
baseBranch: string;
claudeBranch: string;
};
@@ -63,7 +63,7 @@ type IssueAssignedEvent = {
eventAction: "assigned";
isPR: false;
issueNumber: string;
defaultBranch: string;
baseBranch: string;
claudeBranch: string;
assigneeTrigger: string;
};
@@ -74,7 +74,7 @@ type PullRequestEvent = {
isPR: true;
prNumber: string;
claudeBranch?: string;
defaultBranch?: string;
baseBranch?: string;
};
// Union type for all possible event types

10
src/entrypoints/prepare.ts
View File

@@ -62,13 +62,7 @@ async function run() {
});
// Step 8: Setup branch
const baseBranch = process.env.BASE_BRANCH;
const branchInfo = await setupBranch(
octokit,
githubData,
context,
baseBranch,
);
const branchInfo = await setupBranch(octokit, githubData, context);
// Step 9: Update initial comment with branch link (only for issues that created a new branch)
if (branchInfo.claudeBranch) {
@@ -83,7 +77,7 @@ async function run() {
// Step 10: Create prompt file
await createPrompt(
commentId,
branchInfo.defaultBranch,
branchInfo.baseBranch,
branchInfo.claudeBranch,
githubData,
context,

2
src/github/context.ts
View File

@@ -32,6 +32,7 @@ export type ParsedGitHubContext = {
disallowedTools: string;
customInstructions: string;
directPrompt: string;
baseBranch?: string;
};
};
@@ -55,6 +56,7 @@ export function parseGitHubContext(): ParsedGitHubContext {
disallowedTools: process.env.DISALLOWED_TOOLS ?? "",
customInstructions: process.env.CUSTOM_INSTRUCTIONS ?? "",
directPrompt: process.env.DIRECT_PROMPT ?? "",
baseBranch: process.env.BASE_BRANCH,
},
};

30
src/github/operations/branch.ts
View File

@@ -14,7 +14,7 @@ import type { Octokits } from "../api/client";
import type { FetchDataResult } from "../data/fetcher";
export type BranchInfo = {
defaultBranch: string;
baseBranch: string;
claudeBranch?: string;
currentBranch: string;
};
@@ -23,10 +23,10 @@ export async function setupBranch(
octokits: Octokits,
githubData: FetchDataResult,
context: ParsedGitHubContext,
baseBranch?: string,
): Promise<BranchInfo> {
const { owner, repo } = context.repository;
const entityNumber = context.entityNumber;
const { baseBranch } = context.inputs;
const isPR = context.isPR;
if (isPR) {
@@ -51,15 +51,11 @@ export async function setupBranch(
console.log(`Successfully checked out PR branch for PR #${entityNumber}`);
// For open PRs, we need the actual default branch for the return value
const repoResponse = await octokits.rest.repos.get({
owner,
repo,
});
const defaultBranch = repoResponse.data.default_branch;
// For open PRs, we need to get the base branch of the PR
const baseBranch = prData.baseRefName;
return {
defaultBranch,
baseBranch,
currentBranch: branchName,
};
}
@@ -67,20 +63,17 @@ export async function setupBranch(
// Determine source branch - use baseBranch if provided, otherwise fetch default
let sourceBranch: string;
let defaultBranch: string | undefined;
if (baseBranch) {
// Use provided base branch for source
sourceBranch = baseBranch;
// We'll fetch default branch later only when needed for return/output
} else {
// No base branch provided, fetch the default branch to use as source
const repoResponse = await octokits.rest.repos.get({
owner,
repo,
});
defaultBranch = repoResponse.data.default_branch;
sourceBranch = defaultBranch;
sourceBranch = repoResponse.data.default_branch;
}
// Creating a new branch for either an issue or closed/merged PR
@@ -126,20 +119,11 @@ export async function setupBranch(
`Successfully created and checked out new branch: ${newBranch}`,
);
// Fetch default branch only now if we haven't already (when baseBranch was provided)
if (!defaultBranch) {
const repoResponse = await octokits.rest.repos.get({
owner,
repo,
});
defaultBranch = repoResponse.data.default_branch;
}
// Set outputs for GitHub Actions
core.setOutput("CLAUDE_BRANCH", newBranch);
core.setOutput("BASE_BRANCH", sourceBranch);
return {
defaultBranch,
baseBranch: sourceBranch,
claudeBranch: newBranch,
currentBranch: newBranch,
};

28
test/create-prompt.test.ts
View File

@@ -127,7 +127,7 @@ describe("generatePrompt", () => {
eventName: "issue_comment",
commentId: "67890",
isPR: false,
defaultBranch: "main",
baseBranch: "main",
claudeBranch: "claude/issue-67890-20240101_120000",
issueNumber: "67890",
commentBody: "@claude please fix this",
@@ -183,7 +183,7 @@ describe("generatePrompt", () => {
eventAction: "opened",
isPR: false,
issueNumber: "789",
defaultBranch: "main",
baseBranch: "main",
claudeBranch: "claude/issue-789-20240101_120000",
},
};
@@ -210,7 +210,7 @@ describe("generatePrompt", () => {
eventAction: "assigned",
isPR: false,
issueNumber: "999",
defaultBranch: "develop",
baseBranch: "develop",
claudeBranch: "claude/issue-999-20240101_120000",
assigneeTrigger: "claude-bot",
},
@@ -238,7 +238,7 @@ describe("generatePrompt", () => {
eventAction: "opened",
isPR: false,
issueNumber: "789",
defaultBranch: "main",
baseBranch: "main",
claudeBranch: "claude/issue-789-20240101_120000",
},
};
@@ -285,7 +285,7 @@ describe("generatePrompt", () => {
commentId: "67890",
isPR: false,
issueNumber: "123",
defaultBranch: "main",
baseBranch: "main",
claudeBranch: "claude/issue-67890-20240101_120000",
commentBody: "@claude please fix this",
},
@@ -307,7 +307,7 @@ describe("generatePrompt", () => {
commentId: "67890",
isPR: false,
issueNumber: "123",
defaultBranch: "main",
baseBranch: "main",
claudeBranch: "claude/issue-67890-20240101_120000",
commentBody: "@claude please fix this",
},
@@ -362,7 +362,7 @@ describe("generatePrompt", () => {
eventAction: "opened",
isPR: false,
issueNumber: "789",
defaultBranch: "main",
baseBranch: "main",
claudeBranch: "claude/issue-789-20240101_120000",
},
};
@@ -400,7 +400,7 @@ describe("generatePrompt", () => {
commentId: "67890",
isPR: false,
issueNumber: "123",
defaultBranch: "main",
baseBranch: "main",
claudeBranch: "claude/issue-123-20240101_120000",
commentBody: "@claude please fix this",
},
@@ -432,7 +432,7 @@ describe("generatePrompt", () => {
prNumber: "456",
commentBody: "@claude please fix this",
claudeBranch: "claude/pr-456-20240101_120000",
defaultBranch: "main",
baseBranch: "main",
},
};
@@ -470,7 +470,7 @@ describe("generatePrompt", () => {
isPR: true,
prNumber: "456",
commentBody: "@claude please fix this",
// No claudeBranch or defaultBranch for open PRs
// No claudeBranch or baseBranch for open PRs
},
};
@@ -503,7 +503,7 @@ describe("generatePrompt", () => {
prNumber: "789",
commentBody: "@claude please update this",
claudeBranch: "claude/pr-789-20240101_123000",
defaultBranch: "develop",
baseBranch: "develop",
},
};
@@ -531,7 +531,7 @@ describe("generatePrompt", () => {
commentId: "review-comment-123",
commentBody: "@claude fix this issue",
claudeBranch: "claude/pr-999-20240101_140000",
defaultBranch: "main",
baseBranch: "main",
},
};
@@ -559,7 +559,7 @@ describe("generatePrompt", () => {
isPR: true,
prNumber: "555",
claudeBranch: "claude/pr-555-20240101_150000",
defaultBranch: "main",
baseBranch: "main",
},
};
@@ -604,7 +604,7 @@ describe("getEventTypeAndContext", () => {
eventAction: "assigned",
isPR: false,
issueNumber: "999",
defaultBranch: "main",
baseBranch: "main",
claudeBranch: "claude/issue-999-20240101_120000",
assigneeTrigger: "claude-bot",
},

18
test/prepare-context.test.ts
View File

@@ -34,7 +34,7 @@ describe("parseEnvVarsWithContext", () => {
beforeEach(() => {
process.env = {
...BASE_ENV,
DEFAULT_BRANCH: "main",
BASE_BRANCH: "main",
CLAUDE_BRANCH: "claude/issue-67890-20240101_120000",
};
});
@@ -62,7 +62,7 @@ describe("parseEnvVarsWithContext", () => {
expect(result.eventData.claudeBranch).toBe(
"claude/issue-67890-20240101_120000",
);
expect(result.eventData.defaultBranch).toBe("main");
expect(result.eventData.baseBranch).toBe("main");
expect(result.eventData.commentBody).toBe(
"@claude can you help explain how to configure the logging system?",
);
@@ -75,7 +75,7 @@ describe("parseEnvVarsWithContext", () => {
).toThrow("CLAUDE_BRANCH is required for issue_comment event");
});
test("should throw error when DEFAULT_BRANCH is missing", () => {
test("should throw error when BASE_BRANCH is missing", () => {
expect(() =>
prepareContext(
mockIssueCommentContext,
@@ -83,7 +83,7 @@ describe("parseEnvVarsWithContext", () => {
undefined,
"claude/issue-67890-20240101_120000",
),
).toThrow("DEFAULT_BRANCH is required for issue_comment event");
).toThrow("BASE_BRANCH is required for issue_comment event");
});
});
@@ -151,7 +151,7 @@ describe("parseEnvVarsWithContext", () => {
beforeEach(() => {
process.env = {
...BASE_ENV,
DEFAULT_BRANCH: "main",
BASE_BRANCH: "main",
CLAUDE_BRANCH: "claude/issue-42-20240101_120000",
};
});
@@ -172,7 +172,7 @@ describe("parseEnvVarsWithContext", () => {
result.eventData.eventAction === "opened"
) {
expect(result.eventData.issueNumber).toBe("42");
expect(result.eventData.defaultBranch).toBe("main");
expect(result.eventData.baseBranch).toBe("main");
expect(result.eventData.claudeBranch).toBe(
"claude/issue-42-20240101_120000",
);
@@ -195,7 +195,7 @@ describe("parseEnvVarsWithContext", () => {
result.eventData.eventAction === "assigned"
) {
expect(result.eventData.issueNumber).toBe("123");
expect(result.eventData.defaultBranch).toBe("main");
expect(result.eventData.baseBranch).toBe("main");
expect(result.eventData.claudeBranch).toBe(
"claude/issue-123-20240101_120000",
);
@@ -209,7 +209,7 @@ describe("parseEnvVarsWithContext", () => {
).toThrow("CLAUDE_BRANCH is required for issues event");
});
test("should throw error when DEFAULT_BRANCH is missing for issues", () => {
test("should throw error when BASE_BRANCH is missing for issues", () => {
expect(() =>
prepareContext(
mockIssueOpenedContext,
@@ -217,7 +217,7 @@ describe("parseEnvVarsWithContext", () => {
undefined,
"claude/issue-42-20240101_120000",
),
).toThrow("DEFAULT_BRANCH is required for issues event");
).toThrow("BASE_BRANCH is required for issues event");
});
});