Skip to content

[workflow-style] Normalize report formatting for weekly-issue-summary #11755

@github-actions

Description

@github-actions

Workflow to Update

Workflow File: .github/workflows/weekly-issue-summary.md
Issue: This workflow generates weekly issue summaries but doesn't include markdown style guidelines for progressive disclosure

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."

2. Progressive Disclosure

Add instruction: "Wrap long sections in <details><summary><b>Section Name</b></summary> tags to improve readability and reduce scrolling."

Example:

<details>
<summary><b>Full Issue List</b></summary>

[Long list of issues...]

</details>

3. Report Structure

Suggest a structure like:

  • Weekly overview and key trends (always visible)
  • Summary statistics (always visible)
  • Detailed issue breakdowns (in <details> tags)
  • Recommendations for upcoming week (always visible)

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 audit-workflows or daily-firewall-report for good examples of structured reporting with progressive disclosure.

Agent Task

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

AI generated by Workflow Normalizer

  • expires on Feb 1, 2026, 12:23 PM UTC

Metadata

Metadata

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