Skip to content

[workflow-style] Normalize report formatting for non-compliant workflows #33052

@github-actions

Description

@github-actions

Workflows to Update

The following workflows generate reports/issues but don't import shared/reporting.md and lack markdown style guidelines in their prompts:

Workflow File Creates Issues Found
.github/workflows/deployment-incident-monitor.md Issues Missing shared/reporting.md import; no h3+/<details> guidance
.github/workflows/copilot-pr-merged-report.md Issues Missing shared/reporting.md import; no h3+/<details> guidance
.github/workflows/pr-triage-agent.md Issues Missing shared/reporting.md import; no h3+/<details> guidance

Required Changes

For each workflow listed above, add the shared/reporting.md import or add explicit formatting instructions to the prompt.

Option A — Add Import (Preferred)

In the frontmatter imports: block, add:

imports:
  - shared/reporting.md
  # ... existing imports

Option B — Add Inline Instructions

Add these formatting guidelines to the prompt:

#### 1. Header Levels
Use h3 (###) or lower for all headers in your report to maintain proper document hierarchy.

#### 2. Progressive Disclosure
Wrap long sections in `<details><summary>Section Name</summary>` tags to improve readability and reduce scrolling.

Recommended Report Structure

### Summary
- Key metric 1: value
- Status: ✅/⚠️/❌

### Critical Issues
[Always visible]

<details>
<summary>View Detailed Results</summary>

[Long details here]

</details>

### Recommendations
[Actionable next steps]

Design Principles (Airbnb-Inspired)

Updated workflows should produce reports that:

  1. Build trust through clarity: Most important info immediately visible
  2. Exceed expectations: Add helpful context, trends, comparisons
  3. Create delight: Use progressive disclosure to reduce overwhelm
  4. Maintain consistency: Follow patterns as agent-performance-analyzer, test-quality-sentinel, and aw-failure-investigator (all already use shared/reporting.md)

Context

  • Workflows already compliant (use shared/reporting.md): agent-performance-analyzer, aw-failure-investigator, auto-triage-issues, test-quality-sentinel
  • The shared/reporting.md file at .github/workflows/shared/reporting.md contains the full style guide
  • Review triggered by Workflow Normalizer run §26038231441

Generated by 🔧 Workflow Normalizer · ● 6.8M ·

  • expires on May 19, 2026, 2:08 PM UTC

Metadata

Metadata

Labels

cookieIssue Monster Loves Cookies!enhancementNew feature or request

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions