Skip to content

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

Description

@github-actions

Daily review of report-generating workflows (those with create-issue, create-discussion, or add-comment safe-outputs) found 34 non-compliant workflows out of 173 report-generating workflows scanned (285 total workflow files). Non-compliance means the prompt lacks explicit guidance for h3+ headers and <details>/progressive-disclosure formatting, and doesn't reference the shared reporting skill.

Style Guidelines (recap)

  1. Headers: start at ### (h3) or lower, never #/##.
  2. Progressive Disclosure: wrap long content in <details><summary><b>Text</b></summary>...</details>.
  3. Checkboxes: use - [ ] / - [x].
  4. Run links: format as [§12345](https://github.com/owner/repo/actions/runs/12345).

Good references: daily-repo-chronicle, audit-workflows (and any workflow that explicitly invokes the reporting skill/instructions).

Example: Progressive Disclosure

### Summary

Found 12 issues, 3 are high priority.

<details>
<summary><b>View all 12 issues</b></summary>

1. Issue A
2. Issue B
...

</details>

Non-Compliant Workflows

Workflow Header guidance (###) <details> usage Report structure notes
cli-consistency-checker.md
daily-vulnhunter-scan.md
dependabot-burner.md
duplicate-code-detector.md
eslint-refiner.md
semantic-function-refactor.md
sergo.md
smoke-agent-all-merged.md
smoke-agent-all-none.md
smoke-agent-public-approved.md
smoke-agent-public-none.md
smoke-agent-scoped-approved.md
smoke-aider.md
smoke-checkout-pr-dispatch.md
smoke-claude-on-copilot.md
smoke-claude.md
smoke-copilot-auto.md
smoke-copilot-mai.md
smoke-copilot-sdk.md
smoke-copilot-small.md
smoke-copilot-sub-agents.md
smoke-create-cross-repo-pr.md
smoke-github-claude.md
smoke-multi-pr.md
smoke-otel-backends.md
smoke-project.md
smoke-pydantic.md
smoke-service-ports.md
smoke-temporary-id.md
smoke-test-tools.md
smoke-update-cross-repo-pr.md
smoke-workflow-call.md
uk-ai-operational-resilience.md
unbloat-docs.md

(File paths are relative to .github/workflows/.)

Required Changes Per Workflow

For each file listed above:

  • Add explicit instruction that generated report content must use ### (h3) or lower for headers — never #/##.
  • Add a <details><summary><b>...</b></summary> block requirement for any long list/log output, to keep the primary report scannable.
  • Add or clarify an "Output Format" / "Report Structure" section describing the expected shape of the final report (mirroring daily-repo-chronicle or audit-workflows).
  • Recompile with make recompile after editing .md files under .github/workflows/.

Note: many smoke-* workflows are internal test fixtures rather than user-facing reports — for these, apply the lightest-touch fix (a one-line note pointing at the shared reporting skill) rather than a full rewrite, unless their safe-output content is genuinely user-facing.

Design Principles Reminder

Per Airbnb-inspired design principles: keep primary content trustworthy and scannable, hide supporting detail behind progressive disclosure, and use a consistent report shape across all workflows so users build confidence quickly regardless of which workflow produced the report.

Generated by 🔧 Workflow Normalizer · auto · 42 AIC · ⌖ 2.14 AIC · ⊞ 10.5K ·

  • expires on Aug 14, 2026, 5:10 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