Skip to content

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

@github-actions

Description

@github-actions

Workflows to Update

The following workflows generate reports but don't follow markdown style guidelines:

Workflow File Issues Found
.github/workflows/scout.md Uses h1/h2 headers in output template; non-bold <summary> tag

Required Changes

.github/workflows/scout.md

The ## Output Format section (lines ~131–194) provides two markdown templates for the research comment, both using h1 and h2 headers.

Issues:

  1. # 🔍 Scout Research Report → should be ### 🔍 Scout Research Report
  2. ## Executive Summary → should be ### Executive Summary
  3. ## Research Findings → should be ### Research Findings
  4. ## Recommendations → should be ### Recommendations
  5. ## Key Sources → should be ### Key Sources
  6. ## Suggested Next Steps → should be ### Suggested Next Steps
  7. ## Search Conducted → should be ### Search Conducted
  8. ## Explanation → should be ### Explanation
  9. ## Suggestions → should be ### Suggestions
  10. <summary>Click to expand detailed findings</summary> → should use bold: <summary><b>Click to expand detailed findings</b></summary>

Before:

# 🔍 Scout Research Report

*Triggered by @...*

## Executive Summary
[Brief overview]

<details>
<summary>Click to expand detailed findings</summary>
## Research Findings
...
## Recommendations
...
</details>

After:

### 🔍 Scout Research Report

*Triggered by @...*

### Executive Summary
[Brief overview]

<details>
<summary><b>Click to expand detailed findings</b></summary>

### Research Findings
...

### Recommendations
...

</details>

Also add an explicit report formatting guideline to the ## Output Format section, similar to other workflows:

Report Formatting: Use h3 (###) or lower for all headers in the report to maintain proper document hierarchy. Wrap long sections in <details><summary><b>Section Name</b></summary> tags to improve readability.

Design Principles (Airbnb-Inspired)

The updated workflow should create 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 the same patterns as other reporting workflows

Reference

See ci-coach.md, ci-doctor.md, pr-triage-agent.md for good examples of structured reporting with proper header levels and <details> formatting.

Agent Task

Update .github/workflows/scout.md to fix all h1/h2 headers in the output template to h3+, add bold to the <summary> tag, and add an explicit report formatting guideline to the Output Format section. After updating, run make recompile to regenerate the lock file.

References

Generated by Workflow Normalizer

  • expires on Feb 26, 2026, 1:53 PM UTC

Metadata

Metadata

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions