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

Open Beginner friendly
#75,172 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
77/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
github-actions, markdown

Research direction

Read .github/workflows/daily-work-queues-report.md and .github/workflows/metrics-collector.md, then compare their report guidance with .github/workflows/daily-repo-chronicle.md and .github/workflows/audit-workflows.md. Update both workflow prompts to specify the required headings, collapsible details, report order, visible metrics and limitations, and run-link format. Done when both prompts state those requirements and a subsequent active run produces reports with visible conclusions and collapsed long evidence.

Written by the indexing model from the issue text.

Description

automation cookie documentation
Summary

Two active reporting workflows need consistent Markdown output guidance so their reports are easier to scan and more trustworthy for readers.

Findings
Workflow Gaps
.github/workflows/daily-work-queues-report.md Relies on the reporting import but does not explicitly require h3-or-lower report headers or <details> blocks for long queue details. Its output instructions describe useful content, but not a complete overview → key metrics → collapsible details → next actions structure.
.github/workflows/metrics-collector.md Collects and summarizes metrics but does not specify h3-or-lower headers, progressive disclosure for long output, or a clear reader-facing report structure.
Required Changes

For each workflow:

  1. State that generated report headers must use ### or lower; reserve h1/h2 for the surrounding GitHub page.
  2. Require <details><summary><b>...</b></summary>...</details> for long tables, item lists, raw evidence, and detailed findings.
  3. Define a consistent report structure: overview → key metrics/issues → collapsible detail → next actions or limitations.
  4. Keep decision-relevant metrics and limitations visible before the collapsible sections.
  5. Use workflow run links in the standard [§RUN_ID](https://github.com/owner/repo/actions/runs/RUN_ID) form where runs are referenced.
Example
### Overview

One-paragraph conclusion and the most important limitation.

### Key Metrics

| Metric | Value |
|---|---:|
| Queue items | 12 |

<details>
<summary><b>Detailed findings</b></summary>

Long tables, evidence, and item-level context belong here.

</details>

### Next Actions

- [ ] Confirm the highest-priority item.

Use .github/workflows/daily-repo-chronicle.md and .github/workflows/audit-workflows.md as reference patterns for concise, user-focused reports with visible conclusions and collapsed detail.

Acceptance Criteria
  • Both workflow prompts explicitly document h3-or-lower headers.
  • Both prompts explicitly document progressive disclosure with <details> and bold summaries.
  • Both prompts define the overview → metrics/issues → detail → next-actions structure.
  • A subsequent active run produces reports that preserve visible conclusions while collapsing long evidence.

This issue consolidates the findings from the daily workflow-style review for the last 24 hours.

Generated by 🔧 Workflow Normalizer · codex · gpt56 · ~4 AIC · ⌖ ~1 AIC · ⊞ 15.3K · ◷

  • expires on Nov 6, 2026, 4:56 AM UTC-08:00
Dominant language
Go
Stars
5.6k
Forks
615
Avg merge
5h 36m
Merged PRs (30d)
805

Getting set up

Open in Codespaces

Starts the project's dev container in your browser, under your own GitHub account.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from github/gh-aw

All issues in github/gh-aw

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.