Skip to content

Normalize report formatting for breaking-change-checker workflow #13721

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
pelikhan merged 2 commits into from
Feb 4, 2026
+123 −6
Merged

Normalize report formatting for breaking-change-checker workflow #13721

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
6f89827
Initial plan
Claude Feb 4, 2026
9d1d12b
Normalize report formatting for breaking-change-checker
Claude Feb 4, 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
79 changes: 78 additions & 1 deletion .github/workflows/breaking-change-checker.lock.yml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

50 changes: 45 additions & 5 deletions .github/workflows/breaking-change-checker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ safe-outputs:
run-success: "✅ Analysis complete! [{workflow_name}]({run_url}) has reviewed all changes. Compatibility verdict delivered! 📋"
run-failure: "🔬 Analysis interrupted! [{workflow_name}]({run_url}) {status}. Compatibility status unknown..."
timeout-minutes: 10
imports:
- shared/reporting.md
---

# Breaking Change Checker
Expand Down Expand Up @@ -128,6 +130,19 @@ Is it removing schema fields or making optional fields required?

## Step 5: Report Findings

### Report Formatting Guidelines

**CRITICAL**: Follow the formatting guidelines from `shared/reporting.md` to create well-structured, readable reports.

**Key Requirements**:
1. **Header Levels**: Use h3 (###) or lower for all headers in your issue report to maintain proper document hierarchy. The issue title serves as h1, so all content headers should start at h3.
2. **Progressive Disclosure**: Wrap detailed analysis in `<details><summary><b>Section Name</b></summary>` tags to improve readability and reduce scrolling.
3. **Report Structure**:
- **Summary** (always visible): Count of breaking changes, severity assessment
- **Critical Breaking Changes** (always visible): List of changes requiring immediate attention
- **Detailed Analysis** (in `<details>` tags): Full diff analysis, code examples
- **Recommendations** (always visible): Migration steps, version bump guidance

### If NO Breaking Changes Found

**YOU MUST CALL** the `noop` tool to log completion:
Expand All @@ -153,19 +168,40 @@ Create an issue with the following structure:
**Body**:

```markdown
## ⚠️ Breaking Changes Detected
### Summary

- **Total Breaking Changes**: [NUMBER]
- **Severity**: [CRITICAL/HIGH/MEDIUM]
- **Commits Analyzed**: [NUMBER]
- **Status**: ⚠️ Requires Immediate Review

The following breaking changes were detected in commits from the last 24 hours.
### Critical Breaking Changes

### Breaking Changes Summary
[List the most important breaking changes here - always visible]

| Commit | File | Category | Change | Impact |
|--------|------|----------|--------|--------|
| [sha] | [file path] | [category] | [description] | [user impact] |

### Commits Analyzed
<details>
<summary><b>Full Code Diff Analysis</b></summary>

#### Detailed Commit Analysis

[Detailed analysis of each commit with code diffs and context]

#### Breaking Change Patterns Detected

List the commits that were analyzed with their details.
[Detailed breakdown of specific breaking patterns found in the code]

</details>

<details>
<summary><b>All Commits Analyzed</b></summary>

[Complete list of commits that were analyzed with their details]

</details>

### Action Checklist

Expand All @@ -177,6 +213,10 @@ Complete the following items to address these breaking changes:
- [ ] **Document breaking changes in CHANGELOG.md** - Add entries under "Breaking Changes" section with user-facing descriptions
- [ ] **Verify backward compatibility was considered** - Confirm that alternatives to breaking were evaluated

### Recommendations

[Migration steps, version bump guidance, and action items - always visible]

### Reference

See [scratchpad/breaking-cli-rules.md](scratchpad/breaking-cli-rules.md) for the complete breaking change policy.
Expand Down
Loading