Skip to content

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

@github-actions

Description

@github-actions

Workflows to Update

The following workflows generate reports but don't include markdown style guidelines in their prompts:

Workflow File Current Status
.github/workflows/api-consumption-report.md Missing header level and progressive disclosure guidelines
.github/workflows/daily-architecture-diagram.md Missing header level and progressive disclosure guidelines
.github/workflows/daily-cli-performance.md Missing header level and progressive disclosure guidelines
.github/workflows/daily-community-attribution.md Missing header level and progressive disclosure guidelines
.github/workflows/daily-experiment-report.md Missing header level and progressive disclosure guidelines
.github/workflows/daily-fact.md Missing header level and progressive disclosure guidelines
.github/workflows/daily-hippo-learn.md Missing header level and progressive disclosure guidelines
.github/workflows/daily-mcp-concurrency-analysis.md Missing header level and progressive disclosure guidelines
.github/workflows/daily-model-inventory.md Missing header level and progressive disclosure guidelines
.github/workflows/daily-news.md Missing header level and progressive disclosure guidelines

Required Changes

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

1. Header Levels

Add instruction before the report generation section:

**Report Formatting**: Use h3 (###) or lower for all headers in your report to maintain proper document hierarchy. Never use h1 (#) or h2 (##) — these are reserved for the issue title.

2. Progressive Disclosure

Add instruction for handling long content:

Wrap long sections in `<details><summary><b>Section Name</b></summary>` tags to improve readability and reduce scrolling. Keep critical information (summary, key metrics, recommendations) always visible, and collapse verbose details.

Example:
```markdown

View Full Analysis Details

[Long detailed content here...]

\`\`\`

3. Report Structure

Suggest a structure that follows progressive disclosure:

### Summary
[Brief overview - always visible]

### Key Metrics
[Critical numbers and stats - always visible]

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

[Comprehensive details, logs, traces]

</details>

### Recommendations
[Actionable next steps - always visible]

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

Example Reference Workflows

See these workflows for good examples of structured reporting with proper formatting guidelines:

  • .github/workflows/daily-repo-chronicle.md (lines 192-194)
  • .github/workflows/audit-workflows.md (line 102)
  • .github/workflows/daily-token-consumption-report.md (line 141)
  • .github/workflows/daily-safe-outputs-conformance.md (comprehensive example)

Implementation Guidelines

Where to add the guidelines:

  • Add the formatting instructions in the prompt section where report generation is described
  • Place them before the "Report Output" or "Output Format" section
  • Use a clear header like "Report Formatting Guidelines" or "Output Structure"

Testing:

  • After updating a workflow, review a recent run's output to verify the formatting is applied
  • Check that headers start at h3, critical info is visible, and details are collapsed
  • Ensure the report is readable and follows progressive disclosure

Acceptance Criteria

  • All 10 workflows have header level guidelines added
  • All 10 workflows have progressive disclosure instructions added
  • All 10 workflows include a suggested report structure
  • Guidelines are placed in a logical location in the prompt
  • At least one test run per workflow shows improved formatting

Generated by 🔧 Workflow Normalizer · ● 1.3M ·

  • expires on May 23, 2026, 1:42 PM UTC

Metadata

Metadata

Assignees

No one assigned

    Labels

    cookieIssue Monster Loves Cookies!documentationImprovements or additions to documentationenhancementNew 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