Repository navigation
Post the changes in the PR comment, and say why one didn't post - #214
Merged
Merged
Conversation
The free review comment was a bare link: a reviewer had to open it to find out what changed, having already read the same changes in the inline annotations. It now lists the changes, severity, check id and endpoint, up to five rows and a count of the rest, so the comment answers the question on the pull request. The data comes from a json render that replaces the exit-code probe the has-changes decision used, so the comment and the count read the same comparison and the number of oasdiff runs is unchanged. A comment that could not be posted reported the same way whether the job was missing pull-requests: write or the pull request came from a fork, where GitHub makes the token read-only and no permission helps. The two are now separate: the first is a warning naming the permission to add, the second a plain line, and they are distinguished in the delivery mode the action reports. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Both Pro jobs signalled "there are changes" by exiting 1 on the --fail-on probe, which the json render replaced, so the Pro branch never ran. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Severest first, so the five rows that stay open are the ones that decide whether the pull request can merge rather than the first five the comparison happened to produce. The remainder collapses into a details block, up to fifty rows, so a reviewer gets every change without leaving the pull request and the comment stays short. Beyond fifty, the count goes in a line and the review carries the rest. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Contributor
Author
|
Reshaped the comment after comparing it with the free Codecov comment, which solves the same problem: verdict first, a table of the rows that need attention, the bulk collapsed, the full report one link away. Two changes from that reading:
Rendered at 1, 3, 8, 51 and 60 changes; the three test jobs now pin the open-row count, the collapsed block and the severity order. |
The free comment lists the changes and the Pro comment did not, so the paid surface showed less than the free one. The Pro comment now carries the same count, table and link, with the gate state above them, which is the part only Pro has. Its test asserts the body rather than only the log line. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This was referenced Nov 15, 2026
Five rows reading new-optional-request-property on the same endpoint told a reviewer nothing about which property was added. Each row now carries the change's own sentence, which names the property, followed by the check id linked to its catalog page, the shape the Pro review comment already uses. A pipe in the text is escaped so it cannot break the table. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Property names and paths come from the spec, which the author of a pull request controls. A name containing a backtick closed the code span the change text opens, so the rest of it rendered as markdown: a mention, a link or HTML, posted under the action's name. Every character markdown reads is now written as an entity, which GitHub prints literally, and the endpoint cell uses a code element instead of a backtick span. Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Two changes to what the
breakingandchangelogactions put on a pull request.The comment lists the changes
It used to be a link and nothing else, so a reviewer had to open it to learn what changed, after the inline annotations had already told them. Now:
Five rows at most, then a count of the rest: a changelog can run to thousands of changes and a GitHub comment is capped at 65,536 characters.
The rows come from a
--format jsonrender that replaces the--fail-onexit-code probe the has-changes decision used. So the count in the heading and the rows under it read the same comparison, the decision stays format-proof (the probe existed because the default render follows anyformatin.oasdiff.yaml), and the number of oasdiff runs per job is unchanged. The render goes to a file rather than a variable, since a large changelog on a command line hits ARG_MAX, which is the regression #118 and #119 fixed elsewhere in this file.A comment that doesn't post says what to change
Both causes read the same before: a job without
pull-requests: write, and a pull request from a fork, where GitHub makesGITHUB_TOKENread-only and no permission helps. Only the first is actionable, so they are now reported differently:The fork case is a plain line, not a warning, because nothing is misconfigured. The delivery mode the action reports separates them too (
comment_forkagainstcomment_failed), so a run that could have posted and a run that never could are no longer counted together.Tests
Three jobs, stubbing
oasdiffandcurlto assert on the exact comment body the action would post: the rows and the cap onbreaking, the same onchangelogso the two entrypoints cannot drift, and the fork-against-permission split with its two delivery modes. Verified locally against the real oasdiff binary as well as the stubs;shellcheck -s shandactionlintclean.🤖 Generated with Claude Code