Skip to content

Commit 5d9f7e2

Browse files
committed
Add reporting instructions for daily team status reports
1 parent 1e366aa commit 5d9f7e2

2 files changed

Lines changed: 82 additions & 0 deletions

File tree

workflows/daily-team-status.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ safe-outputs:
1717
create-discussion:
1818
title-prefix: "[team-status] "
1919
category: "announcements"
20+
imports:
21+
- ./shared/reporting.md
2022
---
2123

2224
# Daily Team Status

workflows/shared/reporting.md

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
---
2+
# No frontmatter configuration needed - this is a pure instructions file
3+
---
4+
5+
## Report Formatting
6+
7+
Structure your report with an overview followed by detailed content:
8+
9+
1. **Content Overview**: Start with 1-2 paragraphs that summarize the key findings, highlights, or main points of your report. This should give readers a quick understanding of what the report contains without needing to expand the details.
10+
11+
2. **Detailed Content**: Place the rest of your report inside HTML `<details>` and `<summary>` tags to allow readers to expand and view the full information. **IMPORTANT**: Always wrap the summary text in `<b>` tags to make it bold.
12+
13+
**Example format:**
14+
15+
`````markdown
16+
Brief overview paragraph 1 introducing the report and its main findings.
17+
18+
Optional overview paragraph 2 with additional context or highlights.
19+
20+
<details>
21+
<summary><b>Full Report Details</b></summary>
22+
23+
## Detailed Analysis
24+
25+
Full report content with all sections, tables, and detailed information goes here.
26+
27+
### Section 1
28+
[Content]
29+
30+
### Section 2
31+
[Content]
32+
33+
</details>
34+
`````
35+
36+
## Reporting Workflow Run Information
37+
38+
When analyzing workflow run logs or reporting information from GitHub Actions runs:
39+
40+
### 1. Workflow Run ID Formatting
41+
42+
**Always render workflow run IDs as clickable URLs** when mentioning them in your report. The workflow run data includes a `url` field that provides the full GitHub Actions run page URL.
43+
44+
**Format:**
45+
46+
`````markdown
47+
[§12345](https://github.com/owner/repo/actions/runs/12345)
48+
`````
49+
50+
**Example:**
51+
52+
`````markdown
53+
Analysis based on [§456789](https://github.com/githubnext/gh-aw/actions/runs/456789)
54+
`````
55+
56+
### 2. Document References for Workflow Runs
57+
58+
When your analysis is based on information mined from one or more workflow runs, **include up to 3 workflow run URLs as document references** at the end of your report.
59+
60+
**Format:**
61+
62+
`````markdown
63+
---
64+
65+
**References:**
66+
- [§12345](https://github.com/owner/repo/actions/runs/12345)
67+
- [§12346](https://github.com/owner/repo/actions/runs/12346)
68+
- [§12347](https://github.com/owner/repo/actions/runs/12347)
69+
`````
70+
71+
**Guidelines:**
72+
73+
- Include **maximum 3 references** to keep reports concise
74+
- Choose the most relevant or representative runs (e.g., failed runs, high-cost runs, or runs with significant findings)
75+
- Always use the actual URL from the workflow run data (specifically, use the `url` field from `RunData` or the `RunURL` field from `ErrorSummary`)
76+
- If analyzing more than 3 runs, select the most important ones for references
77+
78+
## Footer Attribution
79+
80+
**Do NOT add footer lines** like `> AI generated by...` to your comment. The system automatically appends attribution after your content to prevent duplicates.

0 commit comments

Comments
 (0)