Skip to content

Adjust breaking change workflow based on issues seen#126607

Open
ericstj wants to merge 1 commit intodotnet:mainfrom
ericstj:refineBreakingChangeWorkflow
Open

Adjust breaking change workflow based on issues seen#126607
ericstj wants to merge 1 commit intodotnet:mainfrom
ericstj:refineBreakingChangeWorkflow

Conversation

@ericstj
Copy link
Copy Markdown
Member

@ericstj ericstj commented Apr 7, 2026

  1. Agent is sometimes ignoring the result of the version calculation script - make it more clear how to handle results.
  2. Comment was duplicating issue body. Remove this.
  3. Tag the PR's assignees to get attention.

1. Agent is sometimes ignoring the result of the version calculation script - make it more clear how to handle results.
2. Comment was duplicating issue body.  Remove this.
3. Tag the PR's assignees to get attention.
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

Updates the breaking-change-doc skill workflow instructions and helper script to reduce version-detection ambiguity, avoid duplicating the full issue draft in PR comments, and notify PR assignees via @mentions.

Changes:

  • Expanded Step 1 metadata collection to include PR assignees and clarified Step 2 version-script handling/logging.
  • Updated the PR comment generation workflow to pass assignees for @-mentions and to keep PR comments brief (no inline issue body).
  • Enhanced Build-IssueComment.ps1 to accept an -Assignees parameter and emit URL-length diagnostics.

Reviewed changes

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

File Description
.github/skills/breaking-change-doc/SKILL.md Clarifies workflow steps (version detection output handling, assignee metadata, brief PR comment intent).
.github/skills/breaking-change-doc/Build-IssueComment.ps1 Generates a shorter PR comment and supports notifying PR assignees via a new -Assignees parameter.

Comment on lines +54 to +55
if ($Assignees.Trim()) {
$mentionLine = "`n`n/cc $($Assignees.Trim())"
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.

$Assignees.Trim() will throw if the caller passes $null (PowerShell parameters can be explicitly set to null). Consider using [string]::IsNullOrWhiteSpace($Assignees) (and trimming once) so the script is robust when there are no PR assignees or the metadata value is missing.

Suggested change
if ($Assignees.Trim()) {
$mentionLine = "`n`n/cc $($Assignees.Trim())"
$trimmedAssignees = ""
if (-not [string]::IsNullOrWhiteSpace($Assignees)) {
$trimmedAssignees = $Assignees.Trim()
$mentionLine = "`n`n/cc $trimmedAssignees"

Copilot uses AI. Check for mistakes.

If the script returns an error, fall back to reading the PR's base branch and recent
tags manually to estimate the version.
Use `EstimatedVersion` as the version for the breaking change issue.
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.

Step 2 has conflicting guidance: it says to fall back to manual tag detection when the JSON contains an Error field, but then unconditionally says to use EstimatedVersion anyway. That unconditional line can cause the workflow to ignore the error case; consider removing it or rewording it to apply only when Error is absent.

Suggested change
Use `EstimatedVersion` as the version for the breaking change issue.
Only use `EstimatedVersion` as the version for the breaking change issue when
the JSON does **not** contain an `Error` field.

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

area-skills Agent Skills

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants