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

Đang mở Phù hợp với người mới
  • Có gì không ổn?
#75,172 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
77/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
github-actions, markdown
Lĩnh vực
ci-cd, documentation

Hướng nghiên cứu

Đọc .github/workflows/daily-work-queues-report.md và .github/workflows/metrics-collector.md, sau đó so sánh hướng dẫn báo cáo của chúng với .github/workflows/daily-repo-chronicle.md và .github/workflows/audit-workflows.md. Cập nhật cả hai workflow prompt để nêu rõ các tiêu đề bắt buộc, phần chi tiết có thể thu gọn, thứ tự báo cáo, các chỉ số và giới hạn hiển thị, cũng như định dạng liên kết đến lượt chạy. Hoàn tất khi cả hai prompt nêu các yêu cầu này và một lượt chạy đang hoạt động tiếp theo tạo ra báo cáo có kết luận hiển thị và bằng chứng dài được thu gọn.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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
Ngôn ngữ chính
Go
Star
5.6k
Fork
615
Merge trung bình
5 giờ 36 phút
Pull request đã merge (30 ngày)
805

Chuẩn bị môi trường

Mở trong Codespaces

Khởi chạy dev container của dự án ngay trên trình duyệt, bằng tài khoản GitHub của bạn.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của github/gh-aw

Tất cả issue của github/gh-aw

Issue tương tự

Thêm issue về Go

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.