Skip to content

[workflow-style] Normalize report formatting for workflow-health-manager #10974

@github-actions

Description

@github-actions

Workflow to Update

Workflow File: .github/workflows/workflow-health-manager.md
Issue: This workflow generates reports but doesn't import shared/reporting.md which contains markdown style guidelines

Required Changes

Add the import to the frontmatter:

imports:
  - shared/reporting.md

This will provide the workflow with:

1. Header Level Guidelines

  • Use h3 (###) or lower for all headers to maintain proper document hierarchy
  • Never use h2 (##) or h1 (#) in reports - these are reserved for titles

2. Progressive Disclosure Guidelines

  • Wrap long sections in <details><summary><b>Section Name</b></summary> tags
  • Keeps reports scannable and reduces overwhelming users with information
  • Critical information stays visible, details are collapsible

Example:

<details>
<summary><b>Full Analysis Details</b></summary>

[Long detailed content here...]

</details>

3. Report Structure Best Practices

  • Overview: 1-2 paragraphs summarizing key findings (always visible)
  • Critical Information: Summary stats, critical issues (always visible)
  • Details: Use <details> tags for expanded content
  • Context: Add helpful metadata (workflow run, date, trigger)

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 workflows like daily-repo-chronicle, daily-file-diet, or audit-workflows which already import shared/reporting.md and follow these guidelines.

Validation

After updating:

  1. Run the workflow manually with workflow_dispatch
  2. Verify the generated report follows proper header levels (h3+)
  3. Check that long sections use <details> tags for progressive disclosure
  4. Confirm critical information is immediately visible

Priority: High - This workflow creates issues and runs regularly (451 lines)

AI generated by Workflow Normalizer

  • expires on Jan 28, 2026, 12:26 PM UTC

Metadata

Metadata

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