Skip to content

[workflow-style] Normalize report formatting for non-compliant workflows #30147

@github-actions

Description

@github-actions

Workflows to Update

The following active workflow generates reports (discussions) but uses ## (h2) headers in the output template and does not import shared/reporting.md:

Workflow File Issues Found
.github/workflows/copilot-pr-nlp-analysis.md Discussion body template uses ## Executive Summary, ## Sentiment Analysis, ## Topic Analysis, etc. — all h2 headers; missing shared/reporting.md import; no <details> progressive disclosure for long sections

Required Changes

1. Add shared/reporting.md import

In .github/workflows/copilot-pr-nlp-analysis.md, add to the imports section:

imports:
  - uses: shared/daily-audit-base.md
    ...
  - shared/reporting.md   # ← add this

2. Fix Header Levels in Discussion Body Template

Change all ## headers in the report output section (Phase 6 discussion template, lines ~258–416) to ### :

### Executive Summary     ← was: ## Executive Summary
### Sentiment Analysis    ← was: ## Sentiment Analysis
### Topic Analysis        ← was: ## Topic Analysis
### Keyword Trends        ← was: ## Keyword Trends
### Conversation Patterns ← was: ## Conversation Patterns
### Insights and Trends   ← was: ## Insights and Trends
### Sentiment by Message Type  ← was: ## Sentiment by Message Type
### PR Highlights         ← was: ## PR Highlights
### Historical Context    ← was: ## Historical Context
### Recommendations       ← was: ## Recommendations

3. Add Progressive Disclosure for Long Sections

Wrap the "Methodology" and "Historical Context" sections in <details> tags:

<details>
<summary><b>Methodology</b></summary>

[methodology content...]

</details>

Design Principles (Airbnb-Inspired)

The updated workflow should create discussions 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 copilot-token-audit.md, api-consumption-report.md, and daily-token-consumption-report.md as good examples with ### headers and proper <details> usage.

Agent Task

Update .github/workflows/copilot-pr-nlp-analysis.md to:

  1. Add shared/reporting.md to the imports section in the frontmatter
  2. Replace all ## headers in the discussion body template with ###
  3. Wrap long secondary sections (Methodology, Historical Context) in <details> tags
  4. Run make recompile after the change

Generated by Workflow Normalizer · ● 1.2M ·

  • expires on May 5, 2026, 1:20 PM UTC

Metadata

Metadata

Labels

cookieIssue Monster Loves Cookies!

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