Skip to content

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

@github-actions

Description

@github-actions

Workflows to Update

The following workflows generate reports but have markdown style guideline violations in their report templates:

Workflow File Issues Found
.github/workflows/copilot-cli-deep-research.md Discussion template uses # (h1) and ## (h2) headers — contradicts imported shared/reporting.md guidelines

Required Changes

.github/workflows/copilot-cli-deep-research.md

The discussion body template (starting at the ### Discussion Structure section) contains h1 and h2 headers that directly contradict the shared/reporting.md guidelines imported by this workflow.

Non-compliant headers in the output template:

  • # 🔍 Copilot CLI Deep Research Report → should be removed (title is set separately)
  • ## 📊 Executive Summary### 📊 Executive Summary
  • ## Critical Findings### Critical Findings
  • ## 1️⃣ Current State Analysis### 1️⃣ Current State Analysis
  • ## 2️⃣ Feature Usage Matrix### 2️⃣ Feature Usage Matrix
  • ## 3️⃣ Missed Opportunities### 3️⃣ Missed Opportunities
  • ## 4️⃣ Specific Workflow Recommendations### 4️⃣ Specific Workflow Recommendations
  • ## 5️⃣ Trends & Insights### 5️⃣ Trends & Insights
  • ## 6️⃣ Best Practice Guidelines### 6️⃣ Best Practice Guidelines
  • ## 7️⃣ Action Items### 7️⃣ Action Items
  • ## 📚 References### 📚 References

1. Header Levels

Update all h1/h2 headers inside the discussion body template to h3 (###) or lower:

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

2. Progressive Disclosure

The workflow already uses <details> tags in some sections — ensure all verbose content sections use them consistently.

3. Suggested Report Structure

### 📊 Executive Summary

[2-3 paragraphs]

### Critical Findings

#### 🔴 High Priority Issues
[Content]

#### 🟡 Medium Priority Opportunities
[Content]

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

### 1️⃣ Current State Analysis
...

### 2️⃣ Feature Usage Matrix
...

</details>

### Action Items
[Visible, actionable next steps]

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

Example Reference

See workflows like daily-compiler-quality or api-consumption-report for good examples of structured reporting with proper header levels.

Agent Task

Update .github/workflows/copilot-cli-deep-research.md to fix the h1/h2 headers in the discussion template. Run make recompile after updating the workflow file.


Compliance Context

Review period: Last 24 hours (2026-04-19)
Workflows reviewed: 16 reporting workflows
Compliant: 15 workflows follow style guidelines (via shared/reporting.md import or explicit format instructions)
Non-compliant: 1 workflow has contradictory template headers

Generated by Workflow Normalizer · ● 2.7M ·

  • expires on Apr 21, 2026, 12:06 AM 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