Skip to content

Normalize report formatting across four workflows (h3+ headers, progressive disclosure)#17377

Merged
pelikhan merged 2 commits intomainfrom
copilot/normalize-report-formatting-workflows
Feb 21, 2026
Merged

Normalize report formatting across four workflows (h3+ headers, progressive disclosure)#17377
pelikhan merged 2 commits intomainfrom
copilot/normalize-report-formatting-workflows

Conversation

Copy link
Contributor

Copilot AI commented Feb 21, 2026

Four workflows were generating reports with h1/h2 headers and no <details> progressive disclosure, violating the formatting standards established in daily-file-diet.md and ci-coach.md.

Changes

  • pr-triage-agent.md: PR comment #####; report template #/#####; "By Category/Risk/Priority" stats wrapped in <details>; formatting instruction added
  • ci-doctor.md: Issue template #/#####; "Investigation Findings" and "Historical Context" wrapped in <details>; formatting instruction added
  • contribution-check.md: Example report #####; "Off-guidelines" table wrapped in <details>; formatting instruction added to Report Layout Rules
  • draft-pr-cleanup.md: Summary template #####, sub-sections #######; "PRs Warned/Closed This Run" wrapped in <details>; formatting instruction added

Pattern applied (consistent with reference workflows)

**Report Formatting**: Use h3 (###) or lower for all headers in the report. Wrap long sections (>10 items) in `<details><summary><b>Section Name</b></summary>` tags to improve readability.

<details>
<summary><b>By Category</b></summary>

- Bug: {bug_count}
...

</details>

Lock files regenerated via make recompile.

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)
  • https://api.github.com/repos/actions/checkout/git/ref/tags/11bd71901bbe5b1630ceea73d27597364c9af683
    • Triggering command: /usr/bin/gh gh api /repos/actions/checkout/git/ref/tags/11bd71901bbe5b1630ceea73d27597364c9af683 --jq .object.sha (http block)
  • https://api.github.com/repos/actions/checkout/git/ref/tags/v6
    • Triggering command: /usr/bin/gh gh api /repos/actions/checkout/git/ref/tags/v6 --jq .object.sha (http block)
  • https://api.github.com/repos/actions/github-script/git/ref/tags/v7
    • Triggering command: /usr/bin/gh gh api /repos/actions/github-script/git/ref/tags/v7 --jq .object.sha (http block)
  • https://api.github.com/repos/actions/setup-go/git/ref/tags/4dc6199c7b1a012772edbd06daecab0f50c9053c
    • Triggering command: /usr/bin/gh gh api /repos/actions/setup-go/git/ref/tags/4dc6199c7b1a012772edbd06daecab0f50c9053c --jq .object.sha (http block)
  • https://api.github.com/repos/actions/setup-go/git/ref/tags/v5
    • Triggering command: /usr/bin/gh gh api /repos/actions/setup-go/git/ref/tags/v5 --jq .object.sha (http block)
  • https://api.github.com/repos/actions/setup-go/git/ref/tags/v6
    • Triggering command: /usr/bin/gh gh api /repos/actions/setup-go/git/ref/tags/v6 --jq .object.sha (http block)
  • https://api.github.com/repos/actions/setup-node/git/ref/tags/v6
    • Triggering command: /usr/bin/gh gh api /repos/actions/setup-node/git/ref/tags/v6 --jq .object.sha (http block)
  • https://api.github.com/repos/anchore/sbom-action/git/ref/tags/v0
    • Triggering command: /usr/bin/gh gh api /repos/anchore/sbom-action/git/ref/tags/v0 --jq .object.sha (http block)
  • https://api.github.com/repos/docker/build-push-action/git/ref/tags/v6
    • Triggering command: /usr/bin/gh gh api /repos/docker/build-push-action/git/ref/tags/v6 --jq .object.sha (http block)
  • https://api.github.com/repos/docker/login-action/git/ref/tags/v3
    • Triggering command: /usr/bin/gh gh api /repos/docker/login-action/git/ref/tags/v3 --jq .object.sha (http block)
  • https://api.github.com/repos/docker/metadata-action/git/ref/tags/v5
    • Triggering command: /usr/bin/gh gh api /repos/docker/metadata-action/git/ref/tags/v5 --jq .object.sha (http block)
  • https://api.github.com/repos/docker/setup-buildx-action/git/ref/tags/v3
    • Triggering command: /usr/bin/gh gh api /repos/docker/setup-buildx-action/git/ref/tags/v3 --jq .object.sha ./cmd/gh-aw (http block)
    • Triggering command: /usr/bin/gh gh api /repos/docker/setup-buildx-action/git/ref/tags/v3 --jq .object.sha (http block)
  • https://api.github.com/repos/github/gh-aw/git/ref/tags/a70c5eada06553e3510ac27f2c3bda9d3705bccb
    • Triggering command: /usr/bin/gh gh api /repos/github/gh-aw/git/ref/tags/a70c5eada06553e3510ac27f2c3bda9d3705bccb --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:

Original prompt

This section details on the original issue you should resolve

<issue_title>[workflow-style] Normalize report formatting for non-compliant workflows (2026-02-20)</issue_title>
<issue_description>### Workflows to Update

The following workflows generate reports but use h1/h2 headers and lack progressive disclosure guidelines:

Workflow File Issues Found
.github/workflows/pr-triage-agent.md Report template uses # PR Triage Report (h1) and ## Executive Summary, ## Triage Statistics, etc. (h2); no <details> tags
.github/workflows/ci-doctor.md Issue template uses # 🏥 CI Failure Investigation (h1) and ## Summary, ## Root Cause Analysis, etc. (h2); no <details> tags
.github/workflows/contribution-check.md Example report uses ## Contribution Check — {date} (h2) as top-level header; no <details> progressive disclosure
.github/workflows/draft-pr-cleanup.md Comment template uses ## 🧹 Draft PR Cleanup Summary (h2) and ### Statistics; no <details> tags

Required Changes

For each workflow listed above, update the embedded report/issue/comment template to follow these formatting guidelines:

1. Header Levels

Replace all # (h1) and ## (h2) headers in report output templates with ### (h3) or lower.

  • # PR Triage Report - {date} → ✅ ### PR Triage Report - {date}
  • ## Executive Summary → ✅ ### Executive Summary
  • # 🏥 CI Failure Investigation → ✅ ### CI Failure Investigation
  • ## Contribution Check — {date} → ✅ ### Contribution Check — {date}
  • ## 🧹 Draft PR Cleanup Summary → ✅ ### Draft PR Cleanup Summary

2. Progressive Disclosure

Wrap long or verbose sections in <details> tags to improve readability:

<details>
<summary><b>Full Analysis Details</b></summary>

[Long detailed content here, e.g. per-PR breakdown, investigation findings...]

</details>

Candidates for wrapping:

  • pr-triage-agent.md: Wrap "By Category", "By Risk Level", "By Priority" breakdowns
  • ci-doctor.md: Wrap "Investigation Findings" and "Historical Context"
  • contribution-check.md: Wrap the per-PR detailed verdicts table when there are many PRs
  • draft-pr-cleanup.md: Wrap "PRs Warned This Run" and "PRs Closed This Run" lists

3. Add Style Instructions to Prompt

Also add an explicit formatting instruction paragraph before the report template, e.g.:

**Report Formatting**: Use h3 (###) or lower for all headers in the report. Wrap long sections (>10 items) in `<details><summary><b>Section Name</b></summary>` tags to improve readability.

Design Principles (Airbnb-Inspired)

Updated workflows should create reports that:

  1. Build trust through clarity: Most important info immediately visible
  2. Exceed expectations: Add helpful context, trends, comparisons
  3. Create delight: Use progressive disclosure to reduce overwhelm
  4. Maintain consistency: Follow the same patterns as other reporting workflows

Reference — Compliant Workflows

See these workflows for good examples of structured reporting:

  • daily-file-diet.md — Explicit h3+ and <details> guidelines ✅
  • ci-coach.md — Explicit h3+ and <details> guidelines ✅

Agent Task

Update each workflow file listed in the table above to:

  1. Replace h1/h2 headers in report templates with h3+
  2. Add <details> wrapping for long sections
  3. Add a formatting instruction to the prompt
  4. Run make recompile after each change to regenerate lock files

Generated by Workflow Normalizer

  • expires on Feb 21, 2026, 1:49 PM UTC

Comments on the Issue (you are @copilot in this section)


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

…ribution-check, draft-pr-cleanup workflows

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Normalize report formatting for non-compliant workflows Normalize report formatting across four workflows (h3+ headers, progressive disclosure) Feb 21, 2026
@pelikhan pelikhan marked this pull request as ready for review February 21, 2026 03:17
Copilot AI review requested due to automatic review settings February 21, 2026 03:17
@pelikhan pelikhan merged commit e1e884c into main Feb 21, 2026
@pelikhan pelikhan deleted the copilot/normalize-report-formatting-workflows branch February 21, 2026 03:18
Copy link
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

Normalizes report output formatting across four agent workflows to comply with existing report layout standards (h3+ headers and progressive disclosure via <details>).

Changes:

  • Updated embedded report/comment templates to use ### (h3) or lower headers instead of #/##.
  • Added explicit “Report Formatting” instructions to each workflow prompt/template section.
  • Wrapped verbose sections (stats / per-item lists) in <details> blocks for progressive disclosure.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.

File Description
.github/workflows/pr-triage-agent.md Converts report/comment headers to h3+ and wraps breakdown stats in <details>.
.github/workflows/ci-doctor.md Converts investigation issue template headers to h3+ and collapses deep-dive sections with <details>.
.github/workflows/contribution-check.md Updates example report header level and adds <details> progressive disclosure for per-PR details.
.github/workflows/draft-pr-cleanup.md Normalizes summary report header levels and collapses warned/closed PR lists with <details>.

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


```markdown
# 🏥 CI Failure Investigation - Run #${{ github.event.workflow_run.run_number }}
### CI Failure Investigation - Run #${{ github.event.workflow_run.run_number }}
Copy link

Copilot AI Feb 21, 2026

Choose a reason for hiding this comment

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

This changes the investigation issue title content by removing the 🏥 emoji (not just the header level). If the intent of this PR is only formatting normalization, consider keeping the original title text and only adjusting the heading level.

Copilot uses AI. Check for mistakes.
| PR | Title | Author | Lines | Quality |
|----|-------|--------|------:|---------|
| #4519 | Add unrelated marketing page | @dave | 42 | spam |

Copy link

Copilot AI Feb 21, 2026

Choose a reason for hiding this comment

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

For GitHub-flavored Markdown, tables inside a

Details block are more reliably rendered when there’s a blank line before the closing
tag. Add an empty line between the table and to match the established pattern in .github/workflows/shared/reporting.md.

Suggested change

Copilot uses AI. Check for mistakes.
Comment on lines +254 to 256
### 🔍 PR Triage Results

**Category:** {category} | **Risk:** {risk} | **Priority:** {priority_score}/100
Copy link

Copilot AI Feb 21, 2026

Choose a reason for hiding this comment

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

Lowering the PR comment title to h3 makes the existing subsections (e.g., "Scores Breakdown" / "Recommended Action") the same header level as the title, which flattens the hierarchy. Consider demoting those subsections to h4 so they’re clearly nested under "PR Triage Results" while still staying at h3+ overall.

See below for a potential fix:

#### Scores Breakdown
- **Impact:** {impact_score}/50 - {impact_rationale}
- **Urgency:** {urgency_score}/30 - {urgency_rationale}
- **Quality:** {quality_score}/20 - {quality_rationale}

#### 📋 Recommended Action: {action}

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 (2026-02-20)

3 participants