Skip to content

[workflow-style] Normalize report formatting for ci-coach #16116

@github-actions

Description

@github-actions

Workflow to Update

Workflow File: .github/workflows/ci-coach.md
Issue: This workflow generates CI optimization reports but doesn't include markdown style guidelines

Required Changes

Update the workflow prompt to include these formatting guidelines:

1. Header Levels

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

Example:

### CI Optimization Opportunities
#### Performance Analysis

2. Progressive Disclosure

Add instruction: "Wrap detailed sections like full job logs, timing breakdowns, and verbose analysis in <details><summary><b>Section Name</b></summary> tags to improve readability and reduce scrolling."

Example:

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

[Per-job timing breakdown...]

</details>

3. Report Structure

Suggest a structure like:

  • Executive summary with key optimizations (always visible)
  • Top optimization opportunities (always visible)
  • Detailed analysis per workflow (in <details> tags)
  • Actionable recommendations (always visible)

Design Principles (Airbnb-Inspired)

The updated workflow should create reports that:

  1. Build trust through clarity: Most important optimization opportunities immediately visible
  2. Exceed expectations: Add helpful context like estimated time savings, cost impact
  3. Create delight: Use progressive disclosure to present deep analysis without overwhelming
  4. Maintain consistency: Follow the same patterns as other reporting workflows

Example Reference

See workflows like daily-copilot-token-report, daily-code-metrics, or auto-triage-issues for good examples of structured reporting with progressive disclosure.

Agent Task

Update the workflow file .github/workflows/ci-coach.md to include the formatting guidelines above in the prompt instructions. Test the updated workflow to ensure it produces well-formatted reports.

Generated by Workflow Normalizer

  • expires on Feb 17, 2026, 1:49 PM UTC

Metadata

Metadata

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