Add label trigger functionality to Claude Code Action (#177)

- introduced a new input parameter `label_trigger` in `action.yml` to allow triggering actions based on specific labels applied to issues.
- Enhanced the context preparation and event handling in the code to support the new labled event.
This commit is contained in:
Tomohiro Ishibashi
2025-06-26 02:25:26 +09:00
committed by GitHub
parent c831be8f54
commit b0d9b8c4cd
10 changed files with 182 additions and 2 deletions

View File

@@ -49,7 +49,7 @@ on:
pull_request_review_comment: pull_request_review_comment:
types: [created] types: [created]
issues: issues:
types: [opened, assigned] types: [opened, assigned, labeled]
pull_request_review: pull_request_review:
types: [submitted] types: [submitted]
@@ -65,6 +65,8 @@ jobs:
# trigger_phrase: "/claude" # trigger_phrase: "/claude"
# Optional: add assignee trigger for issues # Optional: add assignee trigger for issues
# assignee_trigger: "claude" # assignee_trigger: "claude"
# Optional: add label trigger for issues
# label_trigger: "claude"
# Optional: add custom environment variables (YAML format) # Optional: add custom environment variables (YAML format)
# claude_env: | # claude_env: |
# NODE_ENV: test # NODE_ENV: test
@@ -92,6 +94,7 @@ jobs:
| `custom_instructions` | Additional custom instructions to include in the prompt for Claude | No | "" | | `custom_instructions` | Additional custom instructions to include in the prompt for Claude | No | "" |
| `mcp_config` | Additional MCP configuration (JSON string) that merges with the built-in GitHub MCP servers | No | "" | | `mcp_config` | Additional MCP configuration (JSON string) that merges with the built-in GitHub MCP servers | No | "" |
| `assignee_trigger` | The assignee username that triggers the action (e.g. @claude). Only used for issue assignment | No | - | | `assignee_trigger` | The assignee username that triggers the action (e.g. @claude). Only used for issue assignment | No | - |
| `label_trigger` | The label name that triggers the action when applied to an issue (e.g. "claude") | No | - |
| `trigger_phrase` | The trigger phrase to look for in comments, issue/PR bodies, and issue titles | No | `@claude` | | `trigger_phrase` | The trigger phrase to look for in comments, issue/PR bodies, and issue titles | No | `@claude` |
| `claude_env` | Custom environment variables to pass to Claude Code execution (YAML format) | No | "" | | `claude_env` | Custom environment variables to pass to Claude Code execution (YAML format) | No | "" |

View File

@@ -12,6 +12,10 @@ inputs:
assignee_trigger: assignee_trigger:
description: "The assignee username that triggers the action (e.g. @claude)" description: "The assignee username that triggers the action (e.g. @claude)"
required: false required: false
label_trigger:
description: "The label that triggers the action (e.g. claude)"
required: false
default: "claude"
base_branch: base_branch:
description: "The branch to use as the base/source when creating new branches (defaults to repository default branch)" description: "The branch to use as the base/source when creating new branches (defaults to repository default branch)"
required: false required: false

View File

@@ -81,6 +81,7 @@ export function prepareContext(
const eventAction = context.eventAction; const eventAction = context.eventAction;
const triggerPhrase = context.inputs.triggerPhrase || "@claude"; const triggerPhrase = context.inputs.triggerPhrase || "@claude";
const assigneeTrigger = context.inputs.assigneeTrigger; const assigneeTrigger = context.inputs.assigneeTrigger;
const labelTrigger = context.inputs.labelTrigger;
const customInstructions = context.inputs.customInstructions; const customInstructions = context.inputs.customInstructions;
const allowedTools = context.inputs.allowedTools; const allowedTools = context.inputs.allowedTools;
const disallowedTools = context.inputs.disallowedTools; const disallowedTools = context.inputs.disallowedTools;
@@ -256,6 +257,19 @@ export function prepareContext(
claudeBranch, claudeBranch,
...(assigneeTrigger && { assigneeTrigger }), ...(assigneeTrigger && { assigneeTrigger }),
}; };
} else if (eventAction === "labeled") {
if (!labelTrigger) {
throw new Error("LABEL_TRIGGER is required for issue labeled event");
}
eventData = {
eventName: "issues",
eventAction: "labeled",
isPR: false,
issueNumber,
baseBranch,
claudeBranch,
labelTrigger,
};
} else if (eventAction === "opened") { } else if (eventAction === "opened") {
eventData = { eventData = {
eventName: "issues", eventName: "issues",
@@ -328,6 +342,11 @@ export function getEventTypeAndContext(envVars: PreparedContext): {
eventType: "ISSUE_CREATED", eventType: "ISSUE_CREATED",
triggerContext: `new issue with '${envVars.triggerPhrase}' in body`, triggerContext: `new issue with '${envVars.triggerPhrase}' in body`,
}; };
} else if (eventData.eventAction === "labeled") {
return {
eventType: "ISSUE_LABELED",
triggerContext: `issue labeled with '${eventData.labelTrigger}'`,
};
} }
return { return {
eventType: "ISSUE_ASSIGNED", eventType: "ISSUE_ASSIGNED",
@@ -467,6 +486,7 @@ Follow these steps:
- Analyze the pre-fetched data provided above. - Analyze the pre-fetched data provided above.
- For ISSUE_CREATED: Read the issue body to find the request after the trigger phrase. - For ISSUE_CREATED: Read the issue body to find the request after the trigger phrase.
- For ISSUE_ASSIGNED: Read the entire issue body to understand the task. - For ISSUE_ASSIGNED: Read the entire issue body to understand the task.
- For ISSUE_LABELED: Read the entire issue body to understand the task.
${eventData.eventName === "issue_comment" || eventData.eventName === "pull_request_review_comment" || eventData.eventName === "pull_request_review" ? ` - For comment/review events: Your instructions are in the <trigger_comment> tag above.` : ""} ${eventData.eventName === "issue_comment" || eventData.eventName === "pull_request_review_comment" || eventData.eventName === "pull_request_review" ? ` - For comment/review events: Your instructions are in the <trigger_comment> tag above.` : ""}
${context.directPrompt ? ` - DIRECT INSTRUCTION: A direct instruction was provided and is shown in the <direct_prompt> tag above. This is not from any GitHub comment but a direct instruction to execute.` : ""} ${context.directPrompt ? ` - DIRECT INSTRUCTION: A direct instruction was provided and is shown in the <direct_prompt> tag above. This is not from any GitHub comment but a direct instruction to execute.` : ""}
- IMPORTANT: Only the comment/issue containing '${context.triggerPhrase}' has your instructions. - IMPORTANT: Only the comment/issue containing '${context.triggerPhrase}' has your instructions.

View File

@@ -68,6 +68,16 @@ type IssueAssignedEvent = {
assigneeTrigger?: string; assigneeTrigger?: string;
}; };
type IssueLabeledEvent = {
eventName: "issues";
eventAction: "labeled";
isPR: false;
issueNumber: string;
baseBranch: string;
claudeBranch: string;
labelTrigger: string;
};
type PullRequestEvent = { type PullRequestEvent = {
eventName: "pull_request"; eventName: "pull_request";
eventAction?: string; // opened, synchronize, etc. eventAction?: string; // opened, synchronize, etc.
@@ -85,6 +95,7 @@ export type EventData =
| IssueCommentEvent | IssueCommentEvent
| IssueOpenedEvent | IssueOpenedEvent
| IssueAssignedEvent | IssueAssignedEvent
| IssueLabeledEvent
| PullRequestEvent; | PullRequestEvent;
// Combined type with separate eventData field // Combined type with separate eventData field

View File

@@ -29,6 +29,7 @@ export type ParsedGitHubContext = {
inputs: { inputs: {
triggerPhrase: string; triggerPhrase: string;
assigneeTrigger: string; assigneeTrigger: string;
labelTrigger: string;
allowedTools: string[]; allowedTools: string[];
disallowedTools: string[]; disallowedTools: string[];
customInstructions: string; customInstructions: string;
@@ -53,6 +54,7 @@ export function parseGitHubContext(): ParsedGitHubContext {
inputs: { inputs: {
triggerPhrase: process.env.TRIGGER_PHRASE ?? "@claude", triggerPhrase: process.env.TRIGGER_PHRASE ?? "@claude",
assigneeTrigger: process.env.ASSIGNEE_TRIGGER ?? "", assigneeTrigger: process.env.ASSIGNEE_TRIGGER ?? "",
labelTrigger: process.env.LABEL_TRIGGER ?? "",
allowedTools: parseMultilineInput(process.env.ALLOWED_TOOLS ?? ""), allowedTools: parseMultilineInput(process.env.ALLOWED_TOOLS ?? ""),
disallowedTools: parseMultilineInput(process.env.DISALLOWED_TOOLS ?? ""), disallowedTools: parseMultilineInput(process.env.DISALLOWED_TOOLS ?? ""),
customInstructions: process.env.CUSTOM_INSTRUCTIONS ?? "", customInstructions: process.env.CUSTOM_INSTRUCTIONS ?? "",

View File

@@ -13,7 +13,7 @@ import type { ParsedGitHubContext } from "../context";
export function checkContainsTrigger(context: ParsedGitHubContext): boolean { export function checkContainsTrigger(context: ParsedGitHubContext): boolean {
const { const {
inputs: { assigneeTrigger, triggerPhrase, directPrompt }, inputs: { assigneeTrigger, labelTrigger, triggerPhrase, directPrompt },
} = context; } = context;
// If direct prompt is provided, always trigger // If direct prompt is provided, always trigger
@@ -34,6 +34,16 @@ export function checkContainsTrigger(context: ParsedGitHubContext): boolean {
} }
} }
// Check for label trigger
if (isIssuesEvent(context) && context.eventAction === "labeled") {
const labelName = (context.payload as any).label?.name || "";
if (labelTrigger && labelName === labelTrigger) {
console.log(`Issue labeled with trigger label '${labelTrigger}'`);
return true;
}
}
// Check for issue body and title trigger on issue creation // Check for issue body and title trigger on issue creation
if (isIssuesEvent(context) && context.eventAction === "opened") { if (isIssuesEvent(context) && context.eventAction === "opened") {
const issueBody = context.payload.issue.body || ""; const issueBody = context.payload.issue.body || "";

View File

@@ -226,6 +226,33 @@ describe("generatePrompt", () => {
); );
}); });
test("should generate prompt for issue labeled event", () => {
const envVars: PreparedContext = {
repository: "owner/repo",
claudeCommentId: "12345",
triggerPhrase: "@claude",
eventData: {
eventName: "issues",
eventAction: "labeled",
isPR: false,
issueNumber: "888",
baseBranch: "main",
claudeBranch: "claude/issue-888-20240101_120000",
labelTrigger: "claude-task",
},
};
const prompt = generatePrompt(envVars, mockGitHubData);
expect(prompt).toContain("<event_type>ISSUE_LABELED</event_type>");
expect(prompt).toContain(
"<trigger_context>issue labeled with 'claude-task'</trigger_context>",
);
expect(prompt).toContain(
"[Create a PR](https://github.com/owner/repo/compare/main",
);
});
test("should include direct prompt when provided", () => { test("should include direct prompt when provided", () => {
const envVars: PreparedContext = { const envVars: PreparedContext = {
repository: "owner/repo", repository: "owner/repo",
@@ -615,6 +642,28 @@ describe("getEventTypeAndContext", () => {
expect(result.triggerContext).toBe("issue assigned to 'claude-bot'"); expect(result.triggerContext).toBe("issue assigned to 'claude-bot'");
}); });
test("should return correct type and context for issue labeled", () => {
const envVars: PreparedContext = {
repository: "owner/repo",
claudeCommentId: "12345",
triggerPhrase: "@claude",
eventData: {
eventName: "issues",
eventAction: "labeled",
isPR: false,
issueNumber: "888",
baseBranch: "main",
claudeBranch: "claude/issue-888-20240101_120000",
labelTrigger: "claude-task",
},
};
const result = getEventTypeAndContext(envVars);
expect(result.eventType).toBe("ISSUE_LABELED");
expect(result.triggerContext).toBe("issue labeled with 'claude-task'");
});
test("should return correct type and context for issue assigned without assigneeTrigger", () => { test("should return correct type and context for issue assigned without assigneeTrigger", () => {
const envVars: PreparedContext = { const envVars: PreparedContext = {
repository: "owner/repo", repository: "owner/repo",

View File

@@ -10,6 +10,7 @@ import type {
const defaultInputs = { const defaultInputs = {
triggerPhrase: "/claude", triggerPhrase: "/claude",
assigneeTrigger: "", assigneeTrigger: "",
labelTrigger: "",
anthropicModel: "claude-3-7-sonnet-20250219", anthropicModel: "claude-3-7-sonnet-20250219",
allowedTools: [] as string[], allowedTools: [] as string[],
disallowedTools: [] as string[], disallowedTools: [] as string[],
@@ -128,6 +129,46 @@ export const mockIssueAssignedContext: ParsedGitHubContext = {
inputs: { ...defaultInputs, assigneeTrigger: "@claude-bot" }, inputs: { ...defaultInputs, assigneeTrigger: "@claude-bot" },
}; };
export const mockIssueLabeledContext: ParsedGitHubContext = {
runId: "1234567890",
eventName: "issues",
eventAction: "labeled",
repository: defaultRepository,
actor: "admin-user",
payload: {
action: "labeled",
issue: {
number: 1234,
title: "Enhancement: Improve search functionality",
body: "The current search is too slow and needs optimization",
user: {
login: "alice-wonder",
id: 54321,
avatar_url: "https://avatars.githubusercontent.com/u/54321",
html_url: "https://github.com/alice-wonder",
},
assignee: null,
},
label: {
id: 987654321,
name: "claude-task",
color: "f29513",
description: "Label for Claude AI interactions",
},
repository: {
name: "test-repo",
full_name: "test-owner/test-repo",
private: false,
owner: {
login: "test-owner",
},
},
} as IssuesEvent,
entityNumber: 1234,
isPR: false,
inputs: { ...defaultInputs, labelTrigger: "claude-task" },
};
// Issue comment on issue event // Issue comment on issue event
export const mockIssueCommentContext: ParsedGitHubContext = { export const mockIssueCommentContext: ParsedGitHubContext = {
runId: "1234567890", runId: "1234567890",

View File

@@ -62,6 +62,7 @@ describe("checkWritePermissions", () => {
inputs: { inputs: {
triggerPhrase: "@claude", triggerPhrase: "@claude",
assigneeTrigger: "", assigneeTrigger: "",
labelTrigger: "",
allowedTools: [], allowedTools: [],
disallowedTools: [], disallowedTools: [],
customInstructions: "", customInstructions: "",

View File

@@ -6,6 +6,7 @@ import { describe, it, expect } from "bun:test";
import { import {
createMockContext, createMockContext,
mockIssueAssignedContext, mockIssueAssignedContext,
mockIssueLabeledContext,
mockIssueCommentContext, mockIssueCommentContext,
mockIssueOpenedContext, mockIssueOpenedContext,
mockPullRequestReviewContext, mockPullRequestReviewContext,
@@ -29,6 +30,7 @@ describe("checkContainsTrigger", () => {
inputs: { inputs: {
triggerPhrase: "/claude", triggerPhrase: "/claude",
assigneeTrigger: "", assigneeTrigger: "",
labelTrigger: "",
directPrompt: "Fix the bug in the login form", directPrompt: "Fix the bug in the login form",
allowedTools: [], allowedTools: [],
disallowedTools: [], disallowedTools: [],
@@ -55,6 +57,7 @@ describe("checkContainsTrigger", () => {
inputs: { inputs: {
triggerPhrase: "/claude", triggerPhrase: "/claude",
assigneeTrigger: "", assigneeTrigger: "",
labelTrigger: "",
directPrompt: "", directPrompt: "",
allowedTools: [], allowedTools: [],
disallowedTools: [], disallowedTools: [],
@@ -107,6 +110,39 @@ describe("checkContainsTrigger", () => {
}); });
}); });
describe("label trigger", () => {
it("should return true when issue is labeled with the trigger label", () => {
const context = mockIssueLabeledContext;
expect(checkContainsTrigger(context)).toBe(true);
});
it("should return false when issue is labeled with a different label", () => {
const context = {
...mockIssueLabeledContext,
payload: {
...mockIssueLabeledContext.payload,
label: {
...(mockIssueLabeledContext.payload as any).label,
name: "bug",
},
},
} as ParsedGitHubContext;
expect(checkContainsTrigger(context)).toBe(false);
});
it("should return false for non-labeled events", () => {
const context = {
...mockIssueLabeledContext,
eventAction: "opened",
payload: {
...mockIssueLabeledContext.payload,
action: "opened",
},
} as ParsedGitHubContext;
expect(checkContainsTrigger(context)).toBe(false);
});
});
describe("issue body and title trigger", () => { describe("issue body and title trigger", () => {
it("should return true when issue body contains trigger phrase", () => { it("should return true when issue body contains trigger phrase", () => {
const context = mockIssueOpenedContext; const context = mockIssueOpenedContext;
@@ -232,6 +268,7 @@ describe("checkContainsTrigger", () => {
inputs: { inputs: {
triggerPhrase: "@claude", triggerPhrase: "@claude",
assigneeTrigger: "", assigneeTrigger: "",
labelTrigger: "",
directPrompt: "", directPrompt: "",
allowedTools: [], allowedTools: [],
disallowedTools: [], disallowedTools: [],
@@ -259,6 +296,7 @@ describe("checkContainsTrigger", () => {
inputs: { inputs: {
triggerPhrase: "@claude", triggerPhrase: "@claude",
assigneeTrigger: "", assigneeTrigger: "",
labelTrigger: "",
directPrompt: "", directPrompt: "",
allowedTools: [], allowedTools: [],
disallowedTools: [], disallowedTools: [],
@@ -286,6 +324,7 @@ describe("checkContainsTrigger", () => {
inputs: { inputs: {
triggerPhrase: "@claude", triggerPhrase: "@claude",
assigneeTrigger: "", assigneeTrigger: "",
labelTrigger: "",
directPrompt: "", directPrompt: "",
allowedTools: [], allowedTools: [],
disallowedTools: [], disallowedTools: [],