Skip to content

fix(workflows): normalize report headers to h3+ and add progressive disclosure#24201

Merged
pelikhan merged 2 commits intomainfrom
copilot/workflow-style-normalize-report-formatting
Apr 3, 2026
Merged

fix(workflows): normalize report headers to h3+ and add progressive disclosure#24201
pelikhan merged 2 commits intomainfrom
copilot/workflow-style-normalize-report-formatting

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 3, 2026

Four active workflows used h1/h2 headers in generated output (issue bodies, PR comments, discussion reports, review submissions), violating the project's markdown style guidelines.

Changes

  • daily-safe-output-optimizer.md: Issue body template title ####
  • dev-hawk.md: All PR comment template headers demoted (####, ######); verbose Error Details and Key Errors sections wrapped in <details> for progressive disclosure
  • pr-nitpick-reviewer.md: Discussion report template headers demoted (####, ######, ########); submit_pull_request_review body example ## Overall Observations### Overall Observations

Before / After (dev-hawk example)

# ⚠️ Dev Hawk Report - Failure Analysis   →   ### ⚠️ Dev Hawk Report - Failure Analysis
## Root Cause Analysis                     →   #### Root Cause Analysis
## Error Details                           →   <details><summary><b>🔍 Error Details</b></summary> … </details>

Reference compliant workflows (daily-observability-report.md, archie.md) were used as style examples. All 183 workflow lock files recompiled cleanly after edits.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • https://api.github.com/graphql
    • Triggering command: /usr/bin/gh /usr/bin/gh api graphql -f query=query($owner: String!, $name: String!) { repository(owner: $owner, name: $name) { hasDiscussionsEnabled } } -f owner=github -f name=gh-aw (http block)
    • Triggering command: /usr/bin/gh /usr/bin/gh api graphql -f query=query($owner: String!, $name: String!) { repository(owner: $owner, name: $name) { hasDiscussionsEnabled } } -f owner=github -f name=gh-aw UZj7DRpXR309 (http block)
  • https://api.github.com/repos/astral-sh/setup-uv/git/ref/tags/eac588ad8def6316056a12d4907a9d4d84ff7a3b
    • Triggering command: /usr/bin/gh gh api /repos/astral-sh/setup-uv/git/ref/tags/eac588ad8def6316056a12d4907a9d4d84ff7a3b --jq .object.sha (http block)
  • https://api.github.com/repos/github/gh-aw
    • Triggering command: /usr/bin/gh gh api /repos/github/gh-aw --jq .visibility (http block)
  • https://api.github.com/repos/github/gh-aw-actions/git/ref/tags/v0
    • Triggering command: /usr/bin/gh gh api /repos/github/gh-aw-actions/git/ref/tags/v0 --jq .object.sha (http block)
  • https://api.github.com/repos/githubnext/agentics/git/ref/tags/
    • Triggering command: /usr/bin/gh gh api /repos/githubnext/agentics/git/ref/tags/# --jq .object.sha (http block)

If you need me to access, download, or install something from one of these locations, you can either:



✨ PR Review Safe Output Test - Run 23928948104

💥 [THE END] — Illustrated by Smoke Claude · ● 275.5K ·

- daily-safe-output-optimizer.md: change h1 to h3 in issue body template title
- dev-hawk.md: change h1→h3, h2→h4 in all PR comment templates; wrap
  Error Details and Key Errors sections in <details> tags
- pr-nitpick-reviewer.md: change h1→h3, h2→h4 in discussion report
  template; change ## Overall Observations → ### in review body example
- Recompile all 183 workflow lock files

Agent-Logs-Url: https://github.com/github/gh-aw/sessions/a5b6d314-0919-414b-aae4-35e9f653d72e

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Normalize report formatting for non-compliant workflows fix(workflows): normalize report headers to h3+ and add progressive disclosure Apr 3, 2026
Copilot AI requested a review from pelikhan April 3, 2026 01:03
@pelikhan pelikhan marked this pull request as ready for review April 3, 2026 01:04
Copilot AI review requested due to automatic review settings April 3, 2026 01:04
@pelikhan pelikhan merged commit cb732db into main Apr 3, 2026
51 checks passed
@pelikhan pelikhan deleted the copilot/workflow-style-normalize-report-formatting branch April 3, 2026 01:04
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates generated markdown output templates in several GitHub agentic workflows to comply with the repository’s reporting guidelines by avoiding h1/h2 headers and adding progressive disclosure for verbose sections.

Changes:

  • Demotes report/comment headers to start at h3 (###) or lower across multiple workflow output templates.
  • Wraps verbose error sections in dev-hawk.md inside <details> blocks for progressive disclosure.
  • Updates example review submission body headers to match the normalized heading levels.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
.github/workflows/daily-safe-output-optimizer.md Demotes the issue body template’s top header from h1 to h3.
.github/workflows/dev-hawk.md Demotes PR comment template headers and adds <details> wrappers for error-heavy sections.
.github/workflows/pr-nitpick-reviewer.md Demotes discussion report template headers and updates the review submission example header level.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines +222 to 225
### Improve [Tool Name] Description to Prevent Agent Errors

### Summary

Copy link

Copilot AI Apr 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In this issue body template, the first header acts like a report title (h3). To match the repo’s report formatting convention (e.g., .github/workflows/ci-doctor.md:247-252 and .github/workflows/copilot-pr-merged-report.md:149-152), the subsequent sections (like “Summary”) should be one level deeper (####) or the title header should be removed entirely (since the GitHub issue title already serves as the document title).

See below for a potential fix:

#### Summary

Analysis of the last 24 hours of workflow runs identified **[N] errors** where agents incorrectly used the `[tool_name]` safe output tool. The workflow prompts appear correct, indicating the tool description needs improvement.

<details>
<summary><b>🔍 Error Analysis Details</b></summary>

#### Error Analysis

##### Error Pattern 1: [Description]

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

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

3 participants