feat: add base_branch input to specify source branch for new Claude branches (#72)
* feat: add base_branch input to specify source branch for new Claude branches - Add base_branch input parameter to action.yml allowing users to specify which branch to use as source - Update setupBranch function to accept and use the base branch parameter - Defaults to repository default branch if no base branch is specified - Addresses issue #62 for better branch control Co-authored-by: ashwin-ant <ashwin-ant@users.noreply.github.com> * perf: optimize setupBranch to avoid unnecessary default branch fetch Only fetch repository default branch when actually needed: - Skip initial fetch when baseBranch is provided - Fetch default branch at end only for return value and GitHub Actions output - Eliminates unnecessary API call when users specify base branch Co-authored-by: ashwin-ant <ashwin-ant@users.noreply.github.com> * fix: properly handle base branch throughout the action workflow - Fix TypeScript error where defaultBranch was used before being assigned - Replace DEFAULT_BRANCH with BASE_BRANCH in subsequent workflow steps - Update PR creation and branch comparison to use the actual base branch - Ensure custom base_branch input is respected in all operations 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> * refactor: move BASE_BRANCH env reading into parseGitHubContext - 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> --------- Co-authored-by: claude[bot] <209825114+claude[bot]@users.noreply.github.com> Co-authored-by: ashwin-ant <ashwin-ant@users.noreply.github.com> Co-authored-by: Claude <noreply@anthropic.com>
This commit is contained in:
@@ -86,7 +86,7 @@ export function buildDisallowedToolsString(
|
||||
export function prepareContext(
|
||||
context: ParsedGitHubContext,
|
||||
claudeCommentId: string,
|
||||
defaultBranch?: string,
|
||||
baseBranch?: string,
|
||||
claudeBranch?: string,
|
||||
): PreparedContext {
|
||||
const repository = context.repository.full_name;
|
||||
@@ -164,7 +164,7 @@ export function prepareContext(
|
||||
...(commentId && { commentId }),
|
||||
commentBody,
|
||||
...(claudeBranch && { claudeBranch }),
|
||||
...(defaultBranch && { defaultBranch }),
|
||||
...(baseBranch && { baseBranch }),
|
||||
};
|
||||
break;
|
||||
|
||||
@@ -186,7 +186,7 @@ export function prepareContext(
|
||||
prNumber,
|
||||
commentBody,
|
||||
...(claudeBranch && { claudeBranch }),
|
||||
...(defaultBranch && { defaultBranch }),
|
||||
...(baseBranch && { baseBranch }),
|
||||
};
|
||||
break;
|
||||
|
||||
@@ -211,13 +211,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",
|
||||
@@ -229,7 +229,7 @@ export function prepareContext(
|
||||
commentId,
|
||||
isPR: false,
|
||||
claudeBranch: claudeBranch,
|
||||
defaultBranch,
|
||||
baseBranch,
|
||||
issueNumber,
|
||||
commentBody,
|
||||
};
|
||||
@@ -245,8 +245,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");
|
||||
@@ -263,7 +263,7 @@ export function prepareContext(
|
||||
eventAction: "assigned",
|
||||
isPR: false,
|
||||
issueNumber,
|
||||
defaultBranch,
|
||||
baseBranch,
|
||||
claudeBranch,
|
||||
assigneeTrigger,
|
||||
};
|
||||
@@ -273,7 +273,7 @@ export function prepareContext(
|
||||
eventAction: "opened",
|
||||
isPR: false,
|
||||
issueNumber,
|
||||
defaultBranch,
|
||||
baseBranch,
|
||||
claudeBranch,
|
||||
};
|
||||
} else {
|
||||
@@ -294,7 +294,7 @@ export function prepareContext(
|
||||
isPR: true,
|
||||
prNumber,
|
||||
...(claudeBranch && { claudeBranch }),
|
||||
...(defaultBranch && { defaultBranch }),
|
||||
...(baseBranch && { baseBranch }),
|
||||
};
|
||||
break;
|
||||
|
||||
@@ -541,13 +541,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
|
||||
@@ -632,7 +632,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,
|
||||
@@ -641,7 +641,7 @@ export async function createPrompt(
|
||||
const preparedContext = prepareContext(
|
||||
context,
|
||||
claudeCommentId.toString(),
|
||||
defaultBranch,
|
||||
baseBranch,
|
||||
claudeBranch,
|
||||
);
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -77,7 +77,7 @@ async function run() {
|
||||
// Step 10: Create prompt file
|
||||
await createPrompt(
|
||||
commentId,
|
||||
branchInfo.defaultBranch,
|
||||
branchInfo.baseBranch,
|
||||
branchInfo.claudeBranch,
|
||||
githubData,
|
||||
context,
|
||||
|
||||
@@ -18,7 +18,7 @@ async function run() {
|
||||
const commentId = parseInt(process.env.CLAUDE_COMMENT_ID!);
|
||||
const githubToken = process.env.GITHUB_TOKEN!;
|
||||
const claudeBranch = process.env.CLAUDE_BRANCH;
|
||||
const defaultBranch = process.env.DEFAULT_BRANCH || "main";
|
||||
const baseBranch = process.env.BASE_BRANCH || "main";
|
||||
const triggerUsername = process.env.TRIGGER_USERNAME;
|
||||
|
||||
const context = parseGitHubContext();
|
||||
@@ -92,7 +92,7 @@ async function run() {
|
||||
owner,
|
||||
repo,
|
||||
claudeBranch,
|
||||
defaultBranch,
|
||||
baseBranch,
|
||||
);
|
||||
|
||||
// Check if we need to add PR URL when we have a new branch
|
||||
@@ -102,7 +102,7 @@ async function run() {
|
||||
// Check if comment already contains a PR URL
|
||||
const serverUrlPattern = serverUrl.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
|
||||
const prUrlPattern = new RegExp(
|
||||
`${serverUrlPattern}\\/.+\\/compare\\/${defaultBranch.replace(/[.*+?^${}()|[\]\\]/g, "\\$&")}\\.\\.\\.`,
|
||||
`${serverUrlPattern}\\/.+\\/compare\\/${baseBranch.replace(/[.*+?^${}()|[\]\\]/g, "\\$&")}\\.\\.\\.`,
|
||||
);
|
||||
const containsPRUrl = currentBody.match(prUrlPattern);
|
||||
|
||||
@@ -113,7 +113,7 @@ async function run() {
|
||||
await octokit.rest.repos.compareCommitsWithBasehead({
|
||||
owner,
|
||||
repo,
|
||||
basehead: `${defaultBranch}...${claudeBranch}`,
|
||||
basehead: `${baseBranch}...${claudeBranch}`,
|
||||
});
|
||||
|
||||
// If there are changes (commits or file changes), add the PR URL
|
||||
@@ -128,7 +128,7 @@ async function run() {
|
||||
const prBody = encodeURIComponent(
|
||||
`This PR addresses ${entityType.toLowerCase()} #${context.entityNumber}\n\nGenerated with [Claude Code](https://claude.ai/code)`,
|
||||
);
|
||||
const prUrl = `${serverUrl}/${owner}/${repo}/compare/${defaultBranch}...${claudeBranch}?quick_pull=1&title=${prTitle}&body=${prBody}`;
|
||||
const prUrl = `${serverUrl}/${owner}/${repo}/compare/${baseBranch}...${claudeBranch}?quick_pull=1&title=${prTitle}&body=${prBody}`;
|
||||
prLink = `\n[Create a PR](${prUrl})`;
|
||||
}
|
||||
} catch (error) {
|
||||
|
||||
@@ -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,
|
||||
},
|
||||
};
|
||||
|
||||
|
||||
@@ -6,7 +6,7 @@ export async function checkAndDeleteEmptyBranch(
|
||||
owner: string,
|
||||
repo: string,
|
||||
claudeBranch: string | undefined,
|
||||
defaultBranch: string,
|
||||
baseBranch: string,
|
||||
): Promise<{ shouldDeleteBranch: boolean; branchLink: string }> {
|
||||
let branchLink = "";
|
||||
let shouldDeleteBranch = false;
|
||||
@@ -18,7 +18,7 @@ export async function checkAndDeleteEmptyBranch(
|
||||
await octokit.rest.repos.compareCommitsWithBasehead({
|
||||
owner,
|
||||
repo,
|
||||
basehead: `${defaultBranch}...${claudeBranch}`,
|
||||
basehead: `${baseBranch}...${claudeBranch}`,
|
||||
});
|
||||
|
||||
// If there are no commits, mark branch for deletion
|
||||
|
||||
@@ -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;
|
||||
};
|
||||
@@ -26,15 +26,9 @@ export async function setupBranch(
|
||||
): Promise<BranchInfo> {
|
||||
const { owner, repo } = context.repository;
|
||||
const entityNumber = context.entityNumber;
|
||||
const { baseBranch } = context.inputs;
|
||||
const isPR = context.isPR;
|
||||
|
||||
// Get the default branch first
|
||||
const repoResponse = await octokits.rest.repos.get({
|
||||
owner,
|
||||
repo,
|
||||
});
|
||||
const defaultBranch = repoResponse.data.default_branch;
|
||||
|
||||
if (isPR) {
|
||||
const prData = githubData.contextData as GitHubPullRequest;
|
||||
const prState = prData.state;
|
||||
@@ -42,7 +36,7 @@ export async function setupBranch(
|
||||
// Check if PR is closed or merged
|
||||
if (prState === "CLOSED" || prState === "MERGED") {
|
||||
console.log(
|
||||
`PR #${entityNumber} is ${prState}, creating new branch from default...`,
|
||||
`PR #${entityNumber} is ${prState}, creating new branch from source...`,
|
||||
);
|
||||
// Fall through to create a new branch like we do for issues
|
||||
} else {
|
||||
@@ -58,17 +52,36 @@ export async function setupBranch(
|
||||
|
||||
console.log(`Successfully checked out PR branch for PR #${entityNumber}`);
|
||||
|
||||
// For open PRs, return branch info
|
||||
// For open PRs, we need to get the base branch of the PR
|
||||
const baseBranch = prData.baseRefName;
|
||||
|
||||
return {
|
||||
defaultBranch,
|
||||
baseBranch,
|
||||
currentBranch: branchName,
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
// Determine source branch - use baseBranch if provided, otherwise fetch default
|
||||
let sourceBranch: string;
|
||||
|
||||
if (baseBranch) {
|
||||
// Use provided base branch for source
|
||||
sourceBranch = baseBranch;
|
||||
} else {
|
||||
// No base branch provided, fetch the default branch to use as source
|
||||
const repoResponse = await octokits.rest.repos.get({
|
||||
owner,
|
||||
repo,
|
||||
});
|
||||
sourceBranch = repoResponse.data.default_branch;
|
||||
}
|
||||
|
||||
// Creating a new branch for either an issue or closed/merged PR
|
||||
const entityType = isPR ? "pr" : "issue";
|
||||
console.log(`Creating new branch for ${entityType} #${entityNumber}...`);
|
||||
console.log(
|
||||
`Creating new branch for ${entityType} #${entityNumber} from source branch: ${sourceBranch}...`,
|
||||
);
|
||||
|
||||
const timestamp = new Date()
|
||||
.toISOString()
|
||||
@@ -80,14 +93,14 @@ export async function setupBranch(
|
||||
const newBranch = `claude/${entityType}-${entityNumber}-${timestamp}`;
|
||||
|
||||
try {
|
||||
// Get the SHA of the default branch
|
||||
const defaultBranchRef = await octokits.rest.git.getRef({
|
||||
// Get the SHA of the source branch
|
||||
const sourceBranchRef = await octokits.rest.git.getRef({
|
||||
owner,
|
||||
repo,
|
||||
ref: `heads/${defaultBranch}`,
|
||||
ref: `heads/${sourceBranch}`,
|
||||
});
|
||||
|
||||
const currentSHA = defaultBranchRef.data.object.sha;
|
||||
const currentSHA = sourceBranchRef.data.object.sha;
|
||||
|
||||
console.log(`Current SHA: ${currentSHA}`);
|
||||
|
||||
@@ -109,9 +122,9 @@ export async function setupBranch(
|
||||
|
||||
// Set outputs for GitHub Actions
|
||||
core.setOutput("CLAUDE_BRANCH", newBranch);
|
||||
core.setOutput("DEFAULT_BRANCH", defaultBranch);
|
||||
core.setOutput("BASE_BRANCH", sourceBranch);
|
||||
return {
|
||||
defaultBranch,
|
||||
baseBranch: sourceBranch,
|
||||
claudeBranch: newBranch,
|
||||
currentBranch: newBranch,
|
||||
};
|
||||
|
||||
Reference in New Issue
Block a user