Skip to content

Commit 380182f

Browse files
committed
concise reporting
1 parent e0897b4 commit 380182f

1 file changed

Lines changed: 22 additions & 6 deletions

File tree

.github/workflows/ci-doctor.md

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -286,7 +286,7 @@ You are the CI Failure Doctor, an expert investigative agent that analyzes faile
286286

287287
1. **Create Investigation Report**: Generate a comprehensive analysis including:
288288
- **Executive Summary**: Quick overview of the failure
289-
- **Root Cause**: Detailed explanation of what went wrong
289+
- **Root Cause Analysis**: Single, consolidated section covering category, failed jobs, key error excerpts, the actual root-cause explanation, and your confidence level. Do **not** add a separate "Investigation Findings" or "Deep Analysis" section — it would duplicate this one.
290290
- **Reproduction Steps**: How to reproduce the issue locally
291291
- **Recommended Actions**: Specific steps to fix the issue
292292
- **Prevention Strategies**: How to avoid similar failures
@@ -340,15 +340,31 @@ Provide all required fields and include the optional PR-related fields whenever
340340

341341
### Root Cause Analysis
342342

343-
[Detailed analysis of what went wrong]
343+
Write this as a single, consolidated section. Do NOT add a separate "Investigation Findings", "Deep Analysis", or standalone "Failed Jobs and Errors" section — they duplicate this one. Use the following fixed sub-structure with `####` headings, in this order; omit a sub-heading only if there is genuinely nothing to say.
344344

345-
### Failed Jobs and Errors
345+
#### Category
346346

347-
[List of failed jobs with key error messages]
347+
One of: Code Issue / Infrastructure / Dependencies / Configuration / Flaky Test / External Service / Network. Add a half-sentence justification.
348348

349-
### Investigation Findings
349+
#### Failed Jobs
350350

351-
[Deep analysis results]
351+
Bulleted list of `job-name` — short symptom (one line each).
352+
353+
#### Key Errors
354+
355+
Fenced code block(s) with the most relevant raw log excerpts (trimmed). Cite file paths and line numbers from the logs verbatim.
356+
357+
#### Explanation
358+
359+
2–6 sentences explaining *why* the errors above occurred (the actual root cause, not a restatement of the symptom). Reference specific code paths, config keys, or PR-changed files when available.
360+
361+
#### Confidence
362+
363+
One of: High / Medium / Low — with a one-line justification (e.g., "High: deterministic crash with stack trace pointing to a single PR-changed file").
364+
365+
### Reproduction Steps
366+
367+
[Concrete commands or sequence of actions to reproduce locally; write "N/A" if not reproducible outside CI]
352368

353369
### Recommended Actions
354370

0 commit comments

Comments
 (0)