Skip to content

Import shared reporting guidelines in workflow-health-manager#10984

Merged
pelikhan merged 3 commits intomainfrom
copilot/normalize-report-formatting
Jan 21, 2026
Merged

Import shared reporting guidelines in workflow-health-manager#10984
pelikhan merged 3 commits intomainfrom
copilot/normalize-report-formatting

Conversation

Copy link
Contributor

Copilot AI commented Jan 21, 2026

The workflow-health-manager creates GitHub issues for workflow health dashboards but lacked access to the standardized reporting guidelines used by other reporting workflows.

Changes

  • Added imports: [shared/reporting.md] to workflow frontmatter

What This Provides

The workflow now has access to:

  • Header level conventions (h3+ only, never h1/h2)
  • Progressive disclosure patterns via <details><summary> tags
  • Airbnb-inspired design principles for report clarity

This aligns workflow-health-manager with other reporting workflows like daily-repo-chronicle, daily-file-diet, and audit-workflows.

# Before
timeout-minutes: 20
---

# After
timeout-minutes: 20
imports:
  - shared/reporting.md
---
Original prompt

This section details on the original issue you should resolve

<issue_title>[workflow-style] Normalize report formatting for workflow-health-manager</issue_title>
<issue_description>### 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

Comments on the Issue (you are @copilot in this section)


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot AI and others added 2 commits January 21, 2026 13:18
Co-authored-by: mnkiefer <8320933+mnkiefer@users.noreply.github.com>
Co-authored-by: mnkiefer <8320933+mnkiefer@users.noreply.github.com>
Copilot AI changed the title [WIP] Update report formatting in workflow-health-manager Import shared reporting guidelines in workflow-health-manager Jan 21, 2026
Copilot AI requested a review from mnkiefer January 21, 2026 13:28
@pelikhan pelikhan marked this pull request as ready for review January 21, 2026 14:53
@pelikhan pelikhan merged commit bdf2e3d into main Jan 21, 2026
@pelikhan pelikhan deleted the copilot/normalize-report-formatting branch January 21, 2026 14:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

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

3 participants