Skip to content

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

Description

@github-actions

Reviewed 21 active reporting workflows from the last 24 hours. 5 workflows are missing h3+ output header guidance, preventing consistent report formatting for GitHub issues, discussions, and PR reviews.

Summary

Metric Count
Workflows Reviewed 21
Compliant (via shared/reporting.md import or explicit guidance) 16
Non-Compliant 5

Non-Compliant Workflows

File Issue Upstream?
.github/workflows/avenger.md PR body instructions lack h3+ header guidance No
.github/workflows/impeccable-skills-reviewer.md Review body instructions lack explicit h3+ header guidance No
.github/workflows/pr-description-caveman.md PR description instructions lack h3+ header guidance No
.github/workflows/prompt-clustering-analysis.md Python generate_report() function uses # h1 and ## h2 headers in generated markdown No
.github/workflows/daily-team-status.md Missing both h3+ and <details> guidance Yes (read-only)

Required Changes

avenger.md — Add output header guidance

The PR body instructions currently say:

- Body: list what CI failures were found, what fixes were applied...

Add header guidance to the ## Pull Request Guidelines section:

- Use `###` or lower for any headers in the PR body — never `#` or `##`.
- Wrap long fix lists in `<details><summary>Fix Details</summary>` blocks.

Or simply add a shared import at the top of the imports section:

imports:
  - shared/reporting.md
impeccable-skills-reviewer.md — Add explicit h3+ guidance

The current constraint:

- Keep visible text concise; put long reasoning in `<details>` blocks.

Should be extended with header guidance:

- Use `###` or lower for any headers in review comments or summary — never `#` or `##`.
- Keep visible text concise; put long reasoning in `<details>` blocks.
pr-description-caveman.md — Add h3+ guidance to synthesizer

The pr-description-synthesizer agent instructions should include:

- Use `###` or lower for any section headers — never `#` or `##`.

Or add an import of shared/reporting.md.

prompt-clustering-analysis.md — Fix Python generate_report()

The Python function at line ~422 generates # h1 and ## h2 headers:

report.append("# Clustering Analysis Results\n")
report.append(f"\n## Cluster {cluster_id + 1}\n")

Should be changed to:

report.append("### Clustering Analysis Results\n")
report.append(f"\n#### Cluster {cluster_id + 1}\n")
daily-team-status.md — Upstream fix required

This workflow is managed upstream at githubnext/agentics/workflows/team-status.md@main. Changes must be made upstream and pulled in via gh aw update.

The upstream file needs:

  • h3+ header guidance for the issue body
  • <details> guidance for longer sections

Progressive Disclosure Example

The recommended pattern for all reporting workflows:

### Report Title

**One-line summary of what was found.**

| Key Metric | Value |
|------------|-------|
| Total items | N |

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

#### Details Section

Long lists and verbose content go here.

</details>

### Next Steps

- [ ] Action item 1
- [ ] Action item 2

Good References

  • .github/workflows/shared/reporting.md — the canonical style guide (shared import)
  • .github/workflows/daily-function-namer.md — inline h3+ guidance example
  • .github/workflows/api-consumption-report.md — explicit <details> and h3+ usage

Fix Options

For each non-compliant workflow, either:

  1. Add - shared/reporting.md to the imports: section (preferred), or
  2. Add explicit text to the output instructions section.

Generated by 🔧 Workflow Normalizer · 124.7 AIC · ⌖ 9.6 AIC · ⊞ 6.8K ·

  • expires on Jun 29, 2026, 5:18 AM UTC-08:00

Metadata

Metadata

Labels

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