Skip to content

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

@github-actions

Description

@github-actions

Workflows to Update

The following workflows generate reports/discussions but are missing markdown style guidelines:

Workflow File Issues Found
.github/workflows/daily-mcp-concurrency-analysis.md Missing explicit h3 header level instruction
.github/workflows/daily-news.md No header level guidelines or progressive disclosure instructions

Required Changes

For each workflow listed above, update the prompt to include these formatting guidelines:

1. Header Levels

Add instruction: "Use h3 (###) or lower for all headers in your report. Never use h1 (#) or h2 (##) inside issue/discussion bodies — these are reserved for the title."

2. Progressive Disclosure

Add instruction: "Wrap long sections in <details><summary><b>Section Name</b></summary> tags to improve readability and reduce scrolling."

Example:

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

[Long detailed content here...]

</details>

3. Report Structure

Suggest a structure like:

  • Brief summary (always visible)
  • Key metrics or highlights (always visible)
  • Detailed analysis (in <details> tags)
  • Recommendations (always visible)

Specific Changes Needed

daily-mcp-concurrency-analysis.md

The issue template already uses ###/#### headers correctly and includes <details> blocks. However, there is no explicit formatting instruction to guide the agent. Add a formatting instruction near the issue template section (around line 290) similar to:

Use h3 (###) or lower for all headers in the issue body. Never use h1 (#) or h2 (##) — these are reserved for the issue title. Wrap verbose sections in <details><summary><b>Section Name</b></summary> blocks.

daily-news.md

The discussion report instructions (near line 539) provide no header or formatting guidance. The agent is told to "create a new GitHub discussion... containing a markdown report" with no structure constraints. Add formatting guidelines before or after the discussion creation instruction:

Use h3 (###) or lower for all headers in the discussion. Use <details><summary><b>Section Name</b></summary> tags to collapse long sections (PR lists, commit logs, verbose data). Keep the executive summary, highlights, and recommendations always visible.

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 Compliant Workflows

See these workflows for good examples of structured reporting:

  • daily-token-consumption-report.md — explicit h3 + progressive disclosure guidance
  • agentic-token-audit.md — detailed formatting requirements section
  • daily-aw-cross-repo-compile-check.md — concise formatting rules
  • daily-syntax-error-quality.md — clear h3 instruction

Agent Task

Update each workflow file listed in the table above to include the formatting guidelines in the prompt instructions. Compile the workflows after editing to ensure they remain valid.

make recompile

Generated by 🔧 Workflow Normalizer · sonnet46 2.3M ·

  • expires on Jun 3, 2026, 2:15 PM UTC

Metadata

Metadata

Labels

cookieIssue Monster Loves Cookies!

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