Skip to content

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

@github-actions

Description

@github-actions

The following active reporting workflows generate reports (issues/discussions) but don't import shared/reporting.md and lack explicit markdown style guidelines in their prompts.

Workflows to Update

Workflow File Issues Found
.github/workflows/daily-otel-instrumentation-advisor.md Missing shared/reporting.md import; no explicit header-level or progressive-disclosure guidelines
.github/workflows/daily-compiler-quality.md Missing shared/reporting.md import; no explicit header-level guidelines (has good template examples but no instructional text)

Required Changes

For each workflow listed above, add the shared/reporting.md import to the imports: section in the frontmatter:

imports:
  - shared/reporting.md      # ← add this
  - shared/observability-otlp.md
  # ... existing imports ...

If there is no imports: section, add one to the frontmatter.

This import provides the agent with the following formatting guidelines:

1. Header Levels

Use h3 (###) or lower for all headers in your report to maintain proper document hierarchy.

2. Progressive Disclosure

Wrap long sections in <details><summary>Section Name</summary> tags to improve readability and reduce scrolling.

3. Report Structure

  • Brief summary (always visible)
  • Key metrics or highlights (always visible)
  • Detailed analysis (in <details> tags)
  • Recommendations (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

See .github/workflows/api-consumption-report.md or .github/workflows/audit-workflows.md for good examples of workflows that import shared/reporting.md.

Notes on Current State

  • daily-otel-instrumentation-advisor.md: The issue template already uses ### headers and has one <details> block for implementation steps. Adding the import will reinforce these patterns and ensure consistent formatting for any future edits.
  • daily-compiler-quality.md: The discussion template already has 3 <details> blocks and ### headers. Adding the import is a consistency improvement and ensures the agent receives the style guidelines explicitly.

Agent Task

For each workflow file listed in the table above:

  1. Add - shared/reporting.md to the imports: block in the frontmatter
  2. Verify the workflow compiles correctly: gh aw compile <workflow-name>
  3. Confirm no existing formatting in the prompt contradicts the new guidelines

Generated by Workflow Normalizer · ● 2.3M ·

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