Skip to content

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

Description

@github-actions

Consolidated review of workflow prompt files that generate reports (issues/discussions/comments) found several that don't give explicit markdown formatting guidance consistent with the style guide (h3+ headers, <details> progressive disclosure, clear report structure). Good reference examples already in the repo: daily-repo-chronicle.md, audit-workflows.md, daily-team-status.md.

Style guidelines (recap)

  • Headers: start at ### (h3) or lower in generated report content.
  • Progressive disclosure: wrap long/detailed content in <details><summary><b>...</b></summary>...</details>.
  • Report structure: overview → key metrics/issues → collapsible detail → next actions.

Non-compliant workflows

File Missing header guidance (h3+) Missing <details> guidance Notes
.github/workflows/agentic-token-audit.md Uses bare #/## in prompt; no explicit output header-level instruction
.github/workflows/agentic-token-trend-audit.md Same as above
.github/workflows/daily-awf-spec-compiler-surfacing.md No <details> usage instructed for long lists
.github/workflows/daily-cli-performance.md No progressive disclosure guidance
.github/workflows/daily-doc-healer.md No explicit header-level rule
.github/workflows/daily-geo-optimizer.md No explicit header-level rule
.github/workflows/daily-github-docs-seo-optimizer.md Neither header nor details guidance present
.github/workflows/daily-model-resolution.md No explicit header-level rule
.github/workflows/daily-multi-device-docs-tester.md No explicit header-level rule
.github/workflows/daily-safeoutputs-git-simulator.md No explicit header-level rule
.github/workflows/daily-spending-forecast.md No explicit header-level rule
.github/workflows/daily-squid-image-scan.md Only mentions <details> for license breakdowns, not general report structure
.github/workflows/designer-drift-audit.md Neither guidance present
.github/workflows/repo-audit-analyzer.md No explicit header-level rule

Required changes (each file above)

  1. Add an explicit "Reporting Guidelines" section (or equivalent) stating: generated report headers must start at ### (h3) or lower.
  2. Instruct wrapping long/detailed lists, logs, or tables in <details><summary><b>Text</b></summary>...</details> for progressive disclosure.
  3. Describe the report structure: overview → key metrics/issues → collapsible detail → next actions, matching the pattern used in daily-repo-chronicle.md / audit-workflows.md.

Example: progressive disclosure pattern

### Summary

- **Total items reviewed**: 42
- **Issues found**: 3

<details>
<summary><b>View detailed findings</b></summary>

1. Item A — description
2. Item B — description
3. Item C — description

</details>

### Next Steps

- [ ] Review flagged items
- [ ] Update workflow X

References

  • Good example: .github/workflows/daily-repo-chronicle.md
  • Good example: .github/workflows/audit-workflows.md
  • Good example: .github/workflows/daily-team-status.md

Generated by 🔧 Workflow Normalizer · auto · 38.5 AIC · ⌖ 4.95 AIC · ⊞ 10.4K ·

  • expires on Aug 2, 2026, 5:08 AM UTC-08:00

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