fix: normalize header levels in api-consumption-report discussion template#25213
fix: normalize header levels in api-consumption-report discussion template#25213
Conversation
Agent-Logs-Url: https://github.com/github/gh-aw/sessions/a624f78b-6843-45cb-b4c8-a602cba9638a Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
There was a problem hiding this comment.
💥 Automated smoke test review - all systems nominal!
💥 [THE END] — Illustrated by Smoke Claude · ● 179.5K
|
|
||
| ```markdown | ||
| # 📊 GitHub API Consumption Report | ||
| ### 📊 GitHub API Consumption Report |
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
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>.
| - **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. |
api-consumption-report.mdused#/##headers in its discussion body template, violating the project's style guidelines (h3 or lower required in report output).Changes
###)**Report Formatting**bullet to the## Guidelinessection instructing the agent to use h3+ and<details>tags for long sectionsAligns with the patterns in
daily-observability-report.mdanddaily-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/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)/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/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/usr/bin/gh gh api /repos/github/gh-aw --jq .visibility(http block)https://api.github.com/repos/githubnext/agentics/git/ref/tags/-/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