Skip to content

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

Closed as not planned

Description

@github-actions

Workflows to Update

The following workflow generates reports but has an embedded Output Format template that conflicts with the markdown style guidelines (despite importing shared/reporting.md):

Workflow File Issues Found
.github/workflows/workflow-health-manager.md Report template uses # (h1) and ## (h2) headers, contradicting the shared/reporting.md guidelines it imports

Details

workflow-health-manager.md imports shared/reporting.md which specifies "Never use ## (h2) or # (h1) in reports", but the inline Output Format template uses non-compliant headers throughout:

# Workflow Health Dashboard - [DATE]   ← h1 ❌

## Overview                            ← h2 ❌
## Critical Issues 🚨                  ← h2 ❌
## Warnings ⚠️                         ← h2 ❌
## Healthy Workflows ✅                 ← h2 ❌
## Systemic Issues                     ← h2 ❌
## Recommendations                     ← h2 ❌

Required Changes

Update the Output Format template in workflow-health-manager.md to use h3 (###) or lower, and wrap the potentially long "Healthy Workflows" list in a <details> block.

1. Remove h1 Title from Issue Body

The issue title is set by the create-issue safe output tool — the body should not repeat it as # Workflow Health Dashboard - [DATE]. Remove this line entirely.

2. Fix All h2 Section Headers → h3

Replace all ## headers in the template with ### and ####:

### Overview
- Total workflows: XXX
- Healthy: XXX (XX%)
- Warning: XXX (XX%)
- Critical: XXX (XX%)
- Inactive: XXX (XX%)

### Critical Issues 🚨

#### Workflow Name 1 (Score: XX/100)
...

### Warnings ⚠️

#### Workflow Name 3 (Score: XX/100)
...

### Healthy Workflows ✅

XXX workflows operating normally with no issues detected.

### Systemic Issues

#### Issue: API Rate Limiting
...

### Recommendations

#### High Priority
...

3. Add Progressive Disclosure for Healthy Workflows

Since the "Healthy Workflows" section can contain many entries, wrap detailed list in <details> tags:

### Healthy Workflows ✅

<details>
<summary><b>View All Healthy Workflows (XXX)</b></summary>

[List of healthy workflows]

</details>

Report Structure Reference

Per shared/reporting.md:

  • Use ### (h3) for main sections
  • Use #### (h4) for subsections
  • Never use ## (h2) or # (h1) in reports — these are reserved for titles
  • Wrap large lists in <details> tags for progressive disclosure

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

Compliance Context

This review covered 13 workflows from the last 24 hours and daily reporting workflows. 12 of 13 are compliant — only workflow-health-manager.md needs attention.

Compliant workflows (no action needed):

  • contribution-check.md ✅
  • daily-repo-chronicle.md ✅
  • daily-issues-report.md ✅
  • daily-firewall-report.md ✅
  • daily-observability-report.md ✅
  • weekly-issue-summary.md ✅
  • daily-performance-summary.md ✅
  • org-health-report.md ✅
  • daily-safe-outputs-conformance.md ✅
  • ai-moderator.md ✅ (not a reporting workflow)
  • issue-monster.md ✅ (not a reporting workflow)
  • daily-team-status.md ✅ (imports shared/reporting.md guidelines)

References: §22822105143

Generated by Workflow Normalizer · ◷

  • expires on Mar 9, 2026, 1:41 PM UTC

Activity

  1. github-actions commented on Mar 9, 2026

    @github-actions
    ContributorAuthor

    This issue was automatically closed because it expired on 2026-03-09T13:41:35.361Z.

    Closed by Workflow

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    cookieIssue Monster Loves Cookies!enhancementNew feature or request

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions