Post summary comment before inline findings (v0.5.3) - #18
Merged
Conversation
User feedback after the v0.5.2 suggestion e2e test: bugbot's summary comment (the "TL;DR: what this PR does, N findings") was posted LAST, after every inline comment. Each inline comment auto-creates its own "reviewed" event on GitHub, so the PR timeline showed detailed line-by-line findings first and the overview at the very bottom — backwards from how a reader wants to scan a review. format_summary_body() doesn't depend on posted_inline/posted_summary, so reordering is safe — just moved the summary-post block above the inline loop. post_check_run() still runs last (unaffected either way, since it's GitHub Checks API, not a PR comment). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Claude Sonnet 5 · reviewPure reorder: the summary comment block was moved to post before the inline-findings loop instead of after, with no logic changes — format_summary_body() doesn't read posted_inline/posted_summary, and summary_body is still correctly available later for post_check_run. Version bump in Cargo.toml/Cargo.lock is consistent. No findings. — Claude Sonnet 5 · 234.4k tokens |
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
1 participant
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.
Summary
User feedback: the summary comment (overview + findings table) posted LAST in the PR timeline, after all inline findings, since each inline comment auto-creates its own "reviewed" event on GitHub. A reader scanning the PR saw line-by-line detail before the TL;DR overview — backwards.
Reordered
post()to post the summary first, then inline findings.format_summary_body()doesn't depend onposted_inline/posted_summary, so this is a pure reorder with no behavior change beyond timeline position.Test plan
Co-Authored-By: Claude Opus 4.8 (1M context) noreply@anthropic.com
Note
Low Risk
Pure reorder of existing API calls with no change to comment content, caps, or idempotency; only PR timeline UX improves.
Overview
Reorders PR comment posting so the overview summary appears before inline findings in the activity timeline (GitHub was showing line-by-line comments first because each inline post creates its own review event).
In
Reviewer::post(),post_summary_commentnow runs immediately after idempotency checks, then the existing inline-comment loop unchanged.format_summary_bodyand check-run posting are unaffected aside from timeline order. Version bumped to 0.5.3 inCargo.toml/Cargo.lock.Reviewed by Cursor Bugbot for commit d35fcf3. Configure here.