Skip to content

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

@github-actions

Description

@github-actions

Workflows to Update

The following workflow generates reports but has a report template that uses H1/H2 headers, contradicting the project's markdown style guidelines from shared/reporting.md:

Workflow File Issues Found
.github/workflows/prompt-clustering-analysis.md Report template uses H1/H2 headers; <summary> tag missing bold formatting

Context

The workflow prompt-clustering-analysis.md (Copilot Agent Prompt Clustering Analysis) was active on 2026-03-18 and creates GitHub discussions. While it correctly references shared/reporting.md in its imports, the explicit Report Template on lines ~490–564 directly instructs the agent to use # (H1) and ## (H2) headers — which overrides the shared guidelines since specific instructions take precedence.

Specific violations found:

The report template contains:

# 🔬 Copilot Agent Prompt Clustering Analysis - [DATE]   ← H1 (should be discussion title only)

## Summary            ← should be ### Summary
## General Insights   ← should be ### General Insights
## Cluster Analysis   ← should be ### Cluster Analysis
## Success Rate by Cluster  ← should be ### Success Rate by Cluster
## Full Data Table    ← should be ### Full Data Table
## Key Findings       ← should be ### Key Findings
## Recommendations    ← should be ### Recommendations

Also, the <summary> tag in the <details> block is missing bold formatting:

<summary>Full Analysis Report</summary>       ← missing <b> tags

Required Changes

Update .github/workflows/prompt-clustering-analysis.md — the Report Template section (around line 490):

1. Remove H1 from Template Body

The discussion title (# 🔬 ...) should be used as the title field when creating the discussion, not as a header in the body. The body should start at ###.

2. Downgrade H2 → H3 in the Template

### Summary           ← was ##
### General Insights  ← was ##
### Cluster Analysis  ← was ##
### Success Rate by Cluster  ← was ##
### Full Data Table   ← was ##
### Key Findings      ← was ##
### Recommendations   ← was ##

3. Add Bold Formatting to <summary> Tags

<summary><b>Full Analysis Report</b></summary>

4. Example Corrected Report Template Structure

### Summary

**Analysis Period**: Last 30 days
**Total Tasks Analyzed**: [count]
**Clusters Identified**: [count]
**Overall Success Rate**: [percentage]%

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

### General Insights

- **Most Common Task Type**: [cluster description]
- **Highest Success Rate**: [cluster with best success rate]

### Cluster Analysis

#### Cluster 1: [Theme/Description]
- **Size**: X tasks
...

</details>

### Recommendations

1. **[Recommendation 1]**: [Specific actionable recommendation]

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 like daily-repo-chronicle and daily-issues-report

Agent Task

Update .github/workflows/prompt-clustering-analysis.md to fix the report template so that:

  • No H1/H2 headers appear in the discussion body
  • The discussion title is set using the title field
  • All section headers in the body use H3 (###) or lower
  • <summary> tags use <b> for bold formatting

References:

  • §23248082007 — Workflow Normalizer (previous run that established this review pattern)
  • §23297927411 — This Workflow Normalizer run

Generated by Workflow Normalizer ·

  • expires on Mar 20, 2026, 2:00 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