Skip to content

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

@github-actions

Description

@github-actions

Workflows to Update

The following workflows generate reports/issues but lack markdown style guidelines in their prompts (missing header level instructions, no progressive disclosure guidance):

Workflow File Issues Found
.github/workflows/daily-skill-optimizer.md Missing header level guidelines; no <details> guidance; no structured report format
.github/workflows/spec-librarian.md Uses h1/h2 headers in prompt templates; lacks progressive disclosure instructions
.github/workflows/daily-secrets-analysis.md Uses h1/h2 in prompt templates; no explicit header level guideline for reports
.github/workflows/daily-safe-outputs-conformance.md Uses h1/h2 in templates; incomplete progressive disclosure guidance
.github/workflows/daily-otel-instrumentation-advisor.md Uses h1/h2 in templates; partial <details> usage

Required Changes

For each workflow listed above, update the prompt to include these formatting guidelines:

1. Header Levels

Add instruction: "Use h3 (###) or lower for all headers in your report. Never use h1 (#) or h2 (##) — these are reserved for the issue title."

2. Progressive Disclosure

Add instruction: "Wrap long sections in <details><summary><b>Section Name</b></summary> tags to improve readability."

Example:

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

[Long detailed content here...]

</details>

3. Report Structure

Suggest a structure like:

### Summary
- Key metric 1: value
- Status: ✅/⚠️/❌

### Key Findings
[Always visible — critical issues]

<details>
<summary><b>Detailed Analysis</b></summary>

[Comprehensive details, logs, traces]

</details>

### Recommendations
[Actionable next steps — keep visible]

Design Principles (Airbnb-Inspired)

Updated workflows should produce 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 across all reporting workflows

Example Reference

See .github/workflows/daily-compiler-quality.md and .github/workflows/daily-observability-report.md for examples with good <details> usage and structured reporting.

Agent Task

Update each workflow file listed in the table above to include the formatting guidelines in the prompt instructions. Focus on the output/issue format sections of each prompt.

Full Compliance Review — All Active Workflows (Last 24h)
Workflow File Creates Issues Has <details> Has H3 Guide Status
daily-skill-optimizer.md ✅ yes ❌ no ❌ no ⚠️ Needs update
spec-librarian.md ✅ yes ✅ yes ✅ yes ⚠️ H1/H2 in templates
daily-secrets-analysis.md ✅ yes ✅ yes ✅ yes ⚠️ H1/H2 in templates
daily-safe-outputs-conformance.md ✅ yes ✅ yes ✅ yes ⚠️ H1/H2 in templates
daily-otel-instrumentation-advisor.md ✅ yes ✅ yes ✅ partial ⚠️ H1/H2 in templates
daily-safe-output-optimizer.md ✅ yes ✅ yes ✅ yes ✅ Compliant
daily-compiler-quality.md ❌ no ✅ yes ✅ yes ✅ Compliant
daily-observability-report.md ❌ no ✅ yes ✅ yes ✅ Compliant

Next Steps

  • Update daily-skill-optimizer.md — add issue format section with h3+ and <details> guidance
  • Update spec-librarian.md — replace h1/h2 in report templates with h3+
  • Update daily-secrets-analysis.md — enforce h3+ in output format section
  • Update daily-safe-outputs-conformance.md — enforce h3+ in issue templates
  • Update daily-otel-instrumentation-advisor.md — replace h1/h2 in issue template with h3+

Generated by Workflow Normalizer · ● 1M ·

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