fix(pdf-summary): normalize report formatting to match style guidelines#25007
fix(pdf-summary): normalize report formatting to match style guidelines#25007
Conversation
- Add shared/reporting.md to imports - Change response template headers from #/## to ###/#### - Wrap Key Findings and Additional Notes in <details> tags - Add instruction about header levels and progressive disclosure - Recompile workflow Fixes #[issue] Agent-Logs-Url: https://github.com/github/gh-aw/sessions/98d932b5-1dae-4ed8-9ff0-acbd5cb89d96 Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Normalizes the pdf-summary workflow’s generated report formatting to match the repository’s reporting conventions (header hierarchy + progressive disclosure).
Changes:
- Imports
shared/reporting.mdinto thepdf-summaryprompt. - Updates the response template to use
###/####headers and wraps verbose sections in<details>blocks. - Regenerates
.github/workflows/pdf-summary.lock.ymlto reflect the updated prompt content/imports.
Show a summary per file
| File | Description |
|---|---|
.github/workflows/pdf-summary.md |
Adds shared/reporting.md import and adjusts the response template to use lower-level headers and <details> sections. |
.github/workflows/pdf-summary.lock.yml |
Regenerated lockfile to include the new import and updated prompt hash/embedded prompt content. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 2/2 changed files
- Comments generated: 1
|
|
||
| Your response should be formatted as: | ||
|
|
||
| Use h3 (###) or lower for all headers in your discussion report to maintain proper document hierarchy. Wrap long sections in `<details><summary>Section Name</summary>` tags to improve readability and reduce scrolling. |
There was a problem hiding this comment.
The new formatting instruction says “Use h3 (###) or lower for all headers in your discussion report…”, but this workflow also posts the response as an issue/PR comment (and optionally creates a discussion). To avoid the agent treating the header rule as discussion-only, consider aligning wording with existing workflows that apply it to all report outputs (e.g., .github/workflows/cli-version-checker.md:181 uses “Use h3 (###) or lower for all headers.”).
| Use h3 (###) or lower for all headers in your discussion report to maintain proper document hierarchy. Wrap long sections in `<details><summary>Section Name</summary>` tags to improve readability and reduce scrolling. | |
| Use h3 (###) or lower for all headers to maintain proper document hierarchy. Wrap long sections in `<details><summary>Section Name</summary>` tags to improve readability and reduce scrolling. |
pdf-summary.mdused#/##headers in its response template and lacked progressive disclosure — diverging from the reporting conventions followed by other daily/weekly report workflows.Changes
shared/reporting.md— pulls in header-level and<details>guidelines automatically#→###,##→####<details><summary>…</summary>blockspdf-summary.lock.ymlregenerated to reflect the updated markdownBefore / After (response template)
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://github.com/api/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 FASAOyC/MW4J11fm-1(http block)https://github.com/api/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://github.com/api/repos/github/gh-aw/usr/bin/gh gh api /repos/github/gh-aw --jq .visibility(http block)https://github.com/api/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: