Skip to content

fix: normalize header levels in api-consumption-report discussion template#25213

Merged
pelikhan merged 2 commits intomainfrom
copilot/update-report-formatting
Apr 8, 2026
Merged

fix: normalize header levels in api-consumption-report discussion template#25213
pelikhan merged 2 commits intomainfrom
copilot/update-report-formatting

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 8, 2026

api-consumption-report.md used #/## headers in its discussion body template, violating the project's style guidelines (h3 or lower required in report output).

Changes

  • Header normalization: All 9 headers in the discussion markdown template demoted from h1/h2 → h3 (###)
  • Formatting guideline: Added explicit **Report Formatting** bullet to the ## Guidelines section instructing the agent to use h3+ and <details> tags for long sections
-# 📊 GitHub API Consumption Report
+### 📊 GitHub API Consumption Report

-## Today at a Glance
+### Today at a Glance

Aligns with the patterns in daily-observability-report.md and daily-performance-summary.md.

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 6ny8QyGQUPS4 (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:



✨ PR Review Safe Output Test - Run 24111909192

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

Copilot AI changed the title [WIP] Normalize report formatting for non-compliant workflows fix: normalize header levels in api-consumption-report discussion template Apr 8, 2026
Copilot AI requested a review from pelikhan April 8, 2026 01:02
Copy link
Copy Markdown
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

💥 Automated smoke test review - all systems nominal!

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


```markdown
# 📊 GitHub API Consumption Report
### 📊 GitHub API Consumption Report
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Good change — using ### (h3) instead of # (h1) for the report title maintains proper document hierarchy since the discussion title already acts as h1. This follows the report formatting guidelines consistently.


## Guidelines

- **Report Formatting**: Use h3 (###) or lower for all headers in your report to maintain proper document hierarchy. Wrap long sections in `<details><summary>Section Name</summary>` tags to improve readability.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Excellent addition of the Report Formatting guideline. Explicitly documenting the <details><summary> pattern for long sections will help keep generated reports readable and prevent information overload.

@pelikhan pelikhan marked this pull request as ready for review April 8, 2026 04:25
Copilot AI review requested due to automatic review settings April 8, 2026 04:25
@pelikhan pelikhan merged commit 08c0d32 into main Apr 8, 2026
41 checks passed
@pelikhan pelikhan deleted the copilot/update-report-formatting branch April 8, 2026 04:25
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

Normalizes the discussion-template header hierarchy for the API consumption report so the generated discussion body complies with the project’s “H3+ only” report formatting guideline.

Changes:

  • Demoted all report-template headings from # / ## to ### to preserve document hierarchy.
  • Added a “Report Formatting” guideline bullet instructing use of H3+ headings and <details> for long sections.
Show a summary per file
File Description
.github/workflows/api-consumption-report.md Updates the embedded discussion markdown template to use H3 headers and adds an explicit formatting guideline for the reporting agent.

Copilot's findings

Tip

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

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


## Guidelines

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

Copilot AI Apr 8, 2026

Choose a reason for hiding this comment

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

The HTML example in the new guideline is incomplete: <details><summary>…</summary> by itself isn’t a complete wrapper and may lead to generated reports missing the closing </details> (or misunderstanding where content should go). Consider rewording to explicitly show <details>, a <summary>, the wrapped content, and a closing </details>.

Suggested change
- **Report Formatting**: Use h3 (###) or lower for all headers in your report to maintain proper document hierarchy. Wrap long sections in `<details><summary>Section Name</summary>` tags to improve readability.
- **Report Formatting**: Use h3 (###) or lower for all headers in your report to maintain proper document hierarchy. Wrap long sections in complete `<details><summary>Section Name</summary>…content…</details>` blocks to improve readability.

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