Skip to content

Commit cb732db

Browse files
authored
fix(workflows): normalize report headers to h3+ and add progressive disclosure (#24201)
1 parent 78f2a16 commit cb732db

3 files changed

Lines changed: 36 additions & 28 deletions

File tree

.github/workflows/daily-safe-output-optimizer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@ Use the cache memory folder `/tmp/gh-aw/cache-memory/` to build persistent knowl
219219
**Issue Structure:**
220220

221221
```markdown
222-
# Improve [Tool Name] Description to Prevent Agent Errors
222+
### Improve [Tool Name] Description to Prevent Agent Errors
223223

224224
### Summary
225225

.github/workflows/dev-hawk.md

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ You monitor "Dev" workflow completions on copilot/* branches (workflow_dispatch
138138
139139
**Success:**
140140
```markdown
141-
# ✅ Dev Hawk Report - Success
141+
### ✅ Dev Hawk Report - Success
142142
**Workflow**: [#${{ github.event.workflow_run.run_number }}](${{ github.event.workflow_run.html_url }})
143143
- Status: ${{ github.event.workflow_run.conclusion }}
144144
- Commit: ${{ github.event.workflow_run.head_sha }}
@@ -148,30 +148,34 @@ Dev workflow completed successfully! 🎉
148148
149149
**Failure (with root cause identified):**
150150
```markdown
151-
# ⚠️ Dev Hawk Report - Failure Analysis
151+
### ⚠️ Dev Hawk Report - Failure Analysis
152152
**Workflow**: [#${{ github.event.workflow_run.run_number }}](${{ github.event.workflow_run.html_url }})
153153
- Status: ${{ github.event.workflow_run.conclusion }}
154154
- Commit: ${{ github.event.workflow_run.head_sha }}
155155
156-
## Root Cause Analysis
156+
#### Root Cause Analysis
157157
[Detailed explanation of what went wrong, correlating audit errors with PR changes]
158158
159-
### Affected Files
159+
##### Affected Files
160160
- `path/to/file.ext` - [Specific issue found]
161161
- `path/to/another.ext` - [Another issue if applicable]
162162
163-
## Error Details
163+
<details>
164+
<summary><b>🔍 Error Details</b></summary>
165+
164166
```
165167
[Key error messages from audit]
166168
```
167169
168-
## Agent Task Created
170+
</details>
171+
172+
#### Agent Task Created
169173
🤖 I've created an agent task for Copilot to fix this issue:
170174
- Task: [Agent Task URL or ID]
171175
172176
The task includes detailed instructions on what needs to be fixed and how to verify the solution.
173177
174-
## Manual Review
178+
#### Manual Review
175179
If you prefer to fix this manually:
176180
- [ ] [Specific fix step 1]
177181
- [ ] [Specific fix step 2]
@@ -180,18 +184,22 @@ If you prefer to fix this manually:
180184
181185
**Failure (without clear root cause):**
182186
```markdown
183-
# ⚠️ Dev Hawk Report - Failure
187+
### ⚠️ Dev Hawk Report - Failure
184188
**Workflow**: [#${{ github.event.workflow_run.run_number }}](${{ github.event.workflow_run.html_url }})
185189
- Status: ${{ github.event.workflow_run.conclusion }}
186190
- Commit: ${{ github.event.workflow_run.head_sha }}
187191
188-
## Analysis Summary
192+
#### Analysis Summary
189193
[Summary of failure from audit]
190194
191-
## Key Errors
195+
<details>
196+
<summary><b>🔍 Key Errors</b></summary>
197+
192198
[Error messages and patterns found]
193199
194-
## Investigation Needed
200+
</details>
201+
202+
#### Investigation Needed
195203
I couldn't automatically determine the exact root cause. This may require:
196204
- [ ] Manual review of the error logs
197205
- [ ] Deeper investigation of [specific area]

.github/workflows/pr-nitpick-reviewer.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ For each nitpick found, decide on the appropriate output type:
171171
**Format:**
172172
```json
173173
{
174-
"body": "## Overall Observations\n\nI noticed a few patterns across the PR:\n\n1. **Naming consistency**: Consider standardizing variable naming...\n2. **Good practices**: Excellent use of early returns!\n\nSee inline review comments for specific suggestions."
174+
"body": "### Overall Observations\n\nI noticed a few patterns across the PR:\n\n1. **Naming consistency**: Consider standardizing variable naming...\n2. **Good practices**: Excellent use of early returns!\n\nSee inline review comments for specific suggestions."
175175
}
176176
```
177177

@@ -192,66 +192,66 @@ Create a comprehensive markdown report using the imported `reporting.md` format:
192192
**Report Structure:**
193193

194194
```markdown
195-
# PR Nitpick Review Summary - [DATE]
195+
### PR Nitpick Review Summary - [DATE]
196196

197197
Brief overview of the review findings and key patterns observed.
198198

199199
<details>
200200
<summary><b>Full Review Report</b></summary>
201201

202-
## Pull Request Overview
202+
#### Pull Request Overview
203203

204204
- **PR #**: ${{ github.event.pull_request.number }}
205205
- **Title**: ${{ github.event.pull_request.title }}
206206
- **Triggered by**: ${{ github.actor }}
207207
- **Files Changed**: [count]
208208
- **Lines Added/Removed**: +[additions] -[deletions]
209209

210-
## Nitpick Categories
210+
#### Nitpick Categories
211211

212-
### 1. Naming and Conventions ([count] issues)
212+
##### 1. Naming and Conventions ([count] issues)
213213
[List of specific issues with file references]
214214

215-
### 2. Code Structure ([count] issues)
215+
##### 2. Code Structure ([count] issues)
216216
[List of specific issues]
217217

218-
### 3. Comments and Documentation ([count] issues)
218+
##### 3. Comments and Documentation ([count] issues)
219219
[List of specific issues]
220220

221-
### 4. Best Practices ([count] issues)
221+
##### 4. Best Practices ([count] issues)
222222
[List of specific issues]
223223

224-
## Pattern Analysis
224+
#### Pattern Analysis
225225

226-
### Recurring Themes
226+
##### Recurring Themes
227227
- **Theme 1**: [Description and frequency]
228228
- **Theme 2**: [Description and frequency]
229229

230-
### Historical Context
230+
##### Historical Context
231231
[If cache memory available, compare to previous reviews]
232232

233233
| Review Date | PR # | Nitpick Count | Common Themes |
234234
|-------------|------|---------------|---------------|
235235
| [today] | [#] | [count] | [themes] |
236236
| [previous] | [#] | [count] | [themes] |
237237

238-
## Positive Highlights
238+
#### Positive Highlights
239239

240240
Things done well in this PR:
241241
-[Specific good practice observed]
242242
-[Another good practice]
243243

244-
## Recommendations
244+
#### Recommendations
245245

246-
### For This PR
246+
##### For This PR
247247
1. [Specific actionable item]
248248
2. [Another actionable item]
249249

250-
### For Future PRs
250+
##### For Future PRs
251251
1. [General guidance for team]
252252
2. [Pattern to watch for]
253253

254-
## Learning Resources
254+
#### Learning Resources
255255

256256
[If applicable, links to style guides, best practices, etc.]
257257

0 commit comments

Comments
 (0)