Skip to content

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

@github-actions

Description

@github-actions

Overview

During a style compliance review of active reporting workflows, 16 scheduled workflows were identified that generate reports (issues/discussions) but lack proper markdown formatting instructions. These workflows don't import shared/reporting.md and don't include equivalent inline guidance for header levels or progressive disclosure.

All 76 compliant workflows already import .github/workflows/shared/reporting.md or include equivalent inline style guidelines — these 16 are the remaining gaps.

Workflows to Update

Workflow File Missing Guidance Output Type
.github/workflows/copilot-agent-analysis.md Header levels + Progressive disclosure Discussion
.github/workflows/copilot-pr-merged-report.md Header levels Discussion
.github/workflows/copilot-pr-nlp-analysis.md Header levels + Progressive disclosure Discussion
.github/workflows/copilot-pr-prompt-analysis.md Header levels + Progressive disclosure Discussion
.github/workflows/daily-cli-tools-tester.md Header levels + Progressive disclosure Issue
.github/workflows/daily-doc-healer.md Header levels + Progressive disclosure Issue
.github/workflows/dependabot-burner.md Header levels + Progressive disclosure Issue
.github/workflows/dependabot-go-checker.md Header levels + Progressive disclosure Issue
.github/workflows/docs-noob-tester.md Header levels + Progressive disclosure Discussion
.github/workflows/duplicate-code-detector.md Header levels + Progressive disclosure Issue
.github/workflows/go-pattern-detector.md Header levels + Progressive disclosure Issue
.github/workflows/gpclean.md Header levels + Progressive disclosure Issue
.github/workflows/issue-arborist.md Header levels + Progressive disclosure Issue + Discussion
.github/workflows/stale-repo-identifier.md Header levels + Progressive disclosure Issue
.github/workflows/terminal-stylist.md Header levels + Progressive disclosure Discussion
.github/workflows/claude-code-user-docs-review.md Header levels Discussion

Required Changes

The simplest fix for each workflow is to add the shared reporting import to the frontmatter:

imports:
  - .github/workflows/shared/reporting.md
```

Alternatively, add the following inline instructions to each workflow prompt:

#### 1. Header Levels
```
Use h3 (###) or lower for all headers in your report to maintain proper document hierarchy. Never use h1 (#) or h2 (##) — these are reserved for the issue/discussion title.
```

#### 2. Progressive Disclosure
```
Wrap long sections in `<details><summary><b>Section Name</b></summary>` tags to improve readability and reduce scrolling. Keep summary stats and critical issues always visible.

3. Recommended Report Structure

### Summary
- Key metric 1: value
- Key metric 2: value
- Status: ✅/⚠️/❌

### Critical Issues
[Always visible]

<details>
<summary><b>View Detailed Results</b></summary>

[Comprehensive details, logs, traces]

</details>

### Recommendations
[Actionable next steps]

Design Principles (Airbnb-Inspired)

The updated workflows 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

Reference

  • ✅ Good examples: daily-repo-chronicle, daily-observability-report, weekly-issue-summary
  • 📄 Shared style guide: .github/workflows/shared/reporting.md

Agent Task

For each workflow listed in the table above:

  1. Add - .github/workflows/shared/reporting.md to the imports: frontmatter field (preferred approach)
  2. Or add the formatting instructions inline in the prompt
  3. Compile and verify the updated workflows: make recompile

Workflow run: §23004972080

Generated by Workflow Normalizer ·

  • expires on Mar 13, 2026, 1:49 PM UTC

Metadata

Metadata

Labels

cookieIssue Monster Loves Cookies!

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions