Skip to content

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

@github-actions

Description

@github-actions

Overview

Automated style review for the last 24 hours identified 3 reporting workflows that use ## (h2) as their top-level report header, violating the project's markdown style guidelines which require h3 (###) or lower in generated reports.

Period: 2026-04-08 (last 24 hours)
Workflows Reviewed: 11 reporting workflows
Compliant: 8 · Non-compliant: 3


Workflows to Update

Workflow File Issues Found
.github/workflows/daily-otel-instrumentation-advisor.md Issue template uses ## 📡 (h2); no <details> tags
.github/workflows/test-quality-sentinel.md PR comment template uses ## 🧪 (h2) as top-level header
.github/workflows/design-decision-gate.md Three PR comment templates use ## 🏗️ / ## ✅ / ## ⚠️ (h2)

Required Changes

For each workflow, change the top-level header in the report/comment markdown template from h2 (##) to h3 (###), and add <details> wrapping for long content sections.

1. daily-otel-instrumentation-advisor.md (line 159)

Before:

## 📡 OTel Instrumentation Improvement: <title>

After:

### 📡 OTel Instrumentation Improvement: <title>

Also wrap verbose sections (Current Behavior code snippets, Implementation Steps) in <details> tags:

<details>
<summary><b>Implementation Steps</b></summary>

[step-by-step content]

</details>

2. test-quality-sentinel.md (line 286)

Before:

## 🧪 Test Quality Sentinel Report

After:

### 🧪 Test Quality Sentinel Report

3. design-decision-gate.md (lines 219, 299, 323)

Before:

## 🏗️ Design Decision Gate — ADR Required
## ✅ Design Decision Gate — ADR Verified
## ⚠️ Design Decision Gate — Implementation Diverges from ADR

After:

### 🏗️ Design Decision Gate — ADR Required
### ✅ Design Decision Gate — ADR Verified
### ⚠️ Design Decision Gate — Implementation Diverges from ADR

Why This Matters

GitHub issues and PR comments render within a page that already has h1/h2 chrome. Using ## (h2) inside a report creates an oversized visual break. The project style guide requires all report headers to start at ### to maintain proper document hierarchy.

Progressive disclosure via <details> also reduces comment noise — especially for the OTel advisor and Test Quality Sentinel which can generate long content.


Reference Examples

  • daily-compiler-quality.md — discussion body starts with ### 🔍
  • daily-code-metrics.md — discussion body starts with ### 📊 and uses <details>
  • daily-observability-report.md — uses ### headers and multiple <details> blocks ✅

Agent Task

Update each of the three workflow files listed above:

  1. Change ## ### for top-level report/comment headers inside markdown template blocks
  2. For daily-otel-instrumentation-advisor.md, also add at least one <details> section for verbose content (e.g., Implementation Steps)
  3. Run make recompile after changes
  4. Verify no CI failures
Full Compliance Summary
Workflow Creates Report? h3 Instruction <details> Verdict
daily-observability-report.md ✅ Compliant
daily-performance-summary.md ✅ Compliant
api-consumption-report.md ✅ Compliant
daily-secrets-analysis.md ✅ Compliant
daily-safe-outputs-conformance.md ✅ Compliant
daily-compiler-quality.md ✅ Compliant
daily-code-metrics.md ✅ Compliant
daily-malicious-code-scan.md N/A (no issue output)
daily-otel-instrumentation-advisor.md ❌ Non-compliant
test-quality-sentinel.md ❌ Non-compliant
design-decision-gate.md ❌ Non-compliant

References:

Generated by Workflow Normalizer · ● 1.9M ·

  • expires on Apr 10, 2026, 12:00 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