Skip to content

Normalize report headers from h2 to h3 in 3 workflow templates#25414

Merged
pelikhan merged 2 commits intomainfrom
copilot/normalize-report-formatting
Apr 9, 2026
Merged

Normalize report headers from h2 to h3 in 3 workflow templates#25414
pelikhan merged 2 commits intomainfrom
copilot/normalize-report-formatting

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 9, 2026

GitHub issues and PR comments render inside a page with existing h1/h2 chrome — using ## in generated reports creates visual hierarchy conflicts. Three workflows were emitting ## top-level headers in their comment/issue templates.

Changes

  • daily-otel-instrumentation-advisor.md## 📡### 📡; wrap Implementation Steps checklist in <details> to reduce comment noise
  • test-quality-sentinel.md## 🧪### 🧪
  • design-decision-gate.md## 🏗️ / ## ✅ / ## ⚠️### equivalents (all three comment templates)

Example (otel advisor)

- ### 📡 OTel Instrumentation Improvement: <title>
+ <details>
+ <summary><b>Implementation Steps</b></summary>
  ...
+ </details>

Lock files regenerated via make recompile (187/187 compiled).

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/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/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:

Copilot AI changed the title [WIP] Update report formatting for non-compliant workflows Normalize report headers from h2 to h3 in 3 workflow templates Apr 9, 2026
Copilot AI requested a review from pelikhan April 9, 2026 00:54
@github-actions

This comment has been minimized.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 9, 2026

Hey @Copilot 👋 — the h2→h3 normalization in the three workflow comment templates is well-scoped and correctly addresses the visual hierarchy conflict with GitHub's page chrome. The per-file change breakdown in the PR description makes the intent clear.

One minor note: the <details> collapsible block added to daily-otel-instrumentation-advisor.md goes slightly beyond the stated goal of normalizing headers. If that's intentional, it's worth calling out explicitly in the PR description.

This is a markdown-only change and no conventional tests are applicable, so the needs-work signal here is mechanical rather than substantive. Once the PR is moved out of draft, it should be ready for a quick maintainer review. ✅

Generated by Contribution Check · ● 2.6M ·

@pelikhan pelikhan marked this pull request as ready for review April 9, 2026 02:34
Copilot AI review requested due to automatic review settings April 9, 2026 02:34
@pelikhan pelikhan merged commit 0b1222d into main Apr 9, 2026
52 of 54 checks passed
@pelikhan pelikhan deleted the copilot/normalize-report-formatting branch April 9, 2026 02:34
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

Adjusts generated GitHub issue/comment report templates to avoid using ## headings (which can conflict with the surrounding page’s existing H1/H2 structure).

Changes:

  • Normalize top-level report headers from ## to ### in three workflow templates.
  • Wrap “Implementation Steps” in the OTel advisor issue template in a <details> block to reduce noise.
Show a summary per file
File Description
.github/workflows/daily-otel-instrumentation-advisor.md Lowers the issue template’s title header to H3 and collapses the implementation checklist via <details>.
.github/workflows/test-quality-sentinel.md Lowers the comment template’s report title header to H3.
.github/workflows/design-decision-gate.md Lowers three different comment template titles to H3 (required/verified/diverges).

Copilot's findings

Tip

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

Comments suppressed due to low confidence (4)

.github/workflows/daily-otel-instrumentation-advisor.md:166

  • With the issue title header changed to H3, the subsequent section headers in this issue-body template (“### Problem”, “### Why This Matters…”, etc.) are now the same level as the title. If the intent is to keep a single top-level header while avoiding H1/H2 conflicts, consider making the title H3 and shifting the section headers down to H4 so the document structure remains clear.
```markdown
### 📡 OTel Instrumentation Improvement: <title>

**Analysis Date**: <date from `date +%Y-%m-%d`>  
**Priority**: High / Medium / Low  
**Effort**: Small (< 2h) / Medium (2–4h) / Large (> 4h)

### Problem

.github/workflows/design-decision-gate.md:228

  • This template’s title was lowered to an H3, but the body still uses H3 headings (e.g., “### What to do next”, “### Why ADRs Matter”), which removes the visual nesting that previously existed (H2 title → H3 sections). Consider shifting the internal headings in this template down one level (to H4) to preserve hierarchy while still avoiding H1/H2 conflicts.

This issue also appears in the following locations of the same file:

  • line 298
  • line 321
```markdown
### 🏗️ Design Decision Gate — ADR Required

This PR {has been labeled `implementation` / makes significant changes to core business logic (>100 new lines)} but does not have a linked Architecture Decision Record (ADR).

**AI has analyzed the PR diff and generated a draft ADR** to help you get started:

📄 **Draft ADR**: `docs/adr/{NNNN}-{title}.md`

### What to do next

.github/workflows/design-decision-gate.md:307

  • In this “ADR Verified” comment template, the title is now H3 but the subsections (e.g., “### Verification Summary”) remain H3, so the template loses its intended heading hierarchy. Consider changing the subsections to H4 to keep the title as the single top-level header while avoiding H1/H2 conflicts.
```markdown
### ✅ Design Decision Gate — ADR Verified

The implementation in this PR aligns with the stated Architecture Decision Record.

**ADR reviewed**: {ADR title and link}

### Verification Summary
{Brief summary of how the code matches the ADR decision}

.github/workflows/design-decision-gate.md:334

  • In this “Implementation Diverges from ADR” template, the title is now H3 but the subsections (e.g., “### Divergences Found”, “### What to do next”) are still H3, flattening the structure. Consider shifting these subsections to H4 so the title remains visually distinct while still avoiding H1/H2 conflicts.
Post a comment describing the discrepancies:
```markdown
### ⚠️ Design Decision Gate — Implementation Diverges from ADR

The implementation in this PR has divergences from the linked Architecture Decision Record.

**ADR reviewed**: {ADR title and link}

### Divergences Found

{List each divergence with specific file paths and explanation}

### What to do next

  • Files reviewed: 3/3 changed files
  • Comments generated: 1

## 🧪 Test Quality Sentinel Report
### 🧪 Test Quality Sentinel Report

### Test Quality Score: {SCORE}/100
Copy link

Copilot AI Apr 9, 2026

Choose a reason for hiding this comment

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

After lowering the report title to an H3, the rest of the section headings in this comment template are still H3 (e.g., “### Test Quality Score”, “### Test Classification Details”, etc.), so the report no longer has a clear header hierarchy. To preserve the previous structure (H2 title → H3 sections) while avoiding H1/H2 conflicts, consider keeping the title at H3 and shifting the internal section headings to H4.

Suggested change
### Test Quality Score: {SCORE}/100
#### Test Quality Score: {SCORE}/100

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

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

3 participants