Skip to content

[workflow-style] Normalize report formatting for pr-triage-agent #11861

@github-actions

Description

@github-actions

Workflow to Update

Workflow File: .github/workflows/pr-triage-agent.md

Issues Found:

  • Report template uses h1/h2 headers (should use h3+)
  • No progressive disclosure instructions (should use <details> tags)
  • Doesn't import shared/reporting.md guidelines

Required Changes

1. Import Shared Reporting Guidelines

Add to the imports section:

imports:
  - shared/reporting.md

2. Fix Report Template Headers

The current report template (lines 277-355) uses incorrect header levels:

Current (❌ WRONG):

# PR Triage Report - {date}

## Executive Summary
## Triage Statistics
## 🚀 Top Priority PRs

Should be (✅ CORRECT):

### PR Triage Report - {date}

#### Executive Summary
#### Triage Statistics  
#### 🚀 Top Priority PRs

Update all h1 (#) to h3 (###) and all h2 (##) to h4 (####) in the report template.

3. Add Progressive Disclosure

The report has many long sections that should use <details> tags. Update the template to wrap verbose sections:

### Summary
- **Total PRs Triaged:** {count}
- **Auto-merge Candidates:** {auto_merge_count}
- **Fast-track Needed:** {fast_track_count}

<details>
<summary><b>View Full Statistics</b></summary>

#### By Category
- Bug: {bug_count}
- Feature: {feature_count}
- Docs: {docs_count}
...

#### By Risk Level
- High Risk: {high_risk_count}
...

</details>

#### 🚀 Top Priority PRs
{top_10_prs}

<details>
<summary><b>View All Categorized PRs</b></summary>

#### ✅ Auto-merge Candidates
{auto_merge_prs}

#### ⚡ Fast-track Review Needed
{fast_track_prs}

#### 📦 Batch Processing Opportunities
{batches}

</details>

Keep the executive summary, top priority PRs, and next steps visible. Collapse detailed statistics and full PR lists.

Design Principles

After updates, the pr-triage-agent report should:

  1. Build trust through clarity: Executive summary and top priorities immediately visible
  2. Exceed expectations: Show trends and recommendations upfront
  3. Create delight: Use progressive disclosure to avoid overwhelming with ~50+ PRs
  4. Maintain consistency: Follow the same patterns as other reporting workflows

Reference Examples

Good examples of proper formatting:

  • smoke-copilot.md - Uses h3 headers and details tags correctly
  • daily-cli-performance.md - Progressive disclosure for verbose data
  • shared/reporting.md - Complete style guidelines

Testing

After making changes:

  1. Trigger the workflow with workflow_dispatch
  2. Verify the generated discussion uses h3+ headers
  3. Verify long sections are collapsed in <details> tags
  4. Check that critical info (summary, top 10, next steps) is visible without expanding

AI generated by Workflow Normalizer

  • expires on Feb 2, 2026, 12:26 PM UTC

Metadata

Metadata

Labels

cookieIssue Monster Loves Cookies!documentationImprovements or additions to documentationenhancementNew feature or request

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions