feat: support check_suite webhook events

This commit is contained in:
RhenCloud 2026-08-03 06:58:47 +08:00
parent 7179a35457
commit fb9550b94d
No known key found for this signature in database
GPG key ID: A574A617378C4E0B
6 changed files with 115 additions and 2 deletions

View file

@ -150,6 +150,26 @@ describe("message title spec", () => {
expect(msg.fields![0].value).toBe("🔄 running"); expect(msg.fields![0].value).toBe("🔄 running");
}); });
it("check_suite shows conclusion, service, branch and commit", () => {
const suite = {
html_url: "https://github.com/acme/widget/runs/2",
conclusion: "success",
status: "completed",
app: { name: "Cloudflare Pages" },
head_branch: "main",
head_sha: "abc123def456",
};
const msg = formatEvent(
route,
event("check_suite", { check_suite: suite, repository: repo, sender }),
);
expect(msg.title).toBe("acme/widget: Check suite success");
expect(msg.fields![0].value).toBe("✅ success");
expect(msg.fields![1].value).toBe("Cloudflare Pages");
expect(msg.fields![2].value).toBe("main");
expect(msg.fields![3].value).toBe("abc123d");
});
it("unknown events fall back to repo: event: action", () => { it("unknown events fall back to repo: event: action", () => {
const msg = formatEvent( const msg = formatEvent(
route, route,

View file

@ -44,6 +44,10 @@ function extractBranch(event: WebhookEvent): string | undefined {
const wf = event.payload.workflow_run as { head_branch?: string } | undefined; const wf = event.payload.workflow_run as { head_branch?: string } | undefined;
return wf?.head_branch; return wf?.head_branch;
} }
if (event.event === "check_suite") {
const suite = event.payload.check_suite as { head_branch?: string } | undefined;
return suite?.head_branch;
}
if (event.event === "commit_comment") { if (event.event === "commit_comment") {
const comment = event.payload.comment as { position?: number | null } | undefined; const comment = event.payload.comment as { position?: number | null } | undefined;
if (comment?.position != null) { if (comment?.position != null) {

View file

@ -2,6 +2,85 @@ import type { NeutralMessage, NeutralAuthor } from "../types";
import { GITHUB_COLORS, WORKFLOW_CONCLUSION_EMOJI } from "./colors"; import { GITHUB_COLORS, WORKFLOW_CONCLUSION_EMOJI } from "./colors";
import { emojiPrefix, type T, buildMessage } from "./helpers"; import { emojiPrefix, type T, buildMessage } from "./helpers";
export function formatCheckSuite(
payload: Record<string, unknown>,
repo: string | undefined,
author: NeutralAuthor,
t: T,
showEmoji: boolean,
): NeutralMessage {
const suite = payload.check_suite as {
head_branch?: string;
head_sha?: string;
conclusion?: string;
status?: string;
app?: { name?: string };
html_url?: string;
};
const status =
suite.status === "queued"
? "queued"
: suite.status === "in_progress"
? "running"
: (suite.conclusion ?? "pending");
const emoji = WORKFLOW_CONCLUSION_EMOJI[status] ?? "⏳";
const em = (e: string): string => emojiPrefix(e, showEmoji);
const colorKey =
status === "success"
? "check_run_success"
: status === "failure"
? "check_run_failure"
: "check_run_other";
const fields: Array<{ name: string; value: string; inline?: boolean }> = [];
fields.push({
name: t("fields.status"),
value: `${em(emoji)}${status}`,
inline: true,
});
if (suite.app?.name) {
fields.push({
name: t("fields.service"),
value: suite.app.name,
inline: true,
});
}
if (suite.head_branch) {
fields.push({
name: t("fields.branch"),
value: suite.head_branch,
inline: true,
});
}
if (suite.head_sha) {
fields.push({
name: t("fields.commit"),
value: suite.head_sha.slice(0, 7),
inline: true,
});
}
return buildMessage(
{
author,
title: t("events.check_suite.title", {
repo: repo ?? t("common.repository"),
conclusion: status,
}),
url: suite.html_url,
color: GITHUB_COLORS[colorKey],
fields,
},
t,
repo,
);
}
export function formatCheckRun( export function formatCheckRun(
payload: Record<string, unknown>, payload: Record<string, unknown>,
repo: string | undefined, repo: string | undefined,

View file

@ -10,7 +10,7 @@ import { formatWorkflowRun } from "./workflow";
import { formatRelease } from "./release"; import { formatRelease } from "./release";
import { formatCreate, formatDelete } from "./create"; import { formatCreate, formatDelete } from "./create";
import { formatStar, formatFork } from "./repo"; import { formatStar, formatFork } from "./repo";
import { formatCheckRun } from "./check"; import { formatCheckRun, formatCheckSuite } from "./check";
import { formatCommitComment } from "./commit-comment"; import { formatCommitComment } from "./commit-comment";
import { formatDeploymentStatus } from "./deployment"; import { formatDeploymentStatus } from "./deployment";
import { formatMember } from "./member"; import { formatMember } from "./member";
@ -31,7 +31,7 @@ export { formatWorkflowRun } from "./workflow";
export { formatRelease } from "./release"; export { formatRelease } from "./release";
export { formatCreate, formatDelete } from "./create"; export { formatCreate, formatDelete } from "./create";
export { formatStar, formatFork } from "./repo"; export { formatStar, formatFork } from "./repo";
export { formatCheckRun } from "./check"; export { formatCheckRun, formatCheckSuite } from "./check";
export { formatCommitComment } from "./commit-comment"; export { formatCommitComment } from "./commit-comment";
export { formatDeploymentStatus } from "./deployment"; export { formatDeploymentStatus } from "./deployment";
export { formatMember } from "./member"; export { formatMember } from "./member";
@ -89,6 +89,8 @@ export function formatEvent(
return formatFork(payload, repo, repoUrl, author, t, showEmoji); return formatFork(payload, repo, repoUrl, author, t, showEmoji);
case "check_run": case "check_run":
return formatCheckRun(payload, repo, author, t, showEmoji); return formatCheckRun(payload, repo, author, t, showEmoji);
case "check_suite":
return formatCheckSuite(payload, repo, author, t, showEmoji);
case "commit_comment": case "commit_comment":
return formatCommitComment(payload, repo, author, t, showEmoji); return formatCommitComment(payload, repo, author, t, showEmoji);
case "deployment_status": case "deployment_status":

View file

@ -56,6 +56,7 @@ export const en = {
commit: "Commit", commit: "Commit",
environment: "Environment", environment: "Environment",
url: "URL", url: "URL",
service: "Service",
severity: "Severity", severity: "Severity",
rule: "Rule", rule: "Rule",
package: "Package", package: "Package",
@ -128,6 +129,9 @@ export const en = {
check_run: { check_run: {
title: "{repo}: {name} — {conclusion}", title: "{repo}: {name} — {conclusion}",
}, },
check_suite: {
title: "{repo}: Check suite {conclusion}",
},
pr_review: { pr_review: {
action_review: "{emoji}**{action}** review", action_review: "{emoji}**{action}** review",
title: "{repo}#{number}: {title}", title: "{repo}#{number}: {title}",

View file

@ -56,6 +56,7 @@ export const zh = {
commit: "提交", commit: "提交",
environment: "环境", environment: "环境",
url: "链接", url: "链接",
service: "服务",
severity: "严重程度", severity: "严重程度",
rule: "规则", rule: "规则",
package: "包", package: "包",
@ -128,6 +129,9 @@ export const zh = {
check_run: { check_run: {
title: "{repo}: {name} — {conclusion}", title: "{repo}: {name} — {conclusion}",
}, },
check_suite: {
title: "{repo}: 检查套件 {conclusion}",
},
pr_review: { pr_review: {
action_review: "{emoji}**{action}** 审查", action_review: "{emoji}**{action}** 审查",
title: "{repo}#{number}: {title}", title: "{repo}#{number}: {title}",