Skip to content

[Fix] Link review gate Details to the workflow run #2204

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
edelauna merged 2 commits into from
Oct 27, 2026
Merged

[Fix] Link review gate Details to the workflow run #2204

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1b14b68
fix: link review gate to workflow details
Aug 31, 2026
e1a29c0
test: cover changed review gate links
Aug 31, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .github/workflows/label-pr-review-state.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -319,6 +319,7 @@ jobs:
const communityApprovedLabel = 'community-approved';
const reviewGateName = 'Zoo Code / PR review gate';
const reconciliationCheckName = 'Zoo Code / reconcile PR review state';
const workflowRunUrl = `${context.serverUrl}/${owner}/${repo}/actions/runs/${context.runId}`;

if (context.eventName === 'issue_comment' &&
(!context.payload.issue?.pull_request ||
Expand Down Expand Up @@ -656,8 +657,7 @@ jobs:
}
if (!lookupSucceeded && passed) return;
if (latestGateStatus?.state === state &&
latestGateStatus.description === description &&
latestGateStatus.target_url === pr.html_url) {
latestGateStatus.description === description) {
Comment on lines 659 to +660

@zoomote2 zoomote2 Bot Oct 27, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Low: removing target_url from the dedupe means statuses already published with the legacy PR-page URL and an identical state+description are never republished, so PRs that were already open at deploy time keep the old PR-page Details link until their gate state/description changes or a new push lands (statuses are per-SHA). The existing does not republish an unchanged review gate status test pins exactly this behavior, so if the stale-window tradeoff is intended feel free to disregard — otherwise a one-time migration check keeps the skip semantics while correcting legacy URLs exactly once:

Suggested change
if (latestGateStatus?.state === state &&
latestGateStatus.description === description &&
latestGateStatus.target_url === pr.html_url) {
latestGateStatus.description === description) {
if (latestGateStatus?.state === state &&
latestGateStatus.description === description &&
/\/actions\/runs\/\d+$/.test(latestGateStatus.target_url ?? '')) {

return;
}
const mustInvalidateSuccess = !passed &&
Expand All @@ -671,7 +671,7 @@ jobs:
state,
context: reviewGateName,
description,
target_url: pr.html_url,
target_url: workflowRunUrl,
});
} catch (error) {
if (required || mustInvalidateSuccess) throw error;
Expand Down
31 changes: 30 additions & 1 deletion src/services/__tests__/pr-review-state-workflow.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ const resolveScript = workflow.jobs.resolve.steps[0].with.script as string
const SHA = "a".repeat(40)
const OLD_SHA = "b".repeat(40)
const REVIEWED_AT = Date.parse("2026-08-29T15:02:00Z")
const WORKFLOW_RUN_URL = "https://github.com/Zoo-Code-Org/Zoo-Code/actions/runs/123456"

type ReviewState = "APPROVED" | "CHANGES_REQUESTED" | "COMMENTED" | "DISMISSED"

Expand Down Expand Up @@ -492,6 +493,8 @@ function buildReconcileHarness(options: HarnessOptions = {}) {
const context = {
eventName,
repo: { owner: "Zoo-Code-Org", repo: "Zoo-Code" },
runId: 123456,
serverUrl: "https://github.com",
payload,
runNumber: options.runNumber ?? 1,
}
Expand Down Expand Up @@ -1935,7 +1938,12 @@ describe("PR review-state workflow", () => {
const result = await runWorkflow()

expect(latestGateStatus(result)).toEqual(
expect.objectContaining({ context: "Zoo Code / PR review gate", sha: SHA, state: "pending" }),
expect.objectContaining({
context: "Zoo Code / PR review gate",
sha: SHA,
state: "pending",
target_url: WORKFLOW_RUN_URL,
}),
)
})

Expand All @@ -1955,6 +1963,27 @@ describe("PR review-state workflow", () => {
expect(result.addLabels).toHaveBeenCalledWith(expect.objectContaining({ labels: ["awaiting-coderabbit"] }))
})

it("publishes a changed review gate status with the workflow run URL", async () => {
const result = await runWorkflow({
gateStatuses: [
{
context: "Zoo Code / PR review gate",
state: "pending",
description: "Wait for the required CI checks to finish.",
targetUrl: "https://github.com/Zoo-Code-Org/Zoo-Code/pull/1437",
},
],
})

expect(latestGateStatus(result)).toEqual(
expect.objectContaining({
state: "pending",
description: "Required CI passed. Waiting for automated review of the latest commit.",
target_url: WORKFLOW_RUN_URL,
}),
)
})

it("continues metadata reconciliation when gate publication fails", async () => {
const result = await runWorkflow({ createCommitStatusErrorStatus: 500 })

Expand Down
Loading