Skip to content

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

@github-actions

Description

@github-actions

Workflows to Update

The following workflows generate reports but use incorrect header levels in their output templates or lack explicit formatting guidelines:

Workflow File Issues Found
.github/workflows/copilot-session-insights.md Discussion template uses # (h1) and ## (h2) headers — violates document hierarchy guidelines

Required Changes

For each workflow listed above, update the prompt to follow 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."

For copilot-session-insights.md, update the Discussion Template (around line 269) to replace all # and ## headers with ### and #### respectively:

### 🤖 Copilot Agent Session Analysis — [DATE]

#### Executive Summary
...
#### Key Metrics
...
#### Success Factors ✅
...
#### Failure Signals ⚠️
...

2. Progressive Disclosure

The discussion template in copilot-session-insights.md should wrap verbose sections in <details> tags:

<details>
<summary><b>Detailed Session Breakdown</b></summary>

[Long per-session details...]

</details>

3. Explicit Formatting Instruction

Add a ### Report Formatting section near the discussion creation phase (Phase 5) with:

### Report Formatting

- Use h3 (`###`) or lower for all headers in the discussion body. Never use h1 (`#`) or h2 (`##`) — these are reserved for the discussion title.
- Wrap long sections in `<details><summary><b>Section Name</b></summary>` tags to improve readability and reduce scrolling.
- Keep Executive Summary, Key Metrics, and Recommendations always visible; collapse verbose per-session data in `<details>` blocks.

Design Principles (Airbnb-Inspired)

The updated workflow should create discussions 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

Example Reference

See daily-token-consumption-report.md, outcome-collector.md, and ai-moderator.md for good examples of explicit formatting instructions.

Agent Task

Update copilot-session-insights.md to:

  1. Fix the discussion template to use ###/#### headers instead of #/##
  2. Add explicit report formatting guidelines near Phase 5
  3. Add <details> wrappers for verbose sections like per-prompt breakdowns and loop detection details

Generated by 🔧 Workflow Normalizer · sonnet46 1.9M ·

  • expires on May 27, 2026, 1:50 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