-
Notifications
You must be signed in to change notification settings - Fork 1.9k
ai-summary-comment: Simplify PR finalize to two collapsible sections #33771
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
ai-summary-comment: Simplify PR finalize to two collapsible sections #33771
Conversation
📋 PR Finalization ReviewTitle: ✅ GoodCurrent: Description: ✅ ExcellentThe description is comprehensive and accurately reflects the implementation: ✅ Before/After comparison clearly explains the structural change
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR refactors the PR finalization comment system to simplify the format and logic. Previously, the script maintained multiple numbered reviews (Review 1, Review 2, etc.) by merging new reviews with existing content. Now it produces a single comment with two collapsible sections (Title and Description) that always replaces the entire comment on updates.
Changes:
- Removed
ReviewNumberandReviewDescriptionparameters and related aggregation logic - Changed from accumulating multiple review sections to always replacing the entire comment
- Restructured comment format with two top-level collapsible sections (Title and Description) instead of per-review collapsibles
- Updated title status auto-detection to look for explicit "Status:" field in Title Assessment section with fallback to recommended title check
- Increased GitHub API comment fetch limit from default (30) to 100 per page
- Simplified examples and documentation to reflect new parameter set
.github/skills/ai-summary-comment/scripts/post-pr-finalize-comment.ps1
Outdated
Show resolved
Hide resolved
41bcc0a to
71a9485
Compare
71a9485 to
1ef5cfd
Compare
Refactor PR finalize comment format and logic Restructure post-pr-finalize-comment.ps1 to produce a single PR finalize comment composed of two collapsible sections (Title and Description) instead of per-review collapsibles. Remove legacy ReviewNumber and ReviewDescription parameters and associated aggregation logic; TitleStatus is now auto-detected from a dedicated Title Assessment section fallback. Always replace the existing finalize comment (instead of merging/adding reviews) and build separate title/description sections with updated formatting for issues and recommendations. Also update docs/examples, broaden GH API comment fetch to ?per_page=100, and simplify defaulting behavior. Add TitleIssues parameter to post-pr-finalize-comment.ps1 The script was missing a parameter to pass title issues directly when using manual parameters (instead of loading from SummaryFile). This caused errors when trying to specify title issues without a summary file. - Add TitleIssues parameter documentation - Add TitleIssues to param block - Initialize $titleIssues from parameter when not loading from SummaryFile
1ef5cfd to
5ae55f6
Compare
Review FeedbackThe script changes look good and work correctly! I tested with Suggestion: Update SKILL.mdLines 59-62 of
Since this PR changes the behavior to always replace the comment with a single Title + Description structure, consider updating that section to reflect the new behavior, e.g.:
This could be done in this PR or as a follow-up. |
…otnet#33771) <!-- Please let the below note in for people that find this PR --> > [!NOTE] > Are you waiting for the changes in this PR to be merged? > It would be very helpful if you could [test the resulting artifacts](https://github.com/dotnet/maui/wiki/Testing-PR-Builds) from this PR and let us know in a comment if this change resolves your issue. Thank you! ### Description of Change Refactors `post-pr-finalize-comment.ps1` to produce a cleaner, more readable PR finalization comment format: **Before:** Single collapsible section per review with merged Title/Description content **After:** Two separate collapsible sections (Title and Description) for better scannability #### Changes: - Replace per-review collapsible sections with dedicated Title and Description sections - Remove legacy `ReviewNumber` and `ReviewDescription` parameters (no longer needed) - Add `TitleIssues` parameter for direct title issue specification - Auto-detect `TitleStatus` from "Title Assessment" section in summary files - Always replace existing finalize comment instead of merging reviews - Broaden GitHub API comment fetch to `?per_page=100` to handle PRs with many comments - Simplify status defaulting logic ### Issues Fixed N/A - Internal tooling improvement
Note
Are you waiting for the changes in this PR to be merged?
It would be very helpful if you could test the resulting artifacts from this PR and let us know in a comment if this change resolves your issue. Thank you!
Description of Change
Refactors
post-pr-finalize-comment.ps1to produce a cleaner, more readable PR finalization comment format:Before: Single collapsible section per review with merged Title/Description content
After: Two separate collapsible sections (Title and Description) for better scannability
Changes:
ReviewNumberandReviewDescriptionparameters (no longer needed)TitleIssuesparameter for direct title issue specificationTitleStatusfrom "Title Assessment" section in summary files?per_page=100to handle PRs with many commentsIssues Fixed
N/A - Internal tooling improvement