Skip to content

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

@github-actions

Description

@github-actions

Workflows to Update

The following workflows generate reports but are missing explicit markdown style guidelines in their prompt instructions. All use correct h3+ headers in their templates and most include <details> tags, but none contain an explicit instruction line directing the agent to follow the header hierarchy rule.

Reviewed in the last 24 hours (2026-04-10):

Workflow File Issues Found
.github/workflows/daily-observability-report.md Missing explicit h3 header instruction
.github/workflows/daily-performance-summary.md Missing explicit h3 header instruction
.github/workflows/daily-secrets-analysis.md Missing explicit h3 header instruction
.github/workflows/daily-safe-outputs-conformance.md Missing explicit h3 header instruction
.github/workflows/daily-compiler-quality.md Missing explicit h3 header instruction
.github/workflows/daily-code-metrics.md Missing explicit h3 header instruction

Already compliant: .github/workflows/api-consumption-report.md (has explicit h3 + details instructions)

Required Changes

For each workflow listed above, add an explicit formatting instruction near the Report Format or Discussion Format section.

Instruction to Add

**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.

Example (from api-consumption-report.md — reference implementation)

- **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.

Design Principles (Airbnb-Inspired)

The updated workflows should reinforce that their reports:

  1. Build trust through clarity: Most important info immediately visible
  2. Exceed expectations: Add helpful context and trends
  3. Create delight: Use progressive disclosure to reduce overwhelm
  4. Maintain consistency: Follow the same patterns as other reporting workflows

Context

These workflows already embed correctly-formatted report templates (h3+ headers, <details> tags), so the risk of non-compliance is low. Adding the explicit instruction line aligns them with the project's style standard and makes the intent unambiguous for future edits.

Agent Task

For each workflow listed in the table above, locate the Report Format, Discussion Format, or equivalent section, and add the formatting instruction line. Use .github/workflows/api-consumption-report.md as a reference for placement and wording.

Generated by Workflow Normalizer · ● 1.2M ·

  • expires on Apr 11, 2026, 11:59 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