Show the API-spec diff summary inline in the PR comment#51
Merged
Conversation
Keep the oasdiff.com upload (review: true) for the side-by-side review, but suppress the action's standalone link-only comment (github-token: "") and instead post a single sticky comment that carries the changelog inline in a collapsed <details> plus the review link (from the review_url output). Codecov-style: the diff summary is visible on the PR without leaving GitHub, and the full side-by-side review is one click away.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #51 +/- ##
==========================================
Coverage 72.99% 72.99%
Complexity 232 232
==========================================
Files 29 29
Lines 648 648
==========================================
Hits 473 473
Misses 175 175
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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
2 participants
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.
Supersedes #50. Instead of disabling the oasdiff.com upload, keep it — but stop making reviewers click through to see the diff.
Changes
review: true(upload +review_urloutput) and setgithub-token: ""to suppress the action's own standalone link-only comment.<details>and appends a🔍 View the full side-by-side reviewlink (fromsteps.{breaking,changelog}.outputs.review_url).Net result per PR (Codecov-style, one comment):
API changessummary + review link.review_urlwhen there's nothing to review).Why
oasdiff-actionv0.1.5 (#49) posts a link-only comment by default, so the actual diff lived only on oasdiff.com. This keeps the hosted side-by-side review available but surfaces the summary directly on the PR, so you don't have to leave GitHub for the common case. The upload behaviour is unchanged (the spec is public); only where the diff is shown changes.Note: the API-spec workflow is path-filtered to spec-affecting paths, so the new comment first renders on the next PR that changes
src/config/spec(e.g. #46 once it picks this up).