Skip to content

fix(pdf-summary): normalize report formatting to match style guidelines#25007

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

fix(pdf-summary): normalize report formatting to match style guidelines#25007
pelikhan merged 2 commits intomainfrom
copilot/normalize-report-formatting

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 7, 2026

pdf-summary.md used #/## headers in its response template and lacked progressive disclosure — diverging from the reporting conventions followed by other daily/weekly report workflows.

Changes

  • Import shared/reporting.md — pulls in header-level and <details> guidelines automatically
  • Downgrade headers — response template ####, ######
  • Progressive disclosure — wrap verbose sections ("Key Findings", "Additional Notes") in <details><summary>…</summary> blocks
  • Explicit formatting instruction — added inline guidance before the template block so the agent knows to apply these rules at generation time
  • Recompilepdf-summary.lock.yml regenerated to reflect the updated markdown

Before / After (response template)

-# 📊 Resource Analysis
+### 📊 Resource Analysis
 
-## Key Findings
-- **Finding 1**: ...
+<details>
+<summary><b>Key Findings</b></summary>
+
+- **Finding 1**: ...
+
+</details>

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
    • 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 FASAOyC/MW4J11fm-1 (http block)
  • https://github.com/api/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://github.com/api/repos/github/gh-aw
    • Triggering command: /usr/bin/gh gh api /repos/github/gh-aw --jq .visibility (http block)
  • https://github.com/api/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:

- 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>
Copilot AI changed the title [WIP] Normalize report formatting for non-compliant workflows fix(pdf-summary): normalize report formatting to match style guidelines Apr 7, 2026
Copilot AI requested a review from pelikhan April 7, 2026 03:27
@pelikhan pelikhan marked this pull request as ready for review April 7, 2026 03:27
Copilot AI review requested due to automatic review settings April 7, 2026 03:27
@pelikhan pelikhan merged commit 0f82974 into main Apr 7, 2026
50 of 51 checks passed
@pelikhan pelikhan deleted the copilot/normalize-report-formatting branch April 7, 2026 03:28
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 pdf-summary workflow’s generated report formatting to match the repository’s reporting conventions (header hierarchy + progressive disclosure).

Changes:

  • Imports shared/reporting.md into the pdf-summary prompt.
  • Updates the response template to use ###/#### headers and wraps verbose sections in <details> blocks.
  • Regenerates .github/workflows/pdf-summary.lock.yml to 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.
Copy link

Copilot AI Apr 7, 2026

Choose a reason for hiding this comment

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

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.”).

Suggested change
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.

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