Normalize report formatting for breaking-change-checker workflow

[Claude]

The breaking-change-checker workflow generates daily reports but lacks standardized formatting guidelines, resulting in inconsistent structure and poor readability for long reports with verbose diffs.

Changes

• Import shared reporting guidelines: Added shared/reporting.md to workflow frontmatter to align with other reporting workflows (audit-workflows, daily-repo-chronicle)

• Added Report Formatting Guidelines section: Instructs the agent to:

  • Use h3 (###) or lower headers to maintain document hierarchy
  • Wrap detailed analysis in <details> tags for progressive disclosure
  • Structure reports with visible summary/critical items and collapsible verbose content

• Restructured issue template to follow progressive disclosure pattern:

  ### Summary
  [Key metrics always visible]
  
  ### Critical Breaking Changes
  [Important changes always visible]
  
  <details>
  <summary><b>Full Code Diff Analysis</b></summary>
  [Detailed commit analysis and patterns]
  </details>
  
  <details>
  <summary><b>All Commits Analyzed</b></summary>
  [Complete commit list]
  </details>
  
  ### Recommendations
  [Action items always visible]

This brings the workflow in line with repository-wide reporting standards where most important information is immediately visible while verbose details remain accessible but collapsed.

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 --64 -o 7635176/b230/_x0GOPROXY -W -I /tmp/go-build162GOWORK 64/bin/go . --gdwarf2 --64 as (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 ions =0 p=/tmp/go-build1GOPROXY swit�� -I 7635176/b230/ 64/bin/go . ctor p=/opt/hostedtoolcache/go/1.25.0-json lRn-rAdcLWTK7g79NF (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 ut-3444194834.c -I 7635176/b230/_x0GOPROXY -w -Wno-error -o/tmp/go-build1GOWORK 64/bin/go -c -I /tmp/go-build1627635176/b125/ /usr/libexec/gcc/x86_64-linux-gnGO111MODULE (http block)
• https://api.github.com/repos/actions/checkout/git/ref/tags/11bd71901bbe5b1630ceea73d27597364c9af683
  • Triggering command: /usr/bin/gh gh api /repos/actions/checkout/git/ref/tags/11bd71901bbe5b1630ceea73d27597364c9af683 --jq .object.sha /tmp/go-build162remote.origin.url -trimpath $name) { hasDiscussionsEnabled } } -p main -lang=go1.25 go env -json GO111MODULE 64/bin/go GOINSECURE GOMOD GOMODCACHE go (http block)
  • Triggering command: /usr/bin/gh gh api /repos/actions/checkout/git/ref/tags/11bd71901bbe5b1630ceea73d27597364c9af683 --jq .object.sha -json GO111MODULE ache/go/1.25.0/x64/bin/go GOINSECURE GOMOD GOMODCACHE go env -json GO111MODULE ache/go/1.25.0/x64/bin/go GOINSECURE GOMOD GOMODCACHE go (http block)
• https://api.github.com/repos/actions/download-artifact/git/ref/tags/v6
  • Triggering command: /usr/bin/gh gh api /repos/actions/download-artifact/git/ref/tags/v6 --jq .object.sha g/parser/import_GOINSECURE g/parser/import_GOMOD 64/bin/go --gdwarf-5 --64 -o ache/go/1.25.0/xHEAD -W 7635176/b389/_pkGOSUMDB /tmp/go-build162GOWORK 64/bin/go . --gdwarf2 --64 as (http block)
  • Triggering command: /usr/bin/gh gh api /repos/actions/download-artifact/git/ref/tags/v6 --jq .object.sha -json GO111MODULE 64/bin/go GOINSECURE GOMOD GOMODCACHE go env -json or a null string otherwise { printf "%s%s", r: $owner, name: $name) { hasDiscussionsEnabled } } GOINSECURE GOMOD GOMODCACHE go (http block)
  • Triggering command: /usr/bin/gh gh api /repos/actions/download-artifact/git/ref/tags/v6 --jq .object.sha -json GO111MODULE 0/x64/bin/git GOINSECURE GOMOD ]) exit(3); view go env -json GO111MODULE ache/go/1.25.0/x64/bin/go GOINSECURE GOMOD GOMODCACHE go (http block)
• https://api.github.com/repos/actions/github-script/git/ref/tags/v8
  • Triggering command: /usr/bin/gh gh api /repos/actions/github-script/git/ref/tags/v8 --jq .object.sha get --local (http block)
  • Triggering command: /usr/bin/gh gh api /repos/actions/github-script/git/ref/tags/v8 --jq .object.sha ache/go/1.25.0/xGOINSECURE -I 64/bin/go --gdwarf-5 --64 -o 7635176/b230/_x0GOPROXY -W -I /tmp/go-build162GOWORK 64/bin/go . --gdwarf2 --64 as (http block)
  • Triggering command: /usr/bin/gh gh api /repos/actions/github-script/git/ref/tags/v8 --jq .object.sha ache/go/1.25.0/xGOINSECURE -I 64/bin/go --gdwarf-5 --64 -o 7635176/b230/_x0GOPROXY -qui�� -I /tmp/go-build162GOWORK 64/bin/go . -imultiarch x86_64-linux-gnu gcc (http block)
• https://api.github.com/repos/actions/setup-go/git/ref/tags/3041bf56c941b39c61721a86cd11f3bb1338122a
  • Triggering command: /usr/bin/gh gh api /repos/actions/setup-go/git/ref/tags/3041bf56c941b39c61721a86cd11f3bb1338122a --jq .object.sha -json GO111MODULE r: $owner, name: $name) { hasDiscussionsEnabled } } GOINSECURE GOMOD GOMODCACHE go env -json GO111MODULE ache/go/1.25.0/x64/bin/go GOINSECURE GOMOD GOMODCACHE go (http block)
• https://api.github.com/repos/actions/upload-artifact/git/ref/tags/v6
  • Triggering command: /usr/bin/gh gh api /repos/actions/upload-artifact/git/ref/tags/v6 --jq .object.sha o_main.o -I 64/bin/go --gdwarf-5 ions =0 /x86_64-linux-gnGO111MODULE swit�� -I ache/go/1.25.0/xGOMOD 64/bin/go 7635176/b230/ 7635176/b125/_x0-d (http block)
  • Triggering command: /usr/bin/gh gh api /repos/actions/upload-artifact/git/ref/tags/v6 --jq .object.sha /x86_64-linux-gnGOINSECURE /libexec/gcc/x86GOMOD 64/bin/go s#^versions/##; s#^v#node/v#; \#system# !d; s-through=-lgcc_-c s-through=-lpthrecho "��� All validations passed" s-through=-lc s-th�� ache/go/1.25.0/xGOSUMDB /tmp/go-build162GOWORK 64/bin/go . -imultiarch (http block)
  • Triggering command: /usr/bin/gh gh api /repos/actions/upload-artifact/git/ref/tags/v6 --jq .object.sha -I 7635176/b230/ 64/bin/go /tmp/go-build162git -imultiarch (http block)
• https://api.github.com/repos/github/gh-aw/git/ref/tags/623e612ff6a684e9a8634449508bdda21e2c178c
  • Triggering command: /usr/bin/gh gh api /repos/github/gh-aw/git/ref/tags/623e612ff6a684e9a8634449508bdda21e2c178c --jq .object.sha s-through=-lgcc_s /tmp/go-build1627635176/b125/ 64/bin/go . --gdwarf2 (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 -I /tmp/go-build1627635176/b230/ 64/bin/go . --gdwarf2 --64 as -I /opt/hostedtoolcache/go/1.25.0/xGOSUMDB -I 64/bin/go --gdwarf-5 --64 -o go (http block)
• https://api.github.com/user
  • Triggering command: /usr/bin/gh gh api user --jq .login get --local /usr/local/.ghcup/bin/git credential.usernbase64 (http block)
  • Triggering command: /usr/bin/gh gh api user --jq .login ache/go/1.25.0/xGOINSECURE -I 64/bin/go --gdwarf-5 ions =0 p=/tmp/go-build1GO111MODULE swit�� ache/go/1.25.0/xGOINSECURE 7635176/b125/ 64/bin/go -ldflags="-O2" "base64 ctor p=/opt/hostedtooGOPATH 7635176/b230/_x0GOPROXY (http block)
  • Triggering command: /usr/bin/gh gh api user --jq .login .json..." -I 64/bin/go --gdwarf-5 --64 -o as -W iC3J/xDqqOLLMDFPGOSUMDB /tmp/go-build162GOWORK 64/bin/go . --gdwarf2 --64 7635176/b397/importcfg (http block)

If you need me to access, download, or install something from one of these locations, you can either:

• Configure Actions setup steps to set up my environment, which run before the firewall is enabled
• Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

Original prompt

---

This section details on the original issue you should resolve

<issue_title>[workflow-style] Normalize report formatting for breaking-change-checker</issue_title>
<issue_description>### Workflow to Update

Workflow File: .github/workflows/breaking-change-checker.md
Issue: This workflow generates daily reports but doesn't include markdown style guidelines for consistent, user-friendly formatting.

Required Changes

Update the workflow prompt to include these formatting guidelines:

1. Header Levels

Add instruction: "Use h3 (###) or lower for all headers in your issue report to maintain proper document hierarchy."

Example:

### Breaking Changes Detected
#### API Changes

2. Progressive Disclosure

Add instruction: "Wrap detailed analysis in <details><summary><b>Section Name</b></summary> tags to improve readability and reduce scrolling."

Example:

<details>
<summary><b>Full Code Diff Analysis</b></summary>

[Detailed diff and analysis here...]

</details>

3. Report Structure

Suggest a structure like:

• Summary (always visible): Count of breaking changes, severity assessment
• Critical Breaking Changes (always visible): List of changes requiring immediate attention
• Detailed Analysis (in <details> tags): Full diff analysis, code examples
• Recommendations (always visible): Migration steps, version bump guidance

Design Principles (Airbnb-Inspired)

The updated workflow should create reports that:

1. Build trust through clarity: Most important breaking changes immediately visible
2. Exceed expectations: Add helpful context like impact assessment, migration examples
3. Create delight: Use progressive disclosure to reduce overwhelm from long diffs
4. Maintain consistency: Follow the same patterns as other reporting workflows

Example Reference

See workflows like daily-repo-chronicle or audit-workflows that import shared/reporting.md for good examples of structured reporting.

Agent Task

1. Update .github/workflows/breaking-change-checker.md to include an import: - shared/reporting.md in the frontmatter imports section
2. Reference the style guidelines in the workflow instructions
3. Test the updated workflow to ensure it produces well-formatted reports

AI generated by Workflow Normalizer

• expires on Feb 11, 2026, 3:23 AM UTC

Comments on the Issue (you are @claude[agent] in this section)

• Fixes [workflow-style] Normalize report formatting for breaking-change-checker #13639

[Copilot]

Pull request overview

Normalizes the breaking-change-checker workflow’s generated issue/report formatting to match repo-wide reporting standards and improve readability for long/verbose analyses.

Changes:

• Import shared/reporting.md via workflow frontmatter to apply shared reporting conventions.
• Add an explicit “Report Formatting Guidelines” section (header level + <details> progressive disclosure + recommended structure).
• Restructure the “Breaking Changes Found” issue body template to keep Summary/Critical items visible while collapsing verbose sections.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File	Description
.github/workflows/breaking-change-checker.md	Adds shared reporting import and updates instructions + issue template to follow progressive disclosure and h3+ headers.
.github/workflows/breaking-change-checker.lock.yml	Regenerates the compiled workflow to include the new import and embedded reporting guidelines in the generated prompt.

---

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