Skip to content

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

@github-actions

Description

@github-actions

The following reporting workflows include output format templates that use ## (h2) or # (h1) headers, which directly contradicts the guidelines in shared/reporting.md. Since these templates serve as examples for the AI agent, they take precedence over the imported guidelines and cause inconsistent output formatting.

All listed workflows import shared/reporting.md, which explicitly states: "Never use ## (h2) or # (h1) in reports — these are reserved for titles." The fix is to update each workflow's output template to use h3 (###) headers and add <details> tags for progressive disclosure where missing.

Workflows to Update

Workflow File H2 Headers in Template Details Tags Issues
.github/workflows/daily-regulatory.md 7 (## 📊 Reports Reviewed, ## 🔍 Data Consistency Analysis, ## ⚠️ Issues and Anomalies, ## 📈 Trend Analysis, ## 📝 Per-Report Analysis, ## 💡 Recommendations, ## 📊 Regulatory Metrics) 1 H2 headers, missing <details> for most sections
.github/workflows/weekly-safe-outputs-spec-review.md 4 (## Summary, ## Specification Changes Reviewed, ## Script Updates, ## Testing) 0 H2 headers, no progressive disclosure
.github/workflows/daily-testify-uber-super-expert.md 3 (## Overview, ## Current State, ## Test Quality Analysis) 0 H2 headers, no progressive disclosure
.github/workflows/daily-function-namer.md 3 (## Why This Matters, ## Rename Suggestions, ## Agentic Implementation Plan) 0 H2 headers, no progressive disclosure
.github/workflows/daily-safe-output-optimizer.md 2 (## Summary, ## Error Analysis) 0 H2 headers, no progressive disclosure
.github/workflows/daily-news.md 1 (## 📈 Trend Analysis) 0 H2 header in chart embed template
.github/workflows/daily-doc-healer.md 1 (## Self-Healing Documentation Fixes) 0 H2 header, no progressive disclosure
.github/workflows/daily-doc-updater.md 1 0 H2 header, no progressive disclosure
.github/workflows/daily-repo-chronicle.md 1 (## 📈 THE NUMBERS - Visualized) 0 H2 header in chart embed template
.github/workflows/daily-safe-outputs-conformance.md 1 0 H2 header, no progressive disclosure
.github/workflows/daily-workflow-updater.md 1 (## GitHub Actions Updates - [Date]) 0 H2 header, no progressive disclosure
.github/workflows/weekly-editors-health-check.md 1 (## Editor Health Report – (date)) 0 H2 header, no progressive disclosure
.github/workflows/daily-firewall-report.md 1 2 H2 header (partially compliant)

Required Changes

For each workflow listed above, update the output format template in the prompt to:

1. Fix Header Levels

Replace all ## Section Name with ### Section Name in the output format templates (markdown code blocks).

Before:

## Summary

## Error Analysis

After:

### Summary

### Error Analysis

2. Add Progressive Disclosure

For workflows with no <details> tags in their templates, wrap verbose/detail sections using collapsible tags:

### Summary

Key metrics immediately visible here.

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

[Detailed tables, full lists, verbose output]

</details>

### Recommendations

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 Examples

Good examples of compliant reporting workflows to reference:

  • .github/workflows/daily-observability-report.md — Full progressive disclosure with <details> tags, h3 section headers throughout
  • .github/workflows/daily-issues-report.md — Explicit "Formatting Guideline" note, h3 headers in template

Agent Task

For each workflow file listed in the table above:

  1. Open the file and locate the output format template (markdown code block)
  2. Replace all ## headers with ### in the template
  3. Add <details><summary><b>Section Name</b></summary> wrappers around verbose content sections (detailed tables, full file lists, extended analysis)
  4. Keep key summary metrics and critical issues outside <details> tags (always visible)

References:

Generated by Workflow Normalizer ·

  • expires on Mar 16, 2026, 1:44 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