Skip to content

fix(scout): normalize report headers to h3 and bold summary tags#18364

Merged
pelikhan merged 2 commits intomainfrom
copilot/normalize-report-formatting-another-one
Feb 25, 2026
Merged

fix(scout): normalize report headers to h3 and bold summary tags#18364
pelikhan merged 2 commits intomainfrom
copilot/normalize-report-formatting-another-one

Conversation

Copy link
Contributor

Copilot AI commented Feb 25, 2026

scout.md output templates used h1/h2 headers and an unstyled <summary> tag, breaking document hierarchy consistency with other reporting workflows (ci-coach.md, ci-doctor.md, pr-triage-agent.md).

Changes

  • Header levels: Downgraded all report headers from h1/h2 to h3 in both output templates (findings and no-findings variants)
  • Sub-topics: Promoted inner topic headers from ### to #### to maintain correct nesting under the new ### sections
  • <summary> tag: Added <b> wrapping — <summary><b>Click to expand detailed findings</b></summary>
  • <details> spacing: Added blank line after <summary> and before </details> for proper markdown rendering inside collapsible blocks
  • Formatting guideline: Added explicit **Report Formatting** note to the ## Output Format section documenting the h3+ requirement and <details> pattern

Before → After (both templates):

# 🔍 Scout Research Report          →  ### 🔍 Scout Research Report
## Executive Summary                →  ### Executive Summary
<summary>Click to expand...</summary> →  <summary><b>Click to expand...</b></summary>
## Research Findings                →  ### Research Findings
## Recommendations                  →  ### Recommendations

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 tions-lock.json pkg/workflow/data/action_pins.json; \ echo &#34;��� Action pins synced successfullyinfocmp (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 .js (http block)
    • Triggering command: /usr/bin/gh gh api /repos/actions/github-script/git/ref/tags/v7 --jq .object.sha .json...&#34; (http block)
    • 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/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/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 (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</issue_title>
<issue_description>### Workflows to Update

The following workflows generate reports but don't follow markdown style guidelines:

Workflow File Issues Found
.github/workflows/scout.md Uses h1/h2 headers in output template; non-bold <summary> tag

Required Changes

.github/workflows/scout.md

The ## Output Format section (lines ~131–194) provides two markdown templates for the research comment, both using h1 and h2 headers.

Issues:

  1. # 🔍 Scout Research Report → should be ### 🔍 Scout Research Report
  2. ## Executive Summary → should be ### Executive Summary
  3. ## Research Findings → should be ### Research Findings
  4. ## Recommendations → should be ### Recommendations
  5. ## Key Sources → should be ### Key Sources
  6. ## Suggested Next Steps → should be ### Suggested Next Steps
  7. ## Search Conducted → should be ### Search Conducted
  8. ## Explanation → should be ### Explanation
  9. ## Suggestions → should be ### Suggestions
  10. <summary>Click to expand detailed findings</summary> → should use bold: <summary><b>Click to expand detailed findings</b></summary>

Before:

# 🔍 Scout Research Report

*Triggered by @...*

## Executive Summary
[Brief overview]

<details>
<summary>Click to expand detailed findings</summary>
## Research Findings
...
## Recommendations
...
</details>

After:

### 🔍 Scout Research Report

*Triggered by @...*

### Executive Summary
[Brief overview]

<details>
<summary><b>Click to expand detailed findings</b></summary>

### Research Findings
...

### Recommendations
...

</details>

Also add an explicit report formatting guideline to the ## Output Format section, similar to other workflows:

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

Design Principles (Airbnb-Inspired)

The updated workflow 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

See ci-coach.md, ci-doctor.md, pr-triage-agent.md for good examples of structured reporting with proper header levels and <details> formatting.

Agent Task

Update .github/workflows/scout.md to fix all h1/h2 headers in the output template to h3+, add bold to the <summary> tag, and add an explicit report formatting guideline to the Output Format section. After updating, run make recompile to regenerate the lock file.

References

Generated by Workflow Normalizer

  • expires on Feb 26, 2026, 1:53 PM UTC

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


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

…d summary tags

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Normalize report formatting for scout workflow fix(scout): normalize report headers to h3 and bold summary tags Feb 25, 2026
@pelikhan pelikhan marked this pull request as ready for review February 25, 2026 15:07
Copilot AI review requested due to automatic review settings February 25, 2026 15:07
@pelikhan pelikhan merged commit db4eeec into main Feb 25, 2026
@pelikhan pelikhan deleted the copilot/normalize-report-formatting-another-one branch February 25, 2026 15:07
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 the scout.md report output templates to match repository-wide markdown hierarchy conventions (h3+ headers) and improves <details>/<summary> rendering.

Changes:

  • Downgraded report template section headers from h1/h2 to h3, and adjusted topic headers to h4 to preserve nesting.
  • Updated <summary> to bold text and added spacing inside <details> blocks for reliable markdown rendering.
  • Added an explicit Report Formatting guideline to the ## Output Format section.

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

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