Skip to content

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

@github-actions

Description

@github-actions

Workflows to Update

The following active workflows generate reports but don't follow the project's markdown style guidelines:

Workflow File Issues Found
.github/workflows/api-consumption-report.md Uses # (h1) and ## (h2) headers in discussion template; should use ### (h3) or lower

Required Changes

Update the discussion body template in api-consumption-report.md to replace all top-level headers:

1. Header Levels

Change the discussion template headers from h1/h2 to h3/h4:

  • # 📊 GitHub API Consumption Report### 📊 GitHub API Consumption Report
  • ## Today at a Glance### Today at a Glance
  • ## 🔗 GitHub API Calls Trend (90 days)### 🔗 GitHub API Calls Trend (90 days)
  • ## 🔗 GitHub API Calls by Workflow Trend (30 days)### 🔗 GitHub API Calls by Workflow Trend (30 days)
  • ## 🔗 GitHub REST API Calls Heatmap (90 days)### 🔗 GitHub REST API Calls Heatmap (90 days)
  • ## 🍩 Top API Burners (24h)### 🍩 Top API Burners (24h)
  • ## 🔗 GitHub REST API Consumption by Workflow (last 24h)### 🔗 GitHub REST API Consumption by Workflow (last 24h)
  • ## Top 10 Workflows by REST API Consumption (last 24h)### Top 10 Workflows by REST API Consumption (last 24h)
  • ## Trending Indicators### Trending Indicators

2. Add Formatting Guidelines to Prompt

Add an explicit instruction to the workflow prompt:

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

Example Reference

See .github/workflows/daily-observability-report.md and .github/workflows/daily-performance-summary.md for good examples of structured reporting using h3 headers and <details> tags.

Agent Task

Update .github/workflows/api-consumption-report.md to use h3/h4 headers throughout the discussion template and add formatting guidelines to the prompt instructions.


Workflow Style Normalization Report — 2026-04-07

Period: Last 24 hours
Workflows Reviewed: 4 active reporting workflows
Non-compliant: 1

View Detailed Findings

Reviewed Workflows

Workflow Status Notes
daily-semgrep-scan.md ✅ Compliant Not a report generator (code scanning alerts only)
daily-observability-report.md ✅ Compliant Uses h3 headers + <details> tags throughout
daily-performance-summary.md ✅ Compliant Uses h3 headers + <details> tags throughout
api-consumption-report.md ❌ Non-compliant Uses # and ## in discussion template

Next Steps

  • Update .github/workflows/api-consumption-report.md with corrected header levels
  • Verify next run produces a compliant discussion

Generated by Workflow Normalizer · ● 437.6K ·

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