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

Aperta Adatta ai principianti
#75,172 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
77/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
github-actions, markdown

Direzione di ricerca

Leggi .github/workflows/daily-work-queues-report.md e .github/workflows/metrics-collector.md, quindi confronta le indicazioni per i report con quelle di .github/workflows/daily-repo-chronicle.md e .github/workflows/audit-workflows.md. Aggiorna entrambi i prompt dei workflow in modo che specifichino i titoli richiesti, i dettagli comprimibili, l’ordine del report, le metriche e i limiti visibili e il formato dei link alle esecuzioni. Il lavoro è completo quando entrambi i prompt indicano questi requisiti e una successiva esecuzione attiva produce report con conclusioni visibili e prove dettagliate compresse.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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
Lingua principale
Go
Stelle
5.6k
Fork
615
Merge medio
5h 36m
PR unite (30g)
805

Preparare l'ambiente

Apri in Codespaces

Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di github/gh-aw

Tutte le issue di github/gh-aw

Issue simili

Altre issue su Go

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.