Skip to content

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

@github-actions

Description

@github-actions

Overview

Daily review of workflow activity from the last 24 hours identified 4 reporting workflows that are missing explicit markdown style formatting guidelines in their prompts. These workflows already use correct patterns in their output templates (### headers, <details> tags), but lack the explicit instruction text that guides the AI agent to follow these standards consistently.

Reviewed: 14 active reporting workflows
Compliant: 10 workflows ✅
Needs improvement: 4 workflows ⚠️

Workflows to Update

Workflow File Issues Found
.github/workflows/daily-safe-output-optimizer.md Missing explicit header level + <details> formatting guideline
.github/workflows/spec-librarian.md Mentions progressive disclosure but missing explicit "Use h3+" instruction
.github/workflows/design-decision-gate.md No explicit report formatting instruction despite using ### in templates
.github/workflows/test-quality-sentinel.md No explicit report formatting instruction despite using ### in templates

Required Changes

For each workflow listed above, add the following formatting guideline near the output/report section of the prompt (following the same pattern as compliant workflows like daily-compiler-quality.md line 563):

1. Header Levels

Add instruction:

Report Formatting: Use h3 (###) or lower for all headers in your report to maintain proper document hierarchy. Wrap long sections in <details><summary>Section Name</summary> tags to improve readability and reduce scrolling.

2. Placement

Add this instruction in the "Output Requirements" or "Guidelines" section, near where the workflow instructs the agent to create the issue/discussion/comment.

3. Reference Implementations

See these workflows for examples of the correct pattern:

  • daily-compiler-quality.md — line 563
  • daily-observability-report.md — line 374
  • daily-secrets-analysis.md — line 295
  • auto-triage-issues.md — line 200
View Detailed Findings per Workflow

daily-safe-output-optimizer.md

  • Creates GitHub issues for tool description improvements
  • Issue template already uses ### headers and <details> tags correctly (lines 233, 270, 274, 281)
  • Missing: Explicit Report Formatting guideline line in the Output Requirements section

spec-librarian.md

  • Creates GitHub issues for package specification audits
  • Issue template uses ### headers throughout
  • Mentions "Use progressive disclosure: Wrap details in <details> tags" in guidelines (line 331)
  • Missing: Explicit header level guideline ("Use h3 (###) or lower")

design-decision-gate.md

  • Adds PR review comments (blocking or approving)
  • Comment templates use ### headers and <details> tags correctly (line 323)
  • Missing: Any explicit formatting guideline for PR comment output

test-quality-sentinel.md

  • Adds PR quality review comments
  • Comment templates use ### headers and <details> tags (lines 393, 474)
  • Missing: Any explicit formatting guideline for PR comment output

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

Agent Task

For each workflow file listed in the table above, add the Report Formatting guideline instruction near the output/report generation section. No structural changes needed — the templates are already correct. This is a small, targeted addition to make the instruction explicit and consistent across all workflows.

References: Workflow Normalizer run §24696479755

Generated by Workflow Normalizer · ● 1.9M ·

  • expires on Apr 22, 2026, 12:02 AM UTC

Metadata

Metadata

Labels

cookieIssue Monster Loves Cookies!enhancementNew feature or request

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