Skip to content

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

@github-actions

Description

@github-actions

The following workflows generate structured issue reports but are missing markdown style guidelines for header levels and progressive disclosure:

Workflow File Issues Found
.github/workflows/step-name-alignment.md Issue template uses ## (h2) headers; no <details> guidance for long sections
.github/workflows/bot-detection.md Report Format section lacks h3+ header instructions; no <details> / progressive disclosure guidance

Required Changes

For each workflow listed above, update the prompt to include the following formatting guidelines in the report/output format section.

1. Header Levels

Add instruction:

Use h3 (###) or lower for all headers in your report to maintain proper document hierarchy. Never use # (h1) or ## (h2) inside report bodies.

Specific fix for step-name-alignment.md: The Issue Description Template at line ~253 starts with ## Step Name Alignment Issues. Change to ### Step Name Alignment Issues and ensure all nested headers follow the h3+ convention.

2. Progressive Disclosure

Add instruction:

Wrap long sections (e.g. full issue lists, detailed evidence, extended logs) in <details><summary><b>Section Name</b></summary> tags to improve readability and reduce scrolling.

Example to embed:

<details>
<summary><b>Full Analysis Details</b></summary>

[Long detailed content here...]

</details>

3. Suggested Report Structure

For each workflow, the report should follow:

  • Brief summary (always visible) — key metrics, status assessment
  • Key findings (always visible) — top 3–5 bullets or highlights
  • Detailed breakdown (in <details> tags) — full lists, per-item evidence, extended logs
  • Recommended actions (always visible) — actionable next steps

Design Principles (Airbnb-Inspired)

The updated workflows 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 Examples

See these compliant workflows for good examples of structured reporting:

  • .github/workflows/ci-doctor.md — explicit h3+ rule + <details> template at the Investigation Issue Template section
  • .github/workflows/auto-triage-issues.md — full progressive disclosure instructions with before/after examples
  • .github/workflows/draft-pr-cleanup.md — "Report Formatting" guidance block + concrete <details> template

Agent Task

For each workflow file listed in the table above:

  1. Read the current report/output format section of the workflow prompt
  2. Add a "Report Formatting" instruction block following the pattern from ci-doctor.md
  3. For step-name-alignment.md, also fix the Issue Description Template to use ### Step Name Alignment Issues instead of ## Step Name Alignment Issues
  4. Compile the updated workflows with make recompile
  5. Verify with make agent-finish before committing

References:

  • §22257713132 — Workflow Style Normalization run that identified these issues

Generated by Workflow Normalizer

  • expires on Feb 22, 2026, 1:39 PM UTC

Metadata

Metadata

Labels

cookieIssue Monster Loves Cookies!

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions