Files
orca/src/main/github/mappers.ts
T
Jinjing fe72eeb75c Add linked issue guidance and ELI5 sections to PR generation prompts (#12613)
* Add linked issue guidance and ELI5 sections to PR generation prompts

Include linked GitHub issues in PR descriptions with Fixes/Refs guidance, and require ELI5 Problem and Solution sections before implementation details. Tests verify linked issue substitution and prompt structure enforcement.

* Include linked issue details in PR description generation

- Fetch the linked GitHub/GitLab issue title and body so generated PRs reference real issue context instead of just a number
- Use provider-specific reference syntax (Fixes/Refs, Closes/Related to, AB#) and label the issue by the active provider
- Feed issue title and description into the generation prompt while treating them as untrusted context, never as instructions
- Fall back to a cached work-item title when the provider lookup fails, and skip cross-provider issue attachment
2026-08-04 20:05:30 -07:00

151 lines
4.2 KiB
TypeScript

import type { PRInfo, IssueInfo, CheckStatus, PRCheckDetail } from '../../shared/types'
import { derivePRCheckStatusFromRollup } from '../../shared/pr-check-status'
// ── REST API check-runs mapping ───────────────────────────────────────
// The REST check-runs endpoint returns separate status + conclusion fields
// (unlike gh pr checks which merges them into a single "state" string).
export function mapCheckRunRESTStatus(status: string): PRCheckDetail['status'] {
const s = status?.toLowerCase()
if (s === 'queued') {
return 'queued'
}
if (s === 'in_progress') {
return 'in_progress'
}
return 'completed'
}
const conclusionMap: Record<string, PRCheckDetail['conclusion']> = {
success: 'success',
failure: 'failure',
cancelled: 'cancelled',
timed_out: 'timed_out',
skipped: 'skipped',
neutral: 'neutral',
action_required: 'action_required',
stale: 'failure',
startup_failure: 'failure'
}
export function mapCheckRunRESTConclusion(
status: string,
conclusion: string | null
): PRCheckDetail['conclusion'] {
if (status?.toLowerCase() !== 'completed') {
return 'pending'
}
if (!conclusion) {
return null
}
return conclusionMap[conclusion.toLowerCase()] ?? null
}
// ── REST API commit status mapping ──────────────────────────────────────
// Legacy Jenkins/Prow integrations report commit statuses, not check runs.
export function mapCommitStatusRESTStatus(state: string): PRCheckDetail['status'] {
const s = state?.toLowerCase()
return s === 'pending' ? 'queued' : 'completed'
}
export function mapCommitStatusRESTConclusion(state: string): PRCheckDetail['conclusion'] {
const s = state?.toLowerCase()
if (s === 'success') {
return 'success'
}
if (s === 'failure' || s === 'error') {
return 'failure'
}
if (s === 'pending') {
return 'pending'
}
return null
}
// ── gh pr checks mapping (single "state" string) ─────────────────────
export function mapCheckStatus(state: string): PRCheckDetail['status'] {
const s = state?.toUpperCase()
if (s === 'PENDING' || s === 'QUEUED') {
return 'queued'
}
if (s === 'IN_PROGRESS') {
return 'in_progress'
}
return 'completed'
}
export function mapCheckConclusion(state: string): PRCheckDetail['conclusion'] {
const s = state?.toUpperCase()
if (s === 'SUCCESS' || s === 'PASS') {
return 'success'
}
if (s === 'FAILURE' || s === 'FAIL') {
return 'failure'
}
if (s === 'ACTION_REQUIRED') {
return 'action_required'
}
if (s === 'STALE' || s === 'STARTUP_FAILURE') {
return 'failure'
}
if (s === 'CANCELLED') {
return 'cancelled'
}
if (s === 'TIMED_OUT') {
return 'timed_out'
}
if (s === 'SKIPPED') {
return 'skipped'
}
if (s === 'PENDING' || s === 'QUEUED' || s === 'IN_PROGRESS') {
return 'pending'
}
if (s === 'NEUTRAL') {
return 'neutral'
}
return null
}
export function mapPRState(state: string, isDraft?: boolean): PRInfo['state'] {
const s = state?.toUpperCase()
if (s === 'MERGED') {
return 'merged'
}
if (s === 'CLOSED') {
return 'closed'
}
if (isDraft) {
return 'draft'
}
return 'open'
}
// ── Issue mapping ────────────────────────────────────────────────────
// REST API returns html_url + lowercase state; gh issue view returns url + mixed-case state.
// This helper normalises both shapes into IssueInfo.
export function mapIssueInfo(data: {
number: number
title: string
state: string
url?: string
html_url?: string
labels?: { name: string }[]
body?: string | null
}): IssueInfo {
return {
number: data.number,
title: data.title,
state: data.state?.toLowerCase() === 'open' ? 'open' : 'closed',
url: data.html_url ?? data.url ?? '',
labels: (data.labels || []).map((l) => l.name),
...(typeof data.body === 'string' ? { description: data.body } : {})
}
}
export function deriveCheckStatus(rollup: unknown[] | null | undefined): CheckStatus {
return derivePRCheckStatusFromRollup(rollup)
}